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": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id", "in": "Excepteur ut pariatur amet", "not-in": "Ut aliqua exercitation", "equals": "in in", "contains": "dolore", "starts-with": "culpa dolor eu veniam nulla", "ends-with": "quis culpa Duis enim exercitation" } }
{ "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": "d7E7F1c8f5dDe5a6EB001c64", "namespace": { "type": "project", "name": "enim voluptate dolore dolor nulla", "accessControl": { "read": [ "Excepteur adipisicing et velit", "reprehenderit", "labore Ut ad ut", "nisi Lorem sit ad consequat" ], "write": [ "pariatur eiusmod sed esse culpa", "fugiat quis deserunt anim", "ipsum id pariatur tempor eiusmod" ], "execute": [ "proident quis anim qui", "sed cupidatat anim id sunt" ], "manage": [ "labore aute Excepteur eiusmod" ] } }, "createdBy": "27CD72Df4ace429C6cBc8F76", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "FD30E3e9aeCE788750c2Ead1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2BFc640DaC4cae76D399f585", "name": "ad" }, { "_id": "70c205Af98A7cA4ffc6f2BD7", "name": "in anim qui consequat" } ] }, { "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": "Ed65BEC98EDC1bf21BaA535D", "namespace": { "type": "project", "name": "eu", "accessControl": { "read": [ "veniam Lorem aliqua eiusmod", "sunt ut quis aliquip sed" ], "write": [ "adipisicing quis tempor veniam" ], "execute": [ "ipsum", "ut dolore enim veniam" ], "manage": [ "quis incididunt", "in amet nostrud eiusmod ex" ] } }, "createdBy": "2f0F868699Bcbbbb92F30B8E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "0bc94e0FaC45814FCDC755ac", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "fADE71aFEC8F533DEd77eF8C", "name": "laborum ut labore" }, { "_id": "Fe0dF91374a6B5a4bAFbAFa8", "name": "magna ea irure Duis" }, { "_id": "74Ecd3eAacCC0B75B02cc507", "name": "laboris veniam sit dolor" }, { "_id": "25C6CD7c3395ba6007eF27e3", "name": "id" }, { "_id": "0aD16FdF5DCba71BAeEBcF4A", "name": "proident nulla" } ] }, { "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": "8e321bDA696f53dBC667F3cF", "namespace": { "type": "project", "name": "adipisicing ad minim", "accessControl": { "read": [ "occaecat aliqua ea sed", "Excepteur labore irure" ], "write": [ "incididunt consequat non elit Lorem", "in cillum" ], "execute": [ "aliqua occaecat", "in minim proident nulla" ], "manage": [ "in Excepteur consectetur exercitation pariatur", "anim", "nulla sunt", "aute deserunt" ] } }, "createdBy": "AB1EB22f331a1BF4F43E58CE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "DBBf6eAD07Eff35755cBA158", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Fd34697BFE755dFBAaE2A518", "name": "Duis eu commodo cillum veniam" }, { "_id": "Caae28601ACf81BfEb0d7631", "name": "dolor eiusmod consectetur" } ] }, { "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": "7BccE9fCbb1e3eB5E2b4d5D7", "namespace": { "type": "project", "name": "mollit est sint amet", "accessControl": { "read": [ "velit ullamco dolor laboris", "esse", "veniam consequat non dolore", "dolor quis magna" ], "write": [ "velit cupidatat laboris sed", "ullamco pariatur aute do", "do incididunt", "amet veniam" ], "execute": [ "minim amet Excepteur", "fugiat deserunt ad adipisicing aute", "culpa qui magna" ], "manage": [ "do", "anim veniam elit enim sit" ] } }, "createdBy": "0F71fb49710Ecaf8CCd8F1ce", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c3506Efc9b0a9dEf3b8F1EEb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "AD0fF0Db61e913b5db5C44a0", "name": "commodo fugiat" }, { "_id": "4C84aA8c58a5406a374d23A4", "name": "dolore" }, { "_id": "41D9E50c5fE140c407810BBd", "name": "consectetur eu id" }, { "_id": "Cf0D2cc8Dd40D2fA7b08DF99", "name": "deserunt culpa dolor ipsum non" } ] }, { "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": "1FA40BECfdB7cEd5deB7Ab5B", "namespace": { "type": "project", "name": "qui Excepteur", "accessControl": { "read": [ "tempor laboris Excepteur esse cillum" ], "write": [ "anim" ], "execute": [ "enim Lorem nostrud qui", "qui tempor laboris in laborum", "eu nostrud Ut laborum", "adipisicing eiusmod non laboris", "eiusmod anim quis do sint" ], "manage": [ "ad non mollit Ut nisi", "labore", "voluptate minim ullamco reprehenderit Ut", "velit sunt", "magna officia nulla" ] } }, "createdBy": "6e4aCD02aFeee33deFFb9c2B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "4Effef07DCB7596EdeDBFa74", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d1a4FdBab07F3eCCeFB7243A", "name": "et esse magna amet Excepteur" }, { "_id": "58561528CCcDA8aaBccBff2F", "name": "exercitation" } ] } ], "total": 99981363, "start": 69569075, "end": -92202406, "count": 89896768, "next": null, "previous": "cillum aliqua ea" }
{ "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" } ] } } }