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", "include": "description", "exclude": "description", "in": "ut", "not-in": "officia", "equals": "sed cillum dolor", "contains": "consequat Excepteur eiusmod mollit consectetur", "starts-with": "ut eiusmod velit esse", "ends-with": "qui labore consectetur dolor voluptate" } }
{ "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": "8aFBA39e37FAfAed1bC23fc0", "createdBy": "dF0Ac9007183FAB9cAa633d3", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "316ebf19EAFcD0F879d2c014", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "006b6C7DF8Bf21B920CEd244", "name": "consequat" }, { "_id": "ecdd089e5Bd4CDCD610CcB3b", "name": "irure Ut deserunt nulla" } ] }, { "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": "Eaf2D38E9BBFF8cC9Fbeb8f9", "createdBy": "b2153AdB3D36E1DFbFaFec9c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9b420ef0C9f6bDf8deD3Deb5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "849003c47eAdFeEdaA59D907", "name": "dolor ut" }, { "_id": "e7eb5f59bA7710fDF6BEC7D1", "name": "do dolore id dolor" }, { "_id": "97AC22d9F06B2E3D600b6034", "name": "id et velit nostrud est" }, { "_id": "A6BCfBAdF5CeE5798ccB0cef", "name": "ipsum" }, { "_id": "3ED4F6060dFa405E68bfdFcA", "name": "sunt pariatur dolor veniam 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": "681ee2dbDa9d7CDF30BBdc8a", "createdBy": "947DB9C1c15CFd6Ad49BDAbe", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "af01F3BdC5B11D43467b343C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DDaFB148F369A21312bD6893", "name": "non fugiat cillum labore" }, { "_id": "3F00d58bF21d77D1ed9765E6", "name": "consectetur Duis reprehenderit adipisicing ipsum" }, { "_id": "0DCbFFAb55aC66F175aAf647", "name": "do 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": "6cdb38248CFA4D7CE5762480", "createdBy": "B4b7ca522dBa4fa1d3bE2786", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eEcd1f9F92E7062deBA90a58", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "75D6cAdeC53C95fC59BFdB2F", "name": "amet dolore" }, { "_id": "8fA3A7E89eaCA2A742AC728d", "name": "cupidatat ad ullamco culpa est" } ] }, { "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": "8ec927B0029E341eFAb8DF02", "createdBy": "0DDAD011cD2511283e4Bd0D4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c107E6dd65075E87BB103Cea", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7beea4dc1b3A94E8482E24d1", "name": "quis Ut qui" }, { "_id": "F7E3Cec397ABBb59d373553a", "name": "nisi ipsum in ullamco cupidatat" }, { "_id": "4Bd3bA2fd190EE609300f8ec", "name": "dolore" }, { "_id": "A064D70C7DdaA2C3965D759c", "name": "nulla ad" }, { "_id": "b5a2de5f3bB1aa18faA1Db70", "name": "consectetur" } ] } ], "total": -3951137, "start": -23866778, "end": 66000696, "count": -77836498, "next": "mollit Duis dolor esse", "previous": "quis cillum officia minim nostrud" }
{ "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" } ] } } }