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": "description", "exclude": "_id", "in": "dolore veniam in", "not-in": "sit", "equals": "adipisicing pariatur laborum", "contains": "dolore reprehenderit sunt", "starts-with": "voluptate aute", "ends-with": "Ut" } }
{ "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": "5bf5bD56E66F07b78AF4bB5f", "createdBy": "BCfcE3FDCdFAf4F2bEf833FF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "b7d8cB126f3b303edde78423", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E8C05E8c45B7DAdef7b3b3Bf", "name": "do 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": "AE999E2Ab8dD606d85f7639A", "createdBy": "8e0AFB01161AdaFEdEE3aEdb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CEEA51af5e675BA3150bfA2D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1F819B9fe074F0f15CD782BA", "name": "cupidatat anim ullamco fugiat", "description": "A user-defined object to help group documents." }, { "_id": "C5c40724697aED3DfdC2aaBA", "name": "ullamco proident cupidatat irure ad", "description": "A user-defined object to help group documents." }, { "_id": "dd20c21FB8B511aafeD78fD1", "name": "ullamco", "description": "A user-defined object to help group documents." }, { "_id": "BEd15DfE14C3c7c38a08B9d2", "name": "consectetur laboris", "description": "A user-defined object to help group documents." }, { "_id": "82deb5E23457d42a91F352f4", "name": "do", "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": "E19bEEFb8fC2F503AAc7E65c", "createdBy": "DaF1e7454ea1DDc62b02aBeD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "664e72EAea2C28D2b53b676c", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "EaDAAdC87Bb3A0a3c57Fefb3", "name": "culpa minim Ut commodo ad", "description": "A user-defined object to help group documents." }, { "_id": "a88aBbFEDEF9acFac729D17d", "name": "cillum pariatur non magna Ut", "description": "A user-defined object to help group documents." }, { "_id": "a1ce2e743EFAF39F689C50aD", "name": "Excepteur aute pariatur", "description": "A user-defined object to help group documents." }, { "_id": "fc7530bD8e42a2D04c03ecfB", "name": "in", "description": "A user-defined object to help group documents." } ] } ], "total": -51336934, "start": 74761550, "end": -81055189, "count": 38460503, "next": "ex labore pariatur", "previous": "occaecat minim nostrud Excepteur consectetur" }
{ "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." } } }