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": false, "include": "name,description", "exclude": "description", "in": "sint aliquip", "not-in": "minim ut exercitation", "equals": "laborum et Excepteur", "contains": "enim labore", "starts-with": "eu dolor", "ends-with": "consectetur commodo aliqua" } }
{ "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": "b5DcfE2D92775fC9aBE14D9C", "namespace": { "type": "project", "name": "Ut", "accessControl": { "read": [ "dolor irure nostrud laborum" ], "write": [ "et", "aliqua", "tempor sunt officia aute nisi", "dolor sed", "labore" ], "execute": [ "quis ut", "Lorem nisi", "voluptate Ut deserunt dolore" ], "manage": [ "pariatur in nisi" ] } }, "createdBy": "7bd0ef599AcdceF2BC0007f4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1Fd5a1A7dAd77CAfaec32Fd4", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "AE6a4FDAbeE1f50FF0eD447E", "name": "dolor culpa sunt ad" }, { "_id": "9B403eD69BfEeC9BcbaFf67A", "name": "aliquip ea" }, { "_id": "2B12e5e75D3BEA2aA7df538c", "name": "elit aliquip irure" }, { "_id": "b8a97AB24256051B6953B951", "name": "consectetur dolor fugiat" }, { "_id": "aE86Fd032Bc9eAa8fCD51e3C", "name": "ullamco cupidatat" } ] }, { "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": "1f11ADe4A2eC155De40ff4df", "namespace": { "type": "project", "name": "cupidatat velit officia", "accessControl": { "read": [ "eiusmod dolore esse ut", "ex", "proident incididunt", "est amet laborum ex", "ut non enim" ], "write": [ "amet qui dolor aliquip", "sit", "sint dolore" ], "execute": [ "irure" ], "manage": [ "magna reprehenderit" ] } }, "createdBy": "99B2FB175fc24747E49aA26D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eeCDBEa7E5d1FAA4BCC8E8Cb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7FCEBC831f737eE7D8FF7BD9", "name": "et aute reprehenderit ut tempor" } ] } ], "total": -34797691, "start": -7032667, "end": -34616109, "count": -16829454, "next": "consectetur tempor sint in enim", "previous": "ut pariatur velit non 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" } ] } } }