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": "name,description", "exclude": "_id", "in": "Duis nostrud", "not-in": "aliqua id quis incididunt", "equals": "dolore nisi exercitation", "contains": "aute", "starts-with": "esse nisi eiusmod cupidatat", "ends-with": "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": "e5dF5F38E3876aDA3acDDC0f", "namespace": { "type": "project", "name": "occaecat", "accessControl": { "read": [ "mollit", "dolor adipisicing", "proident tempor", "incididunt aute" ], "write": [ "veniam minim", "sunt irure ipsum in nostrud" ], "execute": [ "fugiat aliquip" ], "manage": [ "occaecat", "officia in consectetur", "sunt mollit occaecat dolore" ] } }, "createdBy": "dc2E5e7a2d31E002e162Bae2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E93ACD5Bf8EEeeBE37B02EE9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "dD9fF5d39bc3DaEB7ea84BA2", "name": "eu esse ut magna" }, { "_id": "DF51Dc02A8032AB0Fc976E31", "name": "eiusmod pariatur in cupidatat" }, { "_id": "cbE68B3eA8c6A5E4bA8ad7CC", "name": "officia" }, { "_id": "A5C87E5E0Fd78e671Faa25Bf", "name": "ut laboris pariatur" } ] }, { "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": "dAf5c0F8fdEe62c5e5cFb58e", "namespace": { "type": "project", "name": "consectetur culpa", "accessControl": { "read": [ "aliqua non irure voluptate" ], "write": [ "anim reprehenderit amet", "proident commodo id mollit", "ea pariatur", "anim" ], "execute": [ "nostrud", "dolor", "deserunt proident Ut incididunt", "exercitation do eu anim labore" ], "manage": [ "pariatur et cupidatat aliquip aute", "nulla dolore cillum" ] } }, "createdBy": "dB7b3eb4e75CE5F0180cf442", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CcABB071D704dcD54Fe2F46B", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "aE0ed3b8E4EB86e4B6CC5638", "name": "exercitation dolor laborum cillum" }, { "_id": "122AEA4DD54cfe3f2AcE43eF", "name": "proident" }, { "_id": "A8F31e9a57cc24C5ead206dB", "name": "veniam qui in ex in" }, { "_id": "eD9F99b6ED6AcBeA9E44568D", "name": "in elit amet proident enim" } ] }, { "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": "270c20b319657eBf9EDFAdda", "namespace": { "type": "project", "name": "cillum anim ex ut", "accessControl": { "read": [ "irure" ], "write": [ "officia", "in commodo irure nisi", "elit", "esse ut pariatur adipisicing" ], "execute": [ "voluptate", "fugiat do sunt", "eiusmod cillum", "ut" ], "manage": [ "nostrud elit dolor deserunt", "officia laborum" ] } }, "createdBy": "cFAF0ad5Eb6388A51ACAE3aF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "4A5c1aFA3BB85abEDAeE9828", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0B2cC5Ec0Ffb5CD508845242", "name": "esse amet" }, { "_id": "1f9eEF128BAFbFD9B2Ca010c", "name": "ea voluptate" }, { "_id": "bFC02aB67B73Bc36c1e5A37d", "name": "Lorem eiusmod incididunt minim officia" }, { "_id": "96D97ACc2d64BD8abbaf901c", "name": "qui commodo" }, { "_id": "721656d7bbd325cf50a88DfC", "name": "veniam" } ] }, { "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": "fA8CadCC748eAcCDaA476CAa", "namespace": { "type": "project", "name": "aliqua", "accessControl": { "read": [ "dolore irure ut magna", "commodo Ut eu est", "do aute incididunt aliquip irure" ], "write": [ "dolore velit in do sed", "occaecat", "nostrud sint voluptate ut", "voluptate id qui velit", "ad" ], "execute": [ "aliquip laboris est dolor", "dolore tempor occaecat non", "officia voluptate", "ullamco irure", "reprehenderit Excepteur dolore in" ], "manage": [ "aliqua commodo sit", "sit sed", "ullamco in fugiat aliquip" ] } }, "createdBy": "AEb6EF7f6dEA94C8a72b9BE2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "04158dABF6102f52473258df", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "ec87A0A4ff6d870119B93c1F", "name": "irure aliqua incididunt" } ] } ], "total": -9332767, "start": -16117489, "end": -40164415, "count": 2067891, "next": "nisi enim", "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" } ] } } }