templategroup.get

Apraksts

integer/array templategroup.get(object parameters)

Metode ļauj izgūt veidņu grupas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
graphids ID/array Atgriezt tikai veidņu grupas, kurās ir veidnes ar norādītajiem grafikiem.
groupids ID/array Atgriezt tikai veidņu grupas ar norādītajiem veidņu grupu ID.
templateids ID/array Atgriezt tikai veidņu grupas, kurās ir norādītās veidnes.
triggerids ID/array Atgriezt tikai veidņu grupas, kurās ir veidnes ar norādītajiem trigeriem.
with_graphs boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar grafikiem.
with_graph_prototypes boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar grafiku prototipiem.
with_httptests boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar tīmekļa pārbaudēm.
with_items boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar vienumiem.

Aizstāj parametrus with_simple_graph_items.
with_item_prototypes boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar vienumu prototipiem.

Aizstāj parametru with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar vienumu prototipiem, kuri ir iespējoti izveidei un kuriem ir skaitlisks informācijas tips.
with_simple_graph_items boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar skaitliskiem vienumiem.
with_templates boolean Atgriezt tikai veidņu grupas, kurās ir veidnes.
with_triggers boolean Atgriezt tikai veidņu grupas, kurās ir veidnes ar trigeriem.
selectTemplates query Atgriezt templates īpašību ar veidnēm, kas pieder veidņu grupai.

Atbalsta count.
limitSelects integer Ierobežo apakšatlases vaicājumos atgriezto ierakstu skaitu.

Attiecas uz šādām apakšatlasēm:
selectTemplates - rezultāti tiks kārtoti pēc template.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: groupid, name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Datu izgūšana pēc nosaukuma

Izgūstiet visus datus par divām veidņu grupām ar nosaukumiem "Templates/Databases" un "Templates/Modules".

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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