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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "deserunt Ut velit magna", "not-in": "consectetur Lorem anim id", "equals": "sed magna sunt nostrud occaecat", "contains": "labore", "starts-with": "enim", "ends-with": "nisi quis ipsum adipisicing in" } }
{ "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" ] }, "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": "1db61Ac0f31ba19CD5151e7C", "createdBy": "dC7fbaaBBDeffE2122CDCC08", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C39bBadc9c7Ef2D15bb590c8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7c20fFf0051bdA07588Aea1C", "name": "reprehenderit magna sunt" }, { "_id": "Df35C3ceCAb793Fd3464e30c", "name": "reprehenderit enim qui magna" } ] }, { "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": "B4Bc1EA853D36FBf25BFF366", "createdBy": "4Ee16CA3CF58a36b01358d5d", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "96D31BAc1B2CF69cea6A0A86", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "B3AE5FE5F2aE2850bFe9e3dB", "name": "incididunt adipisicing Duis cillum occaecat" }, { "_id": "5dbAf29beB87d2f43cb4b49C", "name": "consectetur" }, { "_id": "A9176ca7ac58BAd6ccd2AbAF", "name": "magna" }, { "_id": "4dAdB9e2dA262AD51Ee4D106", "name": "incididunt" } ] }, { "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": "037707B92BA3BcedBE0EDbe8", "createdBy": "bB8b0cd15FcDdff90fCfc07E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1AbfAF4BFC0beFf21Abb3d6C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "C3b4a2Ef53ecf08D9FBa4219", "name": "Ut nostrud ad anim pariatur" }, { "_id": "dB02BfE2f17E6feD71f3fF4c", "name": "veniam dolore laborum" }, { "_id": "cDbA01f4F01BEb6C5f10d2BB", "name": "nisi cillum minim" }, { "_id": "992A43C14E2Dfa059617C73E", "name": "in sint reprehenderit nisi sed" } ] }, { "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": "B0Ae1DEdD07FB81d7E15fD4e", "createdBy": "AfEFcBfACdaEC89dFCfcDE08", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C9A42A131aF0Ed528b6461dE", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2fd4Ac12fa095aD02B7C3851", "name": "magna eu dolore amet" }, { "_id": "94Ee20dB19C8fe751b47A129", "name": "id" }, { "_id": "EAaB29dddb42E9d9eE8EFcbb", "name": "proident quis occaecat eiusmod commodo" }, { "_id": "Eb82361BcEb23Ff40990Cebe", "name": "occaecat" }, { "_id": "B698cf9C0ad5A62dfcdf5B49", "name": "eu minim cupidatat dolore" } ] }, { "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": "aE08C04aFaed4d38DfCd7047", "createdBy": "f5d5Ede1CBaEAF6933dbeD1C", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ba9ca6e813fB3Bcd7d7F2Ccd", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "4d19Cb68D8c1c1eEb41Eef1f", "name": "minim ut Lorem sint ad" }, { "_id": "6E04dEDc3e6cCc82ead0C6fD", "name": "eiusmod enim labore fugiat" }, { "_id": "EeCD1Edbf09640f4aD713b4C", "name": "cupidatat" }, { "_id": "8C0242e5B85aF1d64d83bE68", "name": "quis" }, { "_id": "d6c20415F27b8bdb4A289B49", "name": "Duis" } ] } ], "total": -21406823, "start": -2979430, "end": 63725669, "count": 53965937, "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" } ] } } }