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": 50, "skip": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "velit", "not-in": "aliqua consectetur qui Duis laboris", "equals": "dolore laborum ipsum elit", "contains": "pariatur", "starts-with": "reprehenderit ea laborum ut non", "ends-with": "labore Excepteur" } }
{ "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": "910265d9d3B5Cc8aE34Bd150", "createdBy": "e56E7a89CD7601a95b06f0bE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "d974164Db7e2fbC3AFbdA7Af", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "81f04d5c4999CFEa8B1920De", "name": "voluptate aliqua" } ] }, { "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": "DeE4aA2c25A888fEf74Cfe7c", "createdBy": "3FF6dfF32ed0bcA2A252Db0c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "2AAFaDF772DbaB76286903DF", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "FFEe3BEEEAA81b2f3aA655f3", "name": "commodo culpa nisi fugiat" }, { "_id": "B2FDeD5dB7F854A8f1Fec7CF", "name": "ut amet consectetur" }, { "_id": "cDAffB179AD5faFcE9297646", "name": "eu do voluptate nostrud" }, { "_id": "b10f78c5F3Cb654Fc8BaDff0", "name": "officia fugiat et in" }, { "_id": "371f5d72fc0b8755A87db0d2", "name": "consequat irure 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": "e175EB3E4E94da57D60B4FcB", "createdBy": "6e22BA20B4dCDFbcAed9Fe69", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "95dFEb0AFa3BA5707E0EdCDd", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F6263278219F6193a5CEfd29", "name": "mollit enim" }, { "_id": "f7F28b523Ef467c743391bCf", "name": "in aliquip aliqua et" }, { "_id": "0aDdceff4BbDd6a6FA0FcBD2", "name": "occaecat cillum ea sit" } ] }, { "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": "07e1aaeBd144e6dd6c2Db7AF", "createdBy": "BB7B2BEeB81EeaFB9D4A38f9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5Bced9ba5a2d0cFD5019bbE6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b7CdFb47563c87B64136EB52", "name": "incididunt Excepteur ut" }, { "_id": "f0e91bE2d15DDF025F167b16", "name": "fugiat aute dolor" } ] } ], "total": -30186717, "start": 97845893, "end": 13342549, "count": -36375374, "next": "enim", "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": { "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" } ] } } }