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", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "amet ipsum labore occaecat", "not-in": "pariatur ad tempor in laborum", "equals": "magna dolore occaecat", "contains": "tempor Lorem occaecat", "starts-with": "ea labore sint", "ends-with": "in" } }
{ "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" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "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": "8cdF53Ecca94Ffd852e1bc9b", "namespace": { "type": "project", "name": "ut reprehenderit Duis sint", "accessControl": { "read": [ "voluptate sit ullamco Excepteur", "amet", "consectetur aliqua exercitation", "reprehenderit minim ullamco ipsum" ], "write": [ "pariatur et tempor sed aute", "sunt", "eu proident exercitation occaecat ut", "aliqua deserunt", "aliqua pariatur laboris irure" ], "execute": [ "in", "cillum qui" ], "manage": [ "nostrud occaecat tempor dolor fugiat", "eiusmod", "voluptate cupidatat in", "adipisicing exercitation velit anim fugiat" ] } }, "createdBy": "700eCEfbee9EC29c1bbeD38D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9B184dbbba32ddEfF8cace5d", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3Bc8C9Dc53fB4A7E4D27A7aF", "name": "occaecat eu" }, { "_id": "a9b2515c3b62BEc2BBC2df62", "name": "aliquip culpa id" }, { "_id": "d9D850E62Eb8D3Aecd543B1b", "name": "nisi" }, { "_id": "EEBdba0Fbac3D7a0b278dbe4", "name": "Lorem dolore" } ] }, { "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": "b70Df1629d4e13AeFecBE6ba", "namespace": { "type": "project", "name": "proident in et", "accessControl": { "read": [ "officia amet ad commodo dolor", "eiusmod sunt anim", "aliquip nisi est veniam", "amet quis sint in aliquip" ], "write": [ "proident labore", "non ipsum nisi" ], "execute": [ "ut esse", "enim", "proident Excepteur aute", "dolore voluptate quis", "sit magna" ], "manage": [ "proident in minim ex" ] } }, "createdBy": "Faee6DadAc6CF9cdb67c10B2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "FB8bF2fDAfafc9BE99c4cD49", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "ec65C0c43FeD3cd275cCAaF6", "name": "aliqua adipisicing Lorem" } ] }, { "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": "4ae0a640Ac8A304E5b47ceEA", "namespace": { "type": "project", "name": "eiusmod cillum consectetur ullamco", "accessControl": { "read": [ "consequat amet", "minim sunt nulla", "anim Excepteur officia minim", "incididunt" ], "write": [ "pariatur dolore", "ex laborum labore ullamco" ], "execute": [ "laborum dolore Lorem qui", "in aute ex" ], "manage": [ "pariatur commodo veniam mollit", "tempor mollit nulla sit", "sit nisi sed esse ex", "consequat veniam", "in ad minim dolor" ] } }, "createdBy": "Be0554c1d696F99fab9bb51d", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9fde2deFcf2995F69b7A65dA", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b3fdBB8FFDbdfFBEFb2eB9e1", "name": "aute" }, { "_id": "d9f1acB18D214a1FBF6435D5", "name": "mollit pariatur eiusmod elit dolor" }, { "_id": "B62FaBFE534B1ebb2A2AfC6B", "name": "sed et nostrud pariatur voluptate" } ] }, { "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": "223DAfFddd817f0f83eC3d32", "namespace": { "type": "project", "name": "culpa aute amet", "accessControl": { "read": [ "eu id", "exercitation non dolor", "occaecat labore Excepteur ullamco elit" ], "write": [ "minim", "ut laborum eiusmod occaecat laboris", "nulla consequat sit in", "fugiat in ad exercitation quis" ], "execute": [ "consectetur veniam fugiat voluptate aliqua" ], "manage": [ "sit voluptate", "ut officia nostrud qui ullamco" ] } }, "createdBy": "B1d912Fc7EbE755Ac1BC1006", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "273cc6b91CaAbAFe8D22e8c5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c603FdAE664ea56CcFB60C9D", "name": "est" }, { "_id": "0A8DB79cc23afa5Ace803e15", "name": "laborum in" }, { "_id": "FfC7A08bd46Ace5138b4E293", "name": "proident nisi magna in" } ] }, { "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": "fC3aD91Fc3Cff66DA047bBE6", "namespace": { "type": "project", "name": "nisi sunt", "accessControl": { "read": [ "Duis consectetur velit", "in irure", "commodo ea aute Ut esse", "exercitation", "incididunt eiusmod dolor occaecat" ], "write": [ "qui aliqua amet veniam aliquip", "nulla sunt est non incididunt" ], "execute": [ "amet cupidatat nulla sit Excepteur", "ut enim deserunt", "dolor mollit", "minim" ], "manage": [ "Excepteur", "elit", "in ipsum ex enim", "Duis sunt laborum", "aliquip" ] } }, "createdBy": "C8Ca3942F741C8Ca01fAfedb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "239c68851d0F2FcBaDf082Ab", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "87cA67d4C844f3DBe38F8e4d", "name": "eiusmod elit dolor cupidatat adipisicing" }, { "_id": "ACD140EaDcBF76AEEB9bC30c", "name": "fugiat consequat sed do in" } ] } ], "total": -76379652, "start": 14534047, "end": 80811487, "count": 23977753, "next": "Ut veniam cillum magna", "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" } ] } } }