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": 10, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": { "_id": "anim", "name": "veniam Ut laboris consequat", "group": "id", "command": "minim esse nostrud ea aute", "description": "ut nulla sint", "template": "Duis", "data": "aute aliquip in elit deserunt", "type": "exercitation in sit enim", "createdBy": "dolore", "created": "amet cillum", "lastModifiedBy": "sint commodo in labore reprehenderit", "lastUpdated": "et reprehenderit amet aliqua ut" }, "not-in": { "_id": "anim", "name": "consectetur quis aliqua", "group": "nostrud nulla deserunt pariatur", "command": "dolor irure Lorem est", "description": "reprehenderit Lorem pariatur minim", "template": "adipisicing", "data": "ipsum sunt adipisicing", "type": "elit dolore", "createdBy": "nisi in consectetur minim", "created": "sed in", "lastModifiedBy": "eu enim anim mollit minim", "lastUpdated": "laboris reprehenderit adipisicing consectetur esse" }, "equals": { "_id": "non fugiat", "name": "qui ad sunt adipisicing Duis", "group": "laboris dolor minim", "command": "sint dolor eiusmod in", "description": "officia", "template": "adipisicing pariatur commodo amet cillum", "data": "ea Excepteur amet Lorem veniam", "type": "non", "createdBy": "est nulla", "created": "fugiat consectetur cillum dolore", "lastModifiedBy": "ullamco ad tempor reprehenderit ut", "lastUpdated": "anim et" }, "contains": { "_id": "est nostrud exercitation", "name": "irure", "group": "voluptate occaecat", "command": "anim eiusmod", "description": "aliqua ea laborum", "template": "voluptate do culpa", "data": "voluptate", "type": "dolor", "createdBy": "ullamco mollit dolor occaecat", "created": "ea in officia magna", "lastModifiedBy": "consequat nulla ex", "lastUpdated": "dolor amet" }, "starts-with": { "_id": "non", "name": "id magna ea", "group": "et", "command": "ut sit in occaecat pariatur", "description": "esse sed", "template": "Ut qui minim eiusmod", "data": "commodo voluptate cupidatat consequat ullamco", "type": "commodo consectetur in Duis", "createdBy": "laborum", "created": "sunt", "lastModifiedBy": "proident occaecat laborum in Lorem", "lastUpdated": "ut incididunt id veniam" }, "ends-with": { "_id": "enim et Duis in", "name": "mollit", "group": "ipsum commodo officia occaecat", "command": "do anim nulla ut", "description": "amet voluptate laboris proident Excepteur", "template": "esse enim", "data": "non et incididunt aliqua", "type": "nisi esse", "createdBy": "velit dolor", "created": "culpa", "lastModifiedBy": "deserunt non aliqua sint", "lastUpdated": "dolor incididunt commodo quis" } } }
{ "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", "$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": "abCfc6a58CEF7fB6b4c5aF4B", "createdBy": "6a451bdEfbD26CEc95ADcaCa", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "57c2AAc826BdEcaFEBB2EdE8", "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": "40460fE516B2CF3ebFE23a49", "createdBy": "6D4fC20d1D3cDACC3faDdf8b", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "AeACcBeE1B98BFADC720b6A6", "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": "CaFca372057beeFde72C2660", "createdBy": "0d853bc33eccc394eC33Aade", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "3decaddd8CeeFafAf2eCb9fd", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -12084902, "start": 53777785, "end": -69858008, "count": -7432936, "next": "aute", "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." } } }