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": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "eu sit sint", "not-in": "Excepteur cillum officia eiusmod laboris", "equals": "elit", "contains": "occaecat labore exercitation pariatur velit", "starts-with": "in", "ends-with": "sint" } }
{ "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": "4c155bEb1DC4FceCd8Da37ef", "createdBy": "FBbfaCb2faaAa3a02AcCF08a", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "ca22a394bFdc16CC54CAa08a", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "219BcCE9F7BA8aDcce77EFEF", "name": "aute adipisicing in ex nulla", "description": "A user-defined object to help group documents." }, { "_id": "de95FeC7Bc3fD0CbAe3fa238", "name": "Ut Duis", "description": "A user-defined object to help group documents." }, { "_id": "D94DBaCe754bDCE26eE1C40C", "name": "tempor nulla consequat", "description": "A user-defined object to help group documents." }, { "_id": "020cBe693b234Ce24E0cda87", "name": "consectetur laboris", "description": "A user-defined object to help group documents." } ] }, { "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": "38D822d976fCDCdAA7ba8f49", "createdBy": "0b622BDCbC97BD911aB3CDaF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1a62CFeFA4e2230Aaf0D2fee", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0d4C63fbF512F22d76457e25", "name": "ad tempor in", "description": "A user-defined object to help group documents." }, { "_id": "bA0d3B83a3d22B8A3FA81feB", "name": "dolore in", "description": "A user-defined object to help group documents." }, { "_id": "EAdFCbFeffF8B7d645cd2EeF", "name": "in anim adipisicing Ut", "description": "A user-defined object to help group documents." }, { "_id": "b9AD82D98Fc84Ce4D88DDA5F", "name": "id qui cillum", "description": "A user-defined object to help group documents." } ] }, { "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": "AA0ff8e4Ba0Ac806eF59B9Ba", "createdBy": "BFcdEfCC496ce85DCE8a66ea", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "11DCECAA1f6735fdFCAF0a0D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2d0cD9b6d4336bc41bcb0cA5", "name": "qui Duis incididunt ex elit", "description": "A user-defined object to help group documents." }, { "_id": "Fa2aA225B9b769eA290accfa", "name": "in fugiat elit eu sit", "description": "A user-defined object to help group documents." } ] } ], "total": -62592260, "start": -79508598, "end": 80391335, "count": 54530104, "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": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }