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": "elit ut dolore adipisicing irure", "not-in": "proident consequat tempor anim", "equals": "ex exercitation", "contains": "exercitation ullamco occaecat", "starts-with": "laborum nisi et eu", "ends-with": "adipisicing ipsum quis labore id" } }
{ "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": "fb88Ef8B3969fC59c2321AAE", "namespace": { "type": "project", "name": "veniam qui", "accessControl": { "read": [ "reprehenderit mollit", "esse consectetur nostrud" ], "write": [ "sunt" ], "execute": [ "dolor aute", "laboris amet minim" ], "manage": [ "nisi aliquip esse amet", "id et consectetur" ] } }, "createdBy": "fa4DffEF3df3e9F947b3dB78", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "84f4a47fb0618682Af8ecE6D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "30526A753A3DdCDe76814c43", "name": "dolor ullamco" }, { "_id": "F72b0Fe8CfaAfdfb4e2DFE14", "name": "officia" }, { "_id": "b3AC7642b729D7A840112cf5", "name": "officia elit proident" }, { "_id": "92CdfB0672E95F3aaBaaDD15", "name": "tempor incididunt ut" } ] }, { "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": "BDfaD4B5F0eC8E271D1Eea4d", "namespace": { "type": "project", "name": "aliquip", "accessControl": { "read": [ "mollit", "reprehenderit" ], "write": [ "ut anim elit Lorem", "cupidatat id ea irure enim", "in aliquip cillum" ], "execute": [ "ipsum nisi eu Excepteur exercitation", "do amet", "et id ullamco irure", "exercitation mollit nostrud dolore ut", "nostrud laborum esse fugiat ipsum" ], "manage": [ "Duis" ] } }, "createdBy": "3ED5D5DEfA998E75ED0e24A8", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "75Ae31D36Cba119aDe3045ed", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Adf3fBAbDf6B80cf142EB337", "name": "commodo in deserunt" }, { "_id": "6B5E5Adf0dE5fB283A8AF4e8", "name": "et esse magna nisi" }, { "_id": "85CfCAdd975B7E3D53fff0E9", "name": "non sed cupidatat reprehenderit" }, { "_id": "4ef1f0a8E0824256Ac0f78CB", "name": "aliquip tempor nisi id" }, { "_id": "91E8bb1d9A93fD9C1a1CdBCD", "name": "elit" } ] }, { "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": "d3ee8114B84feaDbd39c07c1", "namespace": { "type": "project", "name": "elit Excepteur veniam laborum enim", "accessControl": { "read": [ "dolore dolore Lorem dolor", "labore magna pariatur exercitation", "reprehenderit ipsum eiusmod do id" ], "write": [ "sed velit in aliqua minim", "aliquip ad labore dolor" ], "execute": [ "in cupidatat sunt", "Duis deserunt incididunt", "dolore", "aute consectetur qui et exercitation", "velit dolore id exercitation" ], "manage": [ "ut incididunt aliquip", "reprehenderit elit", "veniam irure dolore", "nostrud proident eu culpa nulla", "commodo sit aliquip" ] } }, "createdBy": "F37eAEEfF1Efc3bb8aE28FFe", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "EbcBBc381a9C61DFAa928a1f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "a38193A4ff4bcdC8BeAB070c", "name": "magna" }, { "_id": "54AEbD3069C1a367ccce68DE", "name": "officia voluptate dolore" }, { "_id": "3f85BB3a6D59eC8Ba9d6E75e", "name": "eu id reprehenderit ea" } ] } ], "total": -72383204, "start": 43723100, "end": -18726642, "count": 41025472, "next": null, "previous": "veniam mollit elit anim irure" }
{ "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" } ] } } }