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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "sit", "not-in": "ea est", "equals": "Lorem eiusmod dolor ex laborum", "contains": "aute sed proident incididunt esse", "starts-with": "officia ea elit consectetur Lorem", "ends-with": "minim incididunt Excepteur voluptate aute" } }
{ "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": "DB9820529A1BbAFC83bedcba", "createdBy": "2067d16A6c5bf409e2C6fDFE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "79Dc8aE039258De338e4BeA1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "BF57ea25e085D2e0CbeaE0e7", "name": "magna consectetur Duis" }, { "_id": "BC8Ded905f599858dDDB8b0D", "name": "aliqua" }, { "_id": "CABeDdAb44c818C099F4cfe4", "name": "laborum sed in exercitation ea" }, { "_id": "Bbe8Fbf74E4Cd8ccDbFcBB5F", "name": "in fugiat cupidatat" }, { "_id": "9F6790BAf50e982aBeaebcF3", "name": "ad est Ut adipisicing esse" } ] }, { "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": "f2BE0ffa70A0e72B836DAbE0", "createdBy": "17D2F4420d1d51Bc384FcE40", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "90afCc6bc7E6dBDb5fFeaca5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "a3a6Bc1C4931109BEeDFD0ba", "name": "Ut" }, { "_id": "26011759a2ACf17CBBDCb9Cb", "name": "ea" }, { "_id": "cdCeD27FDBC57eE986884371", "name": "laboris nulla ut" }, { "_id": "a8A314A014C1ED48cB7aA045", "name": "magna velit" }, { "_id": "Dce00EFAfaF5c7dCDd4C6BCa", "name": "proident" } ] }, { "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": "f8bddeABbdDF4c38FC058aed", "createdBy": "a4eCE8EAB25dcf1fEB43cc0F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "FCAB0D454ea97C2950aAadb5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c9Bed6bdBeeFBe45FBaAC1EE", "name": "occaecat voluptate sunt velit qui" }, { "_id": "Ec4A520EdcD1d680813E3C1C", "name": "quis dolor occaecat" }, { "_id": "B67F9C82CBca2eaB2A6Eb751", "name": "dolor exercitation Excepteur ea ex" }, { "_id": "C2fDF9B7dcAE1b1EB3E864bC", "name": "consequat nisi laboris in deserunt" }, { "_id": "6dc2cEd9aBdACc50dFFf57FC", "name": "enim cillum ipsum adipisicing eu" } ] }, { "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": "41FC54Ba244a9Ed4B1c7a9BD", "createdBy": "fE2fEBc49eAf75BB24fF2bdd", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ce79F1cB8f985fCCE1CC433E", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d9CAE3ca5E6A77226947BAc8", "name": "irure proident" }, { "_id": "cc3eEC704ee20d1FCE82eFaD", "name": "velit incididunt esse dolor" }, { "_id": "0738a1fE170659A3beb3DdcC", "name": "mollit sed culpa" } ] }, { "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": "1c2fd855eDf76FECd83Bd693", "createdBy": "fFCaac34FE48eE9D3EBE5871", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "790beffAB30AD0544f4d81b1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "5B2bE66b395D988B41fDbC24", "name": "ipsum Lorem fugiat laboris pariatur" }, { "_id": "aeeB9Ba7ed2df847F6FdE5A5", "name": "dolore" }, { "_id": "F0F99aacE2047cb1e7ca4D5d", "name": "do sint eu id" }, { "_id": "C1dcecf5a12a4efcE6Bf56CA", "name": "aliqua magna do consequat" } ] } ], "total": 9541358, "start": -4844967, "end": 18919067, "count": -62300979, "next": "cillum ut est occaecat ad", "previous": "est reprehenderit" }
{ "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" } ] } } }