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": "name,description", "exclude": "_id", "in": "anim aliquip", "not-in": "ipsum", "equals": "Ut", "contains": "ut nostrud exercitation eu", "starts-with": "veniam mollit", "ends-with": "sed ea" } }
{ "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": "05AaeFad060e9CeEE51dc4dB", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "culpa", "cupidatat veniam adipisicing in cillum", "sit", "reprehenderit elit", "Ut pariatur fugiat id dolor" ], "write": [ "Lorem" ], "execute": [ "mollit do", "quis do in veniam", "tempor eiusmod Excepteur ad", "quis anim in eu" ], "manage": [ "voluptate aliquip ut amet" ] } }, "createdBy": "Cc18a0D928B7FaAC4bA556f8", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "bf64Eb6076EF9bAF8C63ECe8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F6E000cD525c9fc112F8e90b", "name": "Excepteur id ullamco ea deserunt" }, { "_id": "f233e2AA12D2fffc8DfA4A8e", "name": "incididunt tempor ea 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": "a065354aB5b6c6FD9aAA8483", "namespace": { "type": "project", "name": "nisi tempor eu consectetur dolore", "accessControl": { "read": [ "in minim", "amet ipsum", "aliqua", "pariatur cillum culpa velit dolore", "incididunt reprehenderit aute consectetur" ], "write": [ "sed", "adipisicing dolor in elit" ], "execute": [ "amet eiusmod magna", "ut sed do in sunt", "pariatur ipsum", "et ex in Ut", "ex veniam sunt mollit commodo" ], "manage": [ "aute eiusmod anim est Lorem" ] } }, "createdBy": "d8930c65dA3f58CfaDaA16BF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B9dcCd4d6dcDbB1382fB0eaa", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E0e2D6bB45280d3ef86ecFbE", "name": "tempor" }, { "_id": "d7FbF4C9B4f31fe42Fb2dFAf", "name": "in velit sint laboris in" }, { "_id": "eDB6CCB5AE8E9dCbBBe6eBEd", "name": "in veniam" }, { "_id": "3aC3aFF3CD5a1ddc0423bEEC", "name": "commodo" } ] } ], "total": -41098897, "start": 55915711, "end": -6249330, "count": -49907552, "next": "proident velit quis", "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" } ] } } }