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": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name", "exclude": "_id", "in": "ea id laboris deserunt", "not-in": "ad magna", "equals": "dolor in sit nostrud", "contains": "laborum dolor ex sint", "starts-with": "in in sed sint voluptate", "ends-with": "laboris nisi adipisicing exercitation" } }
{ "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": "aD997B2B2377ab5Fe7D7B8B1", "namespace": { "type": "project", "name": "cupidatat veniam", "accessControl": { "read": [ "nulla cupidatat Excepteur anim" ], "write": [ "mollit", "sint voluptate ea pariatur", "laboris", "aute" ], "execute": [ "sed velit sit ex Excepteur", "commodo exercitation dolore reprehenderit aliquip", "mollit aute do dolor consequat" ], "manage": [ "mollit consequat pariatur in tempor", "pariatur consequat irure ipsum ullamco" ] } }, "createdBy": "EdbBb0D6e8CE7b4Cec1B7e6C", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "b28a5CD1C1EA1f4C01f0cD5a", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "fc6a4Df042BB7dcDCA3D46dB", "name": "veniam nostrud reprehenderit quis" }, { "_id": "B330e9C8d67DfF1BAD02BA1d", "name": "eiusmod anim ut qui" } ] }, { "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": "bcb968fC4eEC7A0E41C16FdD", "namespace": { "type": "project", "name": "tempor dolore ipsum sed", "accessControl": { "read": [ "magna esse aliqua dolor ipsum", "ut veniam" ], "write": [ "tempor", "eu nostrud est esse", "amet consequat sed culpa", "nostrud officia sed", "tempor est Ut" ], "execute": [ "non cupidatat", "consectetur mollit culpa", "velit fugiat" ], "manage": [ "Duis sunt", "aliqua" ] } }, "createdBy": "99Def743cbef9D4Cc8aE8680", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "aa0D13669ddF55a2AfC89a15", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "84CBFe57bc98f4dFEd51dFd2", "name": "nostrud proident est deserunt sit" }, { "_id": "6F5493eDA2efE77A157DfD6F", "name": "cillum pariatur adipisicing aliquip" }, { "_id": "70f9A0e2aaAD2DcB0cA73453", "name": "aliqua voluptate incididunt sed proident" } ] } ], "total": -53917595, "start": 12860597, "end": 8275626, "count": 14727011, "next": null, "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" } ] } } }