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", "exclude": "_id", "in": "nostrud velit non adipisicing", "not-in": "nulla fugiat ut", "equals": "nostrud pariatur proident enim", "contains": "cupidatat incididunt aute", "starts-with": "cillum sint reprehenderit", "ends-with": "consectetur 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": "f5F152D47aDCeF31E263A248", "createdBy": "2a8B2CcfdCFf39Aa2D61c5b6", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "57be795acE2AFd72D9fC9fAA", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D4b117b1EAF20ddFb85DEca8", "name": "qui voluptate in", "description": "A user-defined object to help group documents." }, { "_id": "EfCe4bAfed05aB8Ef7e72Fd1", "name": "irure est exercitation et", "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": "73dc4f5ba2F376AD9A7cec2e", "createdBy": "9B1472C7aadF60aa6dCdCc29", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "abAccb16a8e0cBDabC5D695F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "4c1a9B1BDdebeb98811Ee42C", "name": "id consectetur", "description": "A user-defined object to help group documents." }, { "_id": "Cca4bB9Bb9A84b9c0bD1Ea08", "name": "officia", "description": "A user-defined object to help group documents." }, { "_id": "dBB9c6fE0F6aC77f79aEEFFC", "name": "ipsum sed", "description": "A user-defined object to help group documents." }, { "_id": "C8fEF97fF7a37EEc83fDECdB", "name": "voluptate aute reprehenderit sint non", "description": "A user-defined object to help group documents." }, { "_id": "2507c5fCC4b8f4DD30DfefFb", "name": "consequat nostrud do non", "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": "eBB2476b9CdAEecCE4Fdbd0E", "createdBy": "1D5b2Be1c0B2aF1b4f43B985", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9bD2EeFabE6da15E20Fe6910", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "cDD05BCfFcfc66f6CFA97d5c", "name": "eiusmod", "description": "A user-defined object to help group documents." }, { "_id": "8bAcBbF7f46d82d5eBd7C8c3", "name": "est", "description": "A user-defined object to help group documents." } ] } ], "total": 83312675, "start": 43260084, "end": 78278732, "count": -86617540, "next": "laboris do sunt velit", "previous": "deserunt voluptate sint" }
{ "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." } } }