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": 25, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name,description", "exclude": "_id", "in": "dolor tempor", "not-in": "reprehenderit dolor consectetur tempor et", "equals": "ex sed labore in", "contains": "in ut mollit deserunt", "starts-with": "eiusmod id", "ends-with": "occaecat exercitation reprehenderit Duis incididunt" } }
{ "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": "4E5cBAA4dBC0dbF38aEaDdda", "namespace": { "type": "project", "name": "reprehenderit aliquip", "accessControl": { "read": [ "pariatur commodo ut", "non" ], "write": [ "reprehenderit", "dolor anim", "Lorem voluptate", "ea tempor quis in", "amet esse" ], "execute": [ "fugiat minim ut", "sit", "ea consequat", "aliquip", "officia id magna reprehenderit Lorem" ], "manage": [ "incididunt", "ut incididunt ut in", "consectetur", "Lorem sunt Duis qui est", "ullamco proident Duis in" ] } }, "createdBy": "EcacFf5f8f4d6F1cf2cAfA66", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "4caBB2bF3cFff6Df04C0abFe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "BBEa3D27D069bEE0c2B7ABD5", "name": "dolore nisi dolor" }, { "_id": "391feCf31408D212E8ef7eFE", "name": "Ut non occaecat sed" }, { "_id": "2EeabEceB1Dd66f5b0fdc2dc", "name": "enim aliquip" } ] }, { "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": "AB6Eaec14ef209db6DC5d7Ce", "namespace": { "type": "project", "name": "veniam qui labore eiusmod sint", "accessControl": { "read": [ "Ut ut id exercitation mollit", "in" ], "write": [ "proident Lorem dolore Duis et", "consectetur culpa ipsum", "nisi ipsum labore dolor ex", "aliqua incididunt sint labore cillum", "in adipisicing deserunt labore ex" ], "execute": [ "anim magna nostrud sunt", "consectetur aliquip", "dolore in", "incididunt in nostrud" ], "manage": [ "dolor commodo velit nulla in", "deserunt consectetur Excepteur", "in aliqua adipisicing", "voluptate" ] } }, "createdBy": "4dd29dE5cc276Df44ae8b7C7", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "cA7AE9C0665f60b7f6b282bb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DBC67ABeE5d1D00Ba296cDac", "name": "incididunt anim labore" } ] }, { "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": "9Db0Aa8Afa517eAca78A0193", "namespace": { "type": "project", "name": "anim nulla ex minim", "accessControl": { "read": [ "dolor", "minim", "Excepteur sunt adipisicing" ], "write": [ "dolore mollit", "deserunt dolore fugiat", "adipisicing ea nisi Excepteur", "magna voluptate ad", "cillum esse elit" ], "execute": [ "minim ea ad et dolore", "pariatur cupidatat dolor", "labore", "Ut", "occaecat dolor sint ex magna" ], "manage": [ "dolore", "minim et officia enim", "pariatur quis nisi", "eiusmod amet eu id" ] } }, "createdBy": "F98EDeC83e0BF0fc9c7ca0aF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "140C3c57dEBC5B72Ad23CD69", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "aC7b8AE87CFDFafF1F9Ec12D", "name": "ut reprehenderit cillum mollit" }, { "_id": "71FC2Af6D8552CC9E2335973", "name": "sed mollit aute ipsum" } ] } ], "total": -96979133, "start": -80324440, "end": -29158503, "count": 50631988, "next": "tempor qui aliqua", "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" } ] } } }