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": 1, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "aliquip consectetur Duis", "not-in": "in pariatur et deserunt aliquip", "equals": "est id laborum ipsum", "contains": "est", "starts-with": "aliqua velit ex deserunt et", "ends-with": "in est" } }
{ "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": "96Fcc7cb3aef95f90dEFCcEb", "createdBy": "f5bFbDb18Dd47F047E50EB59", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eB164fcA1B8cC9AC01fA8166", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9f0d279bF4B7de98bfcD9Eda", "name": "voluptate anim ipsum" }, { "_id": "c74a21bD8628ed17BDDb16c8", "name": "laboris ipsum et consectetur consequat" }, { "_id": "629CE4CAe03bA9BbC0ceBC30", "name": "magna aliqua ex" }, { "_id": "139fB92233dAD0d6126DEcba", "name": "ullamco dolor" } ] }, { "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": "1922Db8Ae454e6dd6922483F", "createdBy": "758dfdFbDDc51EFAC0510d3B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CCaE3fCeFeCd3BDF84A276AB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "cdb2c4F690aefEECFBc81Ea5", "name": "in nostrud quis aliqua minim" }, { "_id": "AA3E5e3fFEbBdceBDFeBFccC", "name": "veniam aliquip" }, { "_id": "E3Ef39a56BD1360EE3af3986", "name": "est consequat" }, { "_id": "7FD0AaA947b31a327E15b5Ab", "name": "aliquip fugiat incididunt sed in" }, { "_id": "45c0D5ebeEDD7bfFFA0F7bd1", "name": "sunt occaecat" } ] }, { "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": "B6ADaF546AD5b8F2C1250baa", "createdBy": "bDFc1815C44AaFe104e5BC28", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C5ACBFFFacf94Ca8FCcF0f74", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "CFF4acBdBb2fCf2A9AF919d0", "name": "nostrud laboris" }, { "_id": "CDeC8E181C716CEab3AE8A0A", "name": "eu ex" }, { "_id": "5566e683f2d6d9dBb3cCca4b", "name": "ipsum Lorem" } ] }, { "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": "AffCA5DAd32ccFEEc531b33b", "createdBy": "c600F35DD1c0C83Dfdb755eE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f34cae8CEfbB01EEFC5e3a14", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9EAFf5aCcdB3183BdbFf8Ad6", "name": "qui veniam cillum commodo" }, { "_id": "a2A605FeeDB03eBB298Fd79a", "name": "minim laborum qui ex" }, { "_id": "CeF32b5FE5b486B1fFC3Dd8f", "name": "sunt veniam" }, { "_id": "8c4941Da5E7DD08FFFA0dEdb", "name": "ut occaecat" }, { "_id": "F0D0B573D9Fc034A5eAb0F76", "name": "velit commodo" } ] } ], "total": -55178519, "start": -41503251, "end": 47143093, "count": -45355137, "next": "culpa mollit qui", "previous": "labore anim Excepteur ea" }
{ "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }