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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": { "_id": "in dolor enim id occaecat", "name": "reprehenderit in qui", "group": "eu", "command": "elit", "description": "enim aute", "template": "elit deserunt dolore nisi", "data": "voluptate tempor qui eu irure", "type": "irure Duis et qui consectetur", "createdBy": "enim ipsum commodo", "created": "qui sit deserunt consequat", "lastModifiedBy": "cillum in Duis", "lastUpdated": "ex" }, "not-in": { "_id": "cupidatat deserunt non tempor sint", "name": "reprehenderit Duis magna in", "group": "ad Excepteur irure tempor aute", "command": "nostrud", "description": "tempor nostrud non enim", "template": "irure ut culpa esse minim", "data": "Excepteur", "type": "dolore ut consectetur", "createdBy": "reprehenderit cupidatat ex tempor", "created": "ullamco eu", "lastModifiedBy": "reprehenderit", "lastUpdated": "Duis" }, "equals": { "_id": "deserunt Duis veniam adipisicing", "name": "ut culpa ex do", "group": "incididunt minim nulla amet", "command": "ex Excepteur ad non cupidatat", "description": "consectetur in dolore", "template": "id", "data": "Lorem aliqua", "type": "Excepteur id enim", "createdBy": "do", "created": "veniam exercitation", "lastModifiedBy": "officia enim", "lastUpdated": "deserunt" }, "contains": { "_id": "laborum consequat", "name": "anim sit Ut magna in", "group": "anim mollit dolor et fugiat", "command": "dolore irure culpa", "description": "sunt", "template": "nostrud eu", "data": "ipsum Ut", "type": "Ut", "createdBy": "laborum", "created": "laboris in tempor fugiat", "lastModifiedBy": "adipisicing elit sit voluptate", "lastUpdated": "quis" }, "starts-with": { "_id": "pariatur commodo ea incididunt", "name": "nulla", "group": "in consequat", "command": "consequat ut", "description": "nulla velit commodo laboris Duis", "template": "dolor ipsum in do", "data": "dolore exercitation quis nulla anim", "type": "dolore id dolore nisi ea", "createdBy": "est tempor Ut", "created": "quis amet", "lastModifiedBy": "Duis qui proident cillum", "lastUpdated": "pariatur aute dolor" }, "ends-with": { "_id": "esse dolore in reprehenderit", "name": "proident veniam in commodo ullamco", "group": "officia nisi eiusmod", "command": "aliquip pariatur", "description": "laborum mollit esse", "template": "sint reprehenderit laboris in adipisicing", "data": "deserunt eu aliqua incididunt", "type": "sint nisi", "createdBy": "ut culpa aliqua sit occaecat", "created": "sunt nisi eiusmod in laborum", "lastModifiedBy": "sint consectetur Excepteur", "lastUpdated": "quis Excepteur anim dolor" } } }
{ "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": "CD24a8daA1d8aeeF7D6BEff9", "createdBy": "dbD9DffC109b0EDe8e8193Fd", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "DAdE91C4ABf16EF1fA6C2ADB", "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": "726cC4670fBcD3E0ABB8ddA8", "createdBy": "f920aB2D9dB0e663BD91858B", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "9598e1dB51d51df58afCD1aa", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 3618050, "start": -48223016, "end": -13857894, "count": -94302669, "next": null, "previous": "occaecat" }
{ "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." } } }