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": 1, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "qui esse aute Ut officia", "not-in": "non tempor ipsum fugiat", "equals": "aliquip dolore ut", "contains": "veniam Lorem in", "starts-with": "aliqua ipsum aute", "ends-with": "fugiat aute velit" } }
{ "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": "71df5e937baCf2Beb304A4c8", "namespace": { "type": "project", "name": "laboris sed consectetur et labore", "accessControl": { "read": [ "aute Lorem Duis", "magna Duis irure sint", "veniam", "est in quis", "incididunt dolor" ], "write": [ "labore magna", "pariatur", "ad in ullamco id" ], "execute": [ "nostrud", "tempor consectetur commodo", "ex velit" ], "manage": [ "cupidatat sed irure ut", "in", "nulla" ] } }, "createdBy": "DEFee53Aa1d0ABba4f8Fdb7D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "b0AD5045c8Ed52F8d4202690", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "47Ed89dfDB13DE5Becf1F99d", "name": "Lorem esse commodo dolor" }, { "_id": "Fe5CAa1209aE8AaebF89f5c2", "name": "dolore laborum" }, { "_id": "5cbA1c4aD8f0Cd2E9b1b48A7", "name": "tempor" }, { "_id": "c4bCaFCD2D35945aB2C7aAC5", "name": "ut laboris voluptate velit" }, { "_id": "0CDf5dfAaF7c6E211aa841EE", "name": "pariatur ad magna ullamco" } ] }, { "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": "aD0f998f7B5Afb5EF486CcD3", "namespace": { "type": "project", "name": "nulla consectetur dolor aliquip cupidatat", "accessControl": { "read": [ "eiusmod proident nulla consequat sit" ], "write": [ "adipisicing aliquip" ], "execute": [ "anim nulla ut officia fugiat", "cupidatat laborum nulla in", "labore" ], "manage": [ "voluptate mollit eu", "eu", "deserunt", "eiusmod enim" ] } }, "createdBy": "81ec0cAa7dfBAd14a9479E1e", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "d47A1aAdf2E7A9CB212CCa96", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "279ece95D512166aE1C5Ab55", "name": "magna ipsum esse nostrud" }, { "_id": "7EeD614cCf1EEBf9eC53896e", "name": "velit" }, { "_id": "6F2fDa55Fa32c49FDADDDB91", "name": "cupidatat" }, { "_id": "CB7A5bD9fFdCABFCAFf3cB5A", "name": "occaecat ut dolor deserunt sed" }, { "_id": "C2a4f19fba1EA95f6F91Bf70", "name": "pariatur adipisicing" } ] }, { "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": "Bc15Ddd9a6b7DE1bfAdE5E1c", "namespace": { "type": "project", "name": "do aliquip dolore", "accessControl": { "read": [ "Ut dolore ullamco", "amet cupidatat consectetur consequat", "elit ut fugiat" ], "write": [ "Duis laboris irure enim", "sunt" ], "execute": [ "reprehenderit laborum", "aliqua est non incididunt" ], "manage": [ "ullamco aliquip" ] } }, "createdBy": "D7DEc3c82d3fDE924d435c49", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5dEC95B9A8D17D294DB9e439", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "AAef3bd3034eECDCE18BB879", "name": "eu cillum do amet ea" }, { "_id": "E5D361FAC0880aD9a4cBD2C5", "name": "deserunt" }, { "_id": "E8127b797ddE7678DCf3Ff0C", "name": "dolore" } ] }, { "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": "0dF5Ae6cFE4DbAf3A6538FAB", "namespace": { "type": "project", "name": "fugiat est voluptate eiusmod pariatur", "accessControl": { "read": [ "cillum exercitation", "magna officia aliqua do", "ullamco sint in ipsum eiusmod" ], "write": [ "irure", "proident deserunt non commodo id", "ut minim", "aute occaecat Lorem reprehenderit", "nisi dolore officia incididunt dolore" ], "execute": [ "officia", "Ut labore", "exercitation", "labore anim in nulla", "deserunt veniam incididunt Duis" ], "manage": [ "culpa dolore" ] } }, "createdBy": "2704FD54cf6fDB47D62edf8B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "39Ba43CD4fDF4c5F6EFEFD92", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "5E533f22Abbd81c6b8F4F1a1", "name": "tempor sit ut labore dolore" }, { "_id": "cd612598f2fEcF6ccaCadaeb", "name": "ea ullamco deserunt nostrud" }, { "_id": "Fe1FCE4dd97661b9BbaEB241", "name": "ullamco exercitation cillum tempor 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": "C957db26Dea2Be650Dcf4799", "namespace": { "type": "project", "name": "labore enim veniam sint cupidatat", "accessControl": { "read": [ "eiusmod labore id ea Duis", "eiusmod", "irure", "amet nostrud laboris" ], "write": [ "et fugiat occaecat nulla eu", "id labore", "adipisicing deserunt", "veniam Lorem" ], "execute": [ "proident sed est", "dolor non", "est fugiat culpa" ], "manage": [ "deserunt enim", "enim in", "consequat voluptate", "reprehenderit" ] } }, "createdBy": "179aED0C3aDaeC6E317d2cAE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C3eb0D6A2fEdcF28FFA99aBf", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "084c3abFbD43Ef26C2d37BB0", "name": "ut incididunt culpa proident irure" }, { "_id": "11aB968Dfb3D7ac131A0E255", "name": "eiusmod" } ] } ], "total": 32415559, "start": 36263315, "end": -89327597, "count": 45739773, "next": "esse dolore non", "previous": "esse" }
{ "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" } ] } } }