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": 0, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "qui dolor ipsum amet", "not-in": "culpa in", "equals": "sint", "contains": "magna ullamco", "starts-with": "exercitation ut voluptate in", "ends-with": "proident reprehenderit" } }
{ "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": "DdF173edD3D319857fC85052", "createdBy": "914a1bDa872a94Ab1e8ACE28", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E4624cDF21c8B3C04EcD71Ae", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "38Fbe8c5cB681ac1fe59BE2c", "name": "eu non culpa amet", "description": "A user-defined object to help group documents." }, { "_id": "EEfB1537C5420F6cf3CCA171", "name": "incididunt nulla", "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": "1f9BB0480ae9EEC59d50BdAB", "createdBy": "77981Bc2b752B43d9Abf6B3C", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "F70AB2C67BDAbbbDBf4dCcd1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b0Ceae4fbABBEf79ab4ccdC6", "name": "deserunt fugiat id aliquip nostrud", "description": "A user-defined object to help group documents." }, { "_id": "20981Ed3BAae74ad1a0A14fC", "name": "laboris deserunt mollit", "description": "A user-defined object to help group documents." }, { "_id": "5a3CBA45aFf86Ff41f5B5a0B", "name": "elit eu", "description": "A user-defined object to help group documents." }, { "_id": "3Ead59127cFbFcc96c6AFaD8", "name": "ut Lorem", "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": "99F4d71fBc13E136C6DfAc36", "createdBy": "8398cfAE3BCBa6f4fBADa27f", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CdCB08AFFA7aDCdf0BED0DED", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "B9bcc9ED2AB0da7368d05Fa5", "name": "voluptate incididunt sint", "description": "A user-defined object to help group documents." }, { "_id": "8FC3d07a88cD3c3644c2a116", "name": "velit", "description": "A user-defined object to help group documents." }, { "_id": "2E9acD79DB05C18946Eecd28", "name": "enim non sunt ullamco in", "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": "f7CBe0feD01ceE416676c71c", "createdBy": "F9Afd721325cfFb024bc80Bc", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B2c10D68f48E80FDB1B1e41b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "EEBa5Fa7cdeEf99e15Ba10eB", "name": "et ut non aute", "description": "A user-defined object to help group documents." }, { "_id": "5a4C0Ac89Ae9dBA0FeEedECC", "name": "ut", "description": "A user-defined object to help group documents." }, { "_id": "F6A816B074FFbCbFfB59EB9C", "name": "aliqua aliquip veniam", "description": "A user-defined object to help group documents." }, { "_id": "bd8fFC82B1A98c0a3aB39Ec4", "name": "laborum", "description": "A user-defined object to help group documents." }, { "_id": "132873Ca100c5fB54F3f43b1", "name": "ipsum magna fugiat", "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": "4da86414123C6Bee04D07247", "createdBy": "E88EFbeA7f4fd53adFFffA35", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "A71DcCD8dAb77CA65e97DC6D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6518d3fD9696d6cdFDbBB765", "name": "incididunt", "description": "A user-defined object to help group documents." }, { "_id": "1CebffE4EbED99EDf57eA795", "name": "deserunt ut pariatur", "description": "A user-defined object to help group documents." }, { "_id": "EeBdc9aCB2Bb6C8D8daD5F7b", "name": "tempor sint qui", "description": "A user-defined object to help group documents." }, { "_id": "1D126F9Abae2EfeaF78d97AE", "name": "adipisicing nulla do labore ea", "description": "A user-defined object to help group documents." } ] } ], "total": 76679616, "start": 7247959, "end": 47327880, "count": -65536642, "next": "reprehenderit consequat nisi non", "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." } } }