templategroup.get

Опис

integer/array templategroup.get(object parameters)

Метод омогућава преузимање група шаблона према датим параметрима.

Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе може се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.

Параметри

(објекат) Параметри који дефинишу жељени излаз.

Метода подржава следеће параметре.

Параметар Тип Description
graphids ID/array Врати само групе шаблона које садрже шаблоне са датим графовима.
groupids ID/array Врати само групе шаблона са датим ID-овима група шаблона.
templateids ID/array Врати само групе шаблона које садрже дате шаблоне.
triggerids ID/array Врати само групе шаблона које садрже шаблоне са датим окидачима.
with_graphs flag Врати само групе шаблона које садрже шаблоне са графовима.
with_graph_prototypes flag Врати само групе шаблона које садрже шаблоне са прототиповима графова.
with_httptests flag Врати само групе шаблона које садрже шаблоне са веб проверама.
with_items flag Врати само групе шаблона које садрже шаблоне са ставкама.

Замењује параметре with_simple_graph_items.
with_item_prototypes flag Врати само групе шаблона које садрже шаблоне са прототиповима ставки.

Замењује параметар with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Врати само групе шаблона које садрже шаблоне са прототиповима ставки, који су омогућени за креирање и имају нумерички тип информација.
with_simple_graph_items flag Врати само групе шаблона које садрже шаблоне са нумеричким ставкама.
with_templates flag Врати само групе шаблона које садрже шаблоне.
with_triggers flag Врати само групе шаблона које садрже шаблоне са окидачима.
selectTemplates query Врати својство templates са шаблонима који припадају групи шаблона.

Подржава count.
limitSelects integer Ограничава број записа које враћају подизбори.

Односи се на следеће подизборе:
selectTemplates - резултати ће бити сортирани по template.
sortfield string/array Сортира резултат по датим својствима.

Могуће вредности: groupid, name.
countOutput boolean Ови параметри су описани у коментару референце.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање података по имену

Преузмите све податке о две групе шаблона под називом "Templates/Databases" и "Templates/Modules".

Захтев:

{
           "jsonrpc": "2.0",
           "method": "templategroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Templates/Databases",
                       "Templates/Modules"
                   ]
               }
           },
           "id": 1
       }

Одговор:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "13",
                   "name": "Templates/Databases",
                   "uuid": "748ad4d098d447d492bb935c907f652f"
               },
               {
                   "groupid": "8",
                   "name": "Templates/Modules",
                   "uuid": "57b7ae836ca64446ba2c296389c009b7"
               }
           ],
           "id": 1
       }

Погледајте такође

Извор

CTemplateGroup::get() у ui/include/classes/api/services/CTemplateGroup.php.