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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "Ut", "not-in": "dolor cupidatat amet", "equals": "incididunt do", "contains": "sit mollit dolore cupidatat do", "starts-with": "adipisicing ut Ut enim dolor", "ends-with": "sint" } }
{ "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": "dF7CDcabB60A8c0C48bB84E2", "namespace": { "type": "project", "name": "ipsum ex qui quis sunt", "accessControl": { "read": [ "non in voluptate incididunt Duis", "aliquip adipisicing labore sed", "nostrud", "est adipisicing" ], "write": [ "in in occaecat", "minim", "nulla amet dolore", "sint", "mollit et ut commodo" ], "execute": [ "laboris", "in", "proident", "voluptate deserunt", "cupidatat non sunt minim" ], "manage": [ "et minim laboris commodo", "sunt sed", "sit reprehenderit qui nostrud" ] } }, "createdBy": "873b2d965f5AbF4C384BAd3F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c1fBdE4Dad44F349b5f5EDbD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0ceaDA0f153FD25f20C11134", "name": "dolor qui laborum labore aliquip" }, { "_id": "A613c16A19Ae28aabBe1dabC", "name": "proident incididunt" }, { "_id": "3dC7afb4EAEaf7ad5b9f8ec5", "name": "exercitation dolore voluptate nulla dolor" } ] }, { "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": "6C537B8dadDBa264F13eB8Fa", "namespace": { "type": "project", "name": "voluptate Ut", "accessControl": { "read": [ "enim", "nisi laborum", "nulla", "adipisicing aliqua mollit pariatur", "exercitation quis officia eu dolor" ], "write": [ "incididunt et", "est qui quis", "officia cupidatat in incididunt culpa" ], "execute": [ "adipisicing" ], "manage": [ "aliqua", "pariatur dolor qui", "Duis voluptate aliqua non officia", "in" ] } }, "createdBy": "E5aD4D0D0D5D4e3DE251a9A4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8BD714a76f2Eea53FEc6DA34", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2bFed5D5ad63Af7D1F8fae8E", "name": "veniam dolor" }, { "_id": "8CC7aafFc8B7E6F2FD2bB120", "name": "pariatur incididunt qui in" }, { "_id": "99AA269EDc36Dff8d7832BBC", "name": "nostrud ipsum non eu Duis" }, { "_id": "FD58F790BeF26ad502e68A5D", "name": "Duis reprehenderit qui eiusmod" }, { "_id": "Ae05ce4CB67bc4AF66D059C0", "name": "Excepteur Ut" } ] } ], "total": 11970630, "start": -48350546, "end": 25450073, "count": 63564520, "next": null, "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" } ] } } }