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": false, "include": "name,description", "exclude": "_id,description", "in": "irure aliqua adipisicing do", "not-in": "velit minim aliqua magna labore", "equals": "labore ut", "contains": "ut magna", "starts-with": "veniam ullamco", "ends-with": "fugiat et" } }
{ "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": "39B0fa0DCb9fcfca6cA64919", "namespace": { "type": "project", "name": "ut exercitation consequat", "accessControl": { "read": [ "ullamco laboris fugiat in", "qui nostrud", "Duis sit commodo", "laborum", "adipisicing" ], "write": [ "qui do in" ], "execute": [ "cupidatat do sunt dolore", "voluptate", "in eu in elit dolore", "sunt cupidatat", "nisi laboris ut" ], "manage": [ "labore" ] } }, "createdBy": "bCa1D48BcDCe2AEDEdedAdCb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8BC13cb29d6c8984fE2F056B", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F2485cDb002ccC2F9BF99395", "name": "ut dolore ullamco" }, { "_id": "A9EBbD2CfE7a4DA68Ee0b11c", "name": "ea 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": "8fEb57f7E3e7E5dFFc71FE4f", "namespace": { "type": "project", "name": "eu aute nostrud cillum qui", "accessControl": { "read": [ "ea amet cillum fugiat", "cillum amet elit", "ipsum quis", "proident pariatur ipsum ut" ], "write": [ "ex sunt", "nostrud dolor tempor sint", "officia non in labore amet", "esse", "adipisicing nostrud in dolore" ], "execute": [ "quis exercitation in" ], "manage": [ "pariatur in", "Duis enim exercitation minim" ] } }, "createdBy": "41Dc4bBC4CfAf83bfACeD3b1", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "2947d6d3E7FA5cCD3dfCdB0F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "aA1CC8CCafBb25BA556AAa5A", "name": "velit est in" }, { "_id": "46Ece7B9e219357B8cbC0cf9", "name": "sunt et fugiat amet minim" }, { "_id": "CF01e03a76ae02c609deaDef", "name": "Lorem" } ] }, { "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": "Dbd641B1B086Af30BC102557", "namespace": { "type": "project", "name": "consectetur eiusmod", "accessControl": { "read": [ "nulla Excepteur nisi et in", "magna eiusmod aliqua dolor adipisicing", "quis ad cupidatat occaecat" ], "write": [ "aliqua voluptate veniam" ], "execute": [ "est non consectetur sint", "enim", "cillum dolore culpa reprehenderit", "aute", "laborum ullamco" ], "manage": [ "veniam", "Excepteur irure dolor laborum ut", "Excepteur velit", "laboris proident" ] } }, "createdBy": "9DBC451EBaa6d7b0a3a0b5CB", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8ddC7bE1bA5fBCE599038EEe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9B45a8bF15dF62E29Ab93B59", "name": "Excepteur ea sit tempor" }, { "_id": "835cc71a3bC3Ed8c8Acb74Ea", "name": "proident id qui" }, { "_id": "2e78aaBCFaC63Aaa96222cCC", "name": "laborum" }, { "_id": "798d54C4b54EDA154C77ceC8", "name": "voluptate tempor quis" } ] } ], "total": -13791423, "start": 22270865, "end": 50030391, "count": -28437394, "next": "incididunt", "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" } ] } } }