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": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "commodo aute", "not-in": "in Ut in aliqua", "equals": "eu et ut occaecat laboris", "contains": "dolore ullamco", "starts-with": "Lorem in veniam ullamco id", "ends-with": "magna dolor" } }
{ "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": "2E644eaB8ACe4BfB44bcF9A9", "createdBy": "9CB8eFBdCbab4F2C83E8cE0E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c9f1f168C301851e1acEbf9f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9fb785548b89Fd45Ed3C6d8C", "name": "Lorem", "description": "A user-defined object to help group documents." }, { "_id": "38B10C9C42aDF9a3D4aE17e1", "name": "in reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "2afF62cC8f22a7fdDdeD7d78", "name": "dolor occaecat fugiat", "description": "A user-defined object to help group documents." }, { "_id": "3cc2c490c852bee9424a92eA", "name": "sed in fugiat quis laboris", "description": "A user-defined object to help group documents." }, { "_id": "ad3A1A5BAcdD36e923BaC484", "name": "labore nulla proident", "description": "A user-defined object to help group documents." } ] }, { "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": "2A2c0E4b43Ef44AEE8F6B4EA", "createdBy": "efAE170cc1C6fbc604b8dedB", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "11725c3ca01aFfFEee8a828C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "46DC7D793dA43BeEbFa9f70d", "name": "ullamco", "description": "A user-defined object to help group documents." }, { "_id": "88f85cCF15c8C456E85C2339", "name": "veniam aliqua eu voluptate laborum", "description": "A user-defined object to help group documents." }, { "_id": "a376F5CcBcBfE1f884f09cb5", "name": "tempor quis", "description": "A user-defined object to help group documents." }, { "_id": "7Fd375Fc83fE1F9a8c42959d", "name": "ea pariatur laborum", "description": "A user-defined object to help group documents." } ] }, { "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": "7fe57F0E93FEacc9e0C1CBD4", "createdBy": "5565a61A754c056e0175bA9D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7F75A13e07B0baFA220B0b9C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3eF2657DB5fB3CC84FaBC8aE", "name": "commodo", "description": "A user-defined object to help group documents." }, { "_id": "C4a0a1a201fBBDA566887Dce", "name": "quis ipsum", "description": "A user-defined object to help group documents." } ] }, { "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": "692899ceCaaf6EA4495Ab6e2", "createdBy": "b6a3C0688ADfbd9Cedfb82fb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1AdcDe73d88aA1cc48F784e8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3F7482AB56acf50e974407DB", "name": "fugiat commodo do consectetur", "description": "A user-defined object to help group documents." } ] }, { "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": "CBc730380b0E51C8D142d5D7", "createdBy": "d6bc2F31E033EE8DF62106b0", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8E03355dcdD8D4bc5e417fb7", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "C0247180d2e43d0D0c910ECE", "name": "ullamco est nostrud dolor", "description": "A user-defined object to help group documents." }, { "_id": "ce43d186B8dd4AA5c2EdfdB9", "name": "amet nulla", "description": "A user-defined object to help group documents." }, { "_id": "4aAfFB91F6Eeb4a6Ce7e54Be", "name": "eu in velit", "description": "A user-defined object to help group documents." } ] } ], "total": 90624135, "start": 71023759, "end": -89635888, "count": -98750847, "next": "minim ullamco Ut", "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." } } }