Summary
Gets a page of template documents.
Description
Gets a page of template documents.
Route
GET /automation-studio/templates
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | Parameters for filtering, paginating, projecting, and sorting template documents. |
{ "queryParameters": { "limit": 25, "skip": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": { "_id": "deserunt minim dolore", "name": "elit cupidatat ut irure ad", "group": "amet eiusmod", "command": "eiusmod ea nostrud", "description": "elit in nulla", "template": "minim Duis", "data": "do ut anim et", "type": "sint elit ea", "createdBy": "laborum dolore mollit", "created": "ex sunt aute", "lastModifiedBy": "commodo est aliquip tempor", "lastUpdated": "sint aliqua minim eiusmod" }, "not-in": { "_id": "consectetur esse in fugiat", "name": "aliquip Excepteur", "group": "elit proident incididunt nulla", "command": "dolor laborum do aliquip", "description": "eu cupidatat ullamco esse", "template": "anim commodo et dolor", "data": "est laborum reprehenderit cupidatat incididunt", "type": "occaecat Lorem et elit voluptate", "createdBy": "dolore", "created": "aute", "lastModifiedBy": "sed occaecat", "lastUpdated": "Ut" }, "equals": { "_id": "qui", "name": "dolore eu in", "group": "mollit qui esse", "command": "ad eiusmod nisi ex", "description": "nulla labore fugiat ex enim", "template": "dolore ea culpa cupidatat", "data": "et ex exercitation reprehenderit", "type": "cupidatat veniam labore", "createdBy": "esse nulla qui quis", "created": "aliqua ad dolore do enim", "lastModifiedBy": "quis", "lastUpdated": "officia" }, "contains": { "_id": "incididunt fugiat in nostrud", "name": "velit nostrud eiusmod nulla incididunt", "group": "deserunt Duis sint", "command": "labore voluptate proident", "description": "anim deserunt dolor proident laboris", "template": "aute", "data": "quis magna eu", "type": "commodo", "createdBy": "sed enim non", "created": "fugiat ut", "lastModifiedBy": "aliqua eiusmod dolore cupidatat sed", "lastUpdated": "sint nostrud irure ullamco" }, "starts-with": { "_id": "anim mollit", "name": "in enim", "group": "ut", "command": "incididunt sunt dolor Duis", "description": "tempor in proident occaecat", "template": "non", "data": "esse sit sed", "type": "proident", "createdBy": "id ut sint tempor", "created": "nostrud ea eiusmod sit dolore", "lastModifiedBy": "in", "lastUpdated": "amet" }, "ends-with": { "_id": "cillum sit", "name": "amet magna eu nulla deserunt", "group": "anim dolore", "command": "in eu dolore", "description": "commodo incididunt adipisicing", "template": "in non elit", "data": "aliqua mollit id sit", "type": "anim", "createdBy": "aliqua mollit irure", "created": "Ut dolore", "lastModifiedBy": "qui dolore velit eiusmod", "lastUpdated": "cupidatat magna pariatur in dolore" } } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "additionalProperties": true, "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "$ref": "template#/definitions/searchableFields" } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "46697b708899ec8f0BBAF2FB", "createdBy": "71cC2BBFa44dcbeaEda4026A", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "1E13B68aEF3E27AE89ce4CaD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "E9Ea6DFfD5Fb12454bFD316e", "createdBy": "1AC6AAeCCfE1bD64064cc356", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "850bddc56d5Bf206A61Caf2b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "AE7f71bADb3e719BC8d560E2", "createdBy": "a7fdbF2bCC32fC911eD9a0cd", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "DE2C0A5EC8fDA406AfAD195A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -70555871, "start": 87267769, "end": -50183283, "count": -79557629, "next": "officia sint sunt aute", "previous": "voluptate culpa minim ipsum Excepteur" }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "template" } }, "total": { "type": "integer", "description": "Total number of documents matching the given query parameters." }, "start": { "type": "integer", "description": "Search index of first document in the items array." }, "end": { "type": "integer", "description": "Search index of the last document in the items array." }, "count": { "type": "integer", "description": "Length of the items array." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }