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": "description", "exclude": "_id,description", "in": { "_id": "qui nisi", "name": "ea ad dolore", "group": "dolor do dolor", "command": "labore veniam", "description": "ipsum Ut quis ut elit", "template": "culpa ut elit pariatur laboris", "data": "ut enim quis commodo mollit", "type": "anim", "createdBy": "cillum sit fugiat est", "created": "in minim deserunt", "lastModifiedBy": "dolore elit", "lastUpdated": "ea sunt velit" }, "not-in": { "_id": "tempor ipsum ullamco", "name": "non magna id do laborum", "group": "aliqua", "command": "velit Ut fugiat", "description": "nulla incididunt", "template": "ea dolore aliquip", "data": "sunt dolor consequat incididunt dolor", "type": "dolor veniam", "createdBy": "elit reprehenderit et", "created": "labore", "lastModifiedBy": "adipisicing occaecat", "lastUpdated": "enim sit commodo proident in" }, "equals": { "_id": "aute", "name": "aliquip incididunt sed officia minim", "group": "nisi", "command": "ut", "description": "sunt et incididunt magna", "template": "minim voluptate sunt est elit", "data": "quis sint ullamco", "type": "aliqua ad pariatur in", "createdBy": "irure incididunt sunt laboris minim", "created": "fugiat ad Ut", "lastModifiedBy": "commodo enim eu eiusmod pariatur", "lastUpdated": "eu laborum anim exercitation enim" }, "contains": { "_id": "proident Ut tempor", "name": "Ut qui", "group": "ipsum dolore eiusmod reprehenderit dolor", "command": "consectetur occaecat ipsum esse eiusmod", "description": "aute ullamco dolore ad irure", "template": "sint voluptate Duis", "data": "dolor est quis non", "type": "fugiat proident magna aliqua", "createdBy": "magna officia proident culpa adipisicing", "created": "do ex ipsum sint ut", "lastModifiedBy": "ullamco occaecat velit", "lastUpdated": "et incididunt officia do" }, "starts-with": { "_id": "elit", "name": "magna", "group": "sed sunt aute", "command": "laboris eu et enim", "description": "pariatur Duis", "template": "Excepteur", "data": "in", "type": "sit Lorem aliqua", "createdBy": "ullamco laboris magna culpa id", "created": "quis non nisi Duis magna", "lastModifiedBy": "cupidatat", "lastUpdated": "deserunt do proident aliquip" }, "ends-with": { "_id": "in irure", "name": "quis culpa in non veniam", "group": "deserunt laboris eiusmod in", "command": "in", "description": "est Excepteur incididunt", "template": "in", "data": "do nulla cupidatat consectetur", "type": "laboris enim ullamco labore", "createdBy": "veniam reprehenderit", "created": "esse velit aliqua sint", "lastModifiedBy": "cillum aliqua ut dolor aliquip", "lastUpdated": "esse sunt tempor Lorem" } } }
{ "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": "3CcaA0713C87D9D13CBaE5BF", "createdBy": "7F02Bc5AdBAB7EFB08a2afEa", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "eEC5ab5D9C5DCf968dDA4dAE", "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": "55c50BF2d69B0dBa52f30cE3", "createdBy": "Ce7fABA9b47deABACe279347", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "3e8aEF0Ce42db098ea3aF0bD", "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": "Cda3b4a1BBb6AC12ed47AbbF", "createdBy": "36fa5B8EfeaFDed4e5bfc82B", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "F9Cd2b0DA6CfD4Aaefb5c792", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -42751412, "start": 21356508, "end": 84160415, "count": 95702871, "next": "fugiat", "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." } } }