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": 50, "skip": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id,description", "in": "exercitation deserunt et est irure", "not-in": "esse", "equals": "ea pariatur cillum", "contains": "sed ad ea voluptate proident", "starts-with": "eu", "ends-with": "esse Excepteur ut" } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "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" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "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", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" } } } }, "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": "E8B19BE9493c89eD2432b866", "namespace": { "type": "project", "name": "ad deserunt dolore", "accessControl": { "read": [ "non" ], "write": [ "in nisi consectetur eiusmod dolore" ], "execute": [ "id eu irure" ], "manage": [ "in id sint", "culpa elit dolore irure" ] } }, "createdBy": "2E07210dbeddf73CAD16ff8C", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f2EfC129c8e0a8aa9151030e", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Eed7781bfe0DfffaD839a1aa", "name": "tempor officia" }, { "_id": "f53448833EDbeD42D71428b9", "name": "elit aliqua laboris magna deserunt" }, { "_id": "49a9AeB2Db79C8f6AD883dD3", "name": "ea et elit" }, { "_id": "00cFDA17c2CfA17fd218C386", "name": "Ut tempor culpa Excepteur" } ] }, { "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": "4984C6D2E33CcB1db3C04eE5", "namespace": { "type": "project", "name": "est Duis", "accessControl": { "read": [ "esse eiusmod" ], "write": [ "consequat", "in reprehenderit", "deserunt cillum ea quis", "consectetur ad nulla aute", "commodo aute quis sunt ad" ], "execute": [ "in", "in laborum est", "exercitation proident Duis culpa", "laborum Excepteur" ], "manage": [ "Excepteur occaecat dolor", "mollit deserunt consequat", "cupidatat", "dolore aliquip" ] } }, "createdBy": "A3726aCACBFD61FE88AeDfAD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "148fF68CB1fB5d24a37BAd19", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2F0ebf81aa34caaFCFCAfcE3", "name": "proident magna in ad" }, { "_id": "a3bAa90FaeFdF3C6a0Ad9ADd", "name": "aute pariatur est" }, { "_id": "dea564B3DA2fc6d2CC53cAc2", "name": "labore cupidatat" }, { "_id": "3bE1D631dEFe6be5b984Da9B", "name": "ut Duis fugiat" }, { "_id": "32a5278D550ec4fcEAfD5fCB", "name": "esse sit nisi" } ] }, { "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": "9c9C6eA27B38C243DE0012EF", "namespace": { "type": "project", "name": "officia dolore sed", "accessControl": { "read": [ "culpa adipisicing laboris velit magna", "consectetur", "in culpa", "eiusmod labore" ], "write": [ "et id", "cupidatat" ], "execute": [ "velit ut mollit nisi dolore" ], "manage": [ "aliquip consequat velit", "sunt dolor velit reprehenderit esse", "ad ut reprehenderit deserunt", "sit laboris qui in Lorem" ] } }, "createdBy": "51cAcB764009fF452BEC8060", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1BFbd0aAF7444198A84Ca01f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E08AC66a09779DeEe5e7f94b", "name": "in" }, { "_id": "6960Ce6cBeee16DE32E7C5aE", "name": "mollit consequat magna in" } ] }, { "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": "F6dAF4f4cE98b9A075a54d7f", "namespace": { "type": "project", "name": "elit", "accessControl": { "read": [ "minim aliquip ipsum fugiat", "laboris" ], "write": [ "reprehenderit occaecat mollit deserunt" ], "execute": [ "do officia dolor et" ], "manage": [ "laborum ipsum", "minim laboris in Ut", "id in", "elit", "consectetur qui in velit" ] } }, "createdBy": "B68bA8FBe8FCd7CBc3EEDbB6", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "bf57d698eAC0B03eCf451d79", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D7eb2fc2dcAADBd19Afb8AB7", "name": "velit eu" }, { "_id": "89e87CcBFD49De1b0CFaaAfE", "name": "eu" }, { "_id": "49C3CA3d72b46A5ab0ac4fCA", "name": "et Excepteur proident nulla labore" }, { "_id": "54f40C7c1fBb8aed4AbAB10a", "name": "ullamco aute velit" } ] } ], "total": -73369283, "start": 23330504, "end": 29702285, "count": -47005094, "next": "proident Lorem velit qui pariatur", "previous": null }
{ "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }