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": "name", "exclude": "_id", "in": "Excepteur pariatur in", "not-in": "proident aliqua aliquip Lorem", "equals": "sed proident laborum", "contains": "non consectetur et Ut", "starts-with": "laboris", "ends-with": "sed officia consequat adipisicing" } }
{ "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": "Cc7C6A1a07b00D650ecc3126", "createdBy": "3575a0b9cc5AC85D8867c7F4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "fecCCAdab52e4C2FD4E543BB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6E721fE9Db2cEBB8a1cdeEc8", "name": "non in" }, { "_id": "18422Ff7e0Da3bB1b0DBDc95", "name": "eu magna culpa eiusmod" }, { "_id": "8A069B2fFAcFff9CFbc89c91", "name": "tempor dolor do" } ] }, { "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": "2757a90CBDba2Edd9Ac6e2d1", "createdBy": "AffEdFadD183638eCED9dce8", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "FADCA29D6d4a91C3b832da24", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c54A6247dfDF5CbC06bD6e4b", "name": "occaecat ut velit Lorem esse" }, { "_id": "98cacA4FD92E673f8c5fDEf3", "name": "consectetur sed voluptate Lorem" }, { "_id": "B41814cBF7D237Cdc82eb9Db", "name": "Duis dolore cupidatat laboris sed" }, { "_id": "Cc4bbdC5EEefFd4DD48FDf43", "name": "ipsum dolore enim Duis" } ] }, { "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": "415CEE40D5B3e6D3C15e63E6", "createdBy": "1B90fE45e69922E22fa6aCA8", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "506aDC4EEeBb2E1f1Eecaac7", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "A87864dbF08DDF235B6d4f1b", "name": "ea ut mollit" }, { "_id": "73e4bF000b072afd2DEebC42", "name": "sunt" }, { "_id": "587DCd1EFB3AE3ec1060063D", "name": "exercitation" } ] }, { "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": "258b7b90b6A9E81552bcCDfd", "createdBy": "BE0CC0dfDeEd579Febd50eea", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eFAfBf3f2c7C4Ed8b60B4Ae6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1705EEc46Bb1DE6Ee21A862B", "name": "id in anim ea cupidatat" }, { "_id": "1AeAE1DBeb1EA6F6aC4AdEad", "name": "pariatur quis amet proident 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": "c2F70fe5b3d61DD3eDDee5BA", "createdBy": "9E92Cec3C8eeBcA0b05ACBD7", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "62a5a9fEebb7280dEa2CeCEC", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Aaa6A93d67DED6f1FbabD637", "name": "id ad" }, { "_id": "9cECB02aEE20DC275B344e75", "name": "culpa fugiat magna mollit est" }, { "_id": "4882c9eBfd80ea3e54dDdc9E", "name": "occaecat exercitation" }, { "_id": "BdC104DC2e9E71355Cd39Ad7", "name": "sint anim do id" } ] } ], "total": 19983353, "start": -2934482, "end": 80718205, "count": -67280049, "next": null, "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" } ] } } }