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": 10, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id,description", "in": "velit dolore sunt dolor quis", "not-in": "mollit eu ipsum sed amet", "equals": "dolor", "contains": "mollit sint pariatur non", "starts-with": "eiusmod ut ex esse aute", "ends-with": "in" } }
{ "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": "CAbDEe8f7326e4bF0afF7DE3", "namespace": { "type": "project", "name": "proident sed non officia", "accessControl": { "read": [ "Duis deserunt mollit adipisicing irure", "in", "fugiat dolor eiusmod in" ], "write": [ "id", "nostrud id ullamco proident", "tempor non consequat" ], "execute": [ "consectetur ipsum proident consequat aliquip", "incididunt nostrud do sunt", "nisi elit consectetur est" ], "manage": [ "qui laborum sint esse pariatur", "proident minim", "amet", "nisi adipisicing" ] } }, "createdBy": "2cF9eeC4AE8c5FC1F2E5EEea", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e12cDDBe5d054B0E9BBabA3B", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "EAE4Aea929F4dEEf0AacCd25", "name": "ex nisi ut consequat et" } ] }, { "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": "4ECe1c21ae8f9BBaabea5e1b", "namespace": { "type": "project", "name": "Lorem", "accessControl": { "read": [ "consectetur sunt dolor adipisicing", "elit", "reprehenderit incididunt in dolore ad" ], "write": [ "aliquip aute", "laborum sunt", "tempor" ], "execute": [ "sunt", "sunt laborum mollit ea", "commodo reprehenderit", "ullamco" ], "manage": [ "occaecat enim dolore culpa adipisicing", "mollit" ] } }, "createdBy": "BdfFdBd7CfE67bd2be60AD5b", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1e7e6B98F9917f2332B6A612", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0F45cd9bAc3656b71A98Ea1F", "name": "Ut Lorem nostrud" }, { "_id": "65ED274C1f8ef9Ba1c0deFE1", "name": "enim qui in Excepteur" }, { "_id": "6db1E9eA9afc37bB01DB5817", "name": "ipsum" }, { "_id": "6303b1e1e7D5585ab9E31d26", "name": "dolor cillum sint Duis sunt" } ] } ], "total": 47207394, "start": -4569103, "end": 67729857, "count": 8566359, "next": null, "previous": "tempor nisi ut nostrud" }
{ "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" } ] } } }