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": "name", "exclude": "_id,description", "in": { "_id": "qui", "name": "laboris cillum irure", "group": "ut sint", "command": "qui enim", "description": "qui ut ut ea", "template": "sint", "data": "adipisicing", "type": "consequat incididunt", "createdBy": "Excepteur fugiat pariatur ea", "created": "Ut aliquip in ullamco", "lastModifiedBy": "in adipisicing laborum ut", "lastUpdated": "ex laborum do dolore ad" }, "not-in": { "_id": "velit laborum labore qui", "name": "in dolore sit aliqua in", "group": "deserunt in ipsum do", "command": "deserunt", "description": "eu occaecat eiusmod do", "template": "fugiat anim consequat aute", "data": "anim dolore", "type": "consectetur anim", "createdBy": "eiusmod ea Lorem ullamco aliqua", "created": "sit commodo", "lastModifiedBy": "fugiat eu labore irure", "lastUpdated": "Ut irure cillum ex ut" }, "equals": { "_id": "sunt laboris nisi", "name": "velit nisi veniam", "group": "ea id qui do amet", "command": "occaecat consectetur proident", "description": "esse", "template": "eu consectetur exercitation id", "data": "exercitation qui", "type": "nisi ad nulla tempor", "createdBy": "quis labore elit ut", "created": "ad dolor aliquip reprehenderit", "lastModifiedBy": "id ut culpa dolor veniam", "lastUpdated": "deserunt veniam commodo consectetur" }, "contains": { "_id": "irure incididunt nulla in deserunt", "name": "anim nostrud reprehenderit dolore", "group": "nostrud commodo magna", "command": "quis reprehenderit nulla cillum eiusmod", "description": "ut sit", "template": "laborum", "data": "nisi officia elit", "type": "in veniam Lorem", "createdBy": "eu commodo tempor", "created": "esse minim dolore ea", "lastModifiedBy": "laborum labore", "lastUpdated": "ea dolor labore Ut" }, "starts-with": { "_id": "amet", "name": "tempor veniam Ut Duis fugiat", "group": "mollit laborum", "command": "deserunt irure cillum", "description": "amet occaecat ex consequat incididunt", "template": "laborum", "data": "aute et eiusmod tempor", "type": "sed", "createdBy": "Excepteur et", "created": "sed dolore", "lastModifiedBy": "irure ut eu ullamco reprehenderit", "lastUpdated": "esse culpa labore nulla" }, "ends-with": { "_id": "officia Ut laboris commodo", "name": "nisi", "group": "sunt id sint", "command": "nulla", "description": "minim ut", "template": "aliquip do et dolor voluptate", "data": "enim incididunt in id", "type": "laborum reprehenderit amet Ut", "createdBy": "sunt", "created": "id ex", "lastModifiedBy": "qui consectetur do", "lastUpdated": "tempor culpa eiusmod adipisicing voluptate" } } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "additionalProperties": true, "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", "$ref": "template#/definitions/searchableFields" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "$ref": "template#/definitions/searchableFields" } } } }, "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": "fAb6f02aee98A3Ed2210AfaC", "createdBy": "65cDd033b5Ab2a8D4e6C1Ed1", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "eD1fdBA74C5f76Aea118FbC6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "cDFe586F9CF2b2d8b4DcB4Ca", "createdBy": "1DCbbc49455De85a9bED52ed", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "CE23C12f5aCCae9B0cce1352", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "cAf1c548a976bD451AeA39Ad", "createdBy": "DAbcADD191b81Fd1ddC7A4EE", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "EAd81Eabf9d103eC8faEA45c", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "12eEcFE70c1Dde51Dbe827e6", "createdBy": "47aB003E9e4caEAE6CFDcE35", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "2a56AfED9CBA75cf0bA1480D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "A520a363dE4E66a529aAAEEE", "createdBy": "04B9a768D2F0e3C7AB27fa1b", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "ca735a8Fb30d706e2766D189", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 86948564, "start": -75023654, "end": -40774258, "count": -90285706, "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." } } }