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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,description", "exclude": "description", "in": "aliqua ut", "not-in": "nostrud culpa elit esse", "equals": "consequat", "contains": "id aute pariatur sit deserunt", "starts-with": "velit", "ends-with": "non aliqua ipsum" } }
{ "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": "A2e6Dff1eeEA0F05B34bc4de", "namespace": { "type": "project", "name": "deserunt dolor veniam dolore", "accessControl": { "read": [ "ut ad amet" ], "write": [ "eu cupidatat veniam esse Excepteur", "nulla", "proident sunt anim tempor in", "in" ], "execute": [ "in proident", "tempor irure eiusmod Duis", "incididunt qui sint sed Lorem", "nostrud aliqua in" ], "manage": [ "tempor ullamco nostrud", "exercitation fugiat ipsum esse" ] } }, "createdBy": "42d0E36dFfe5Ecd6ef993a8D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C26F6cc34Ea8F09705A62f1F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D7A32D8Ffd6F3DCC14c69F2F", "name": "aliqua irure deserunt ut" }, { "_id": "3A9D8E0C8aBBE6D9AbEE73ff", "name": "aute aliqua ipsum nostrud adipisicing" }, { "_id": "27Ee3B57CbEbf168bCCff1DC", "name": "ullamco consectetur incididunt Duis laborum" } ] }, { "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": "3b235E2abdB0aB8fE9fFACCc", "namespace": { "type": "project", "name": "cupidatat cillum exercitation", "accessControl": { "read": [ "ut", "et esse Lorem" ], "write": [ "in aliqua ex fugiat ipsum", "eu mollit laboris quis ullamco", "aliqua laboris nostrud ad elit" ], "execute": [ "laboris", "nostrud dolor cillum in", "laboris consectetur Excepteur ex" ], "manage": [ "Ut dolor dolore", "et do quis ipsum", "est magna eu", "Lorem labore" ] } }, "createdBy": "BB1F5BfBD1D7052abc8DDF60", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "F9BbBaeF56fC68F9A75FD004", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "C0a1da71DbbfAbd1b78DD91D", "name": "do exercitation aute sunt et" }, { "_id": "643fE700dcFeB3dc4DCbA144", "name": "sunt sit quis" }, { "_id": "d085A2AFdcE9443D4b52639E", "name": "ullamco officia tempor ea" }, { "_id": "32DcC2cc3EaafA3c51E0BB9C", "name": "pariatur aliqua amet" } ] }, { "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": "C5E7EBfd71Ae5961bec1db8B", "namespace": { "type": "project", "name": "reprehenderit", "accessControl": { "read": [ "id anim amet magna", "tempor sint do deserunt aliqua" ], "write": [ "ipsum laboris enim est dolore", "voluptate irure in minim" ], "execute": [ "aliqua sint mollit anim dolore", "do cupidatat esse incididunt minim", "dolore", "ut" ], "manage": [ "aliqua aliquip", "quis", "nostrud", "est ut", "dolore ipsum consequat qui eiusmod" ] } }, "createdBy": "55c16AA2Ca56ECa24f31792A", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "F7aCFF04f672AF04AEbFb3f2", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "29CddEabaC07Ad9f54F6cA4e", "name": "eu et cupidatat deserunt" }, { "_id": "b25a01E6ca56ca1ad96edF05", "name": "proident cupidatat" }, { "_id": "C37d4CA736db1dE4757deABe", "name": "nisi adipisicing Duis et" }, { "_id": "a17b0f2CEaf4cb7B7BcaE5d8", "name": "labore esse in elit" } ] } ], "total": 50507903, "start": -68585567, "end": -61940769, "count": -12981261, "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" } ] } } }