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": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "_id", "in": "Lorem aute", "not-in": "magna", "equals": "ut nulla esse Excepteur", "contains": "mollit deserunt aliquip adipisicing elit", "starts-with": "proident ut adipisicing", "ends-with": "officia enim in deserunt" } }
{ "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": "A0543C7Bed0dE9B7E2DAE6fE", "namespace": { "type": "project", "name": "occaecat est ex ea labore", "accessControl": { "read": [ "cupidatat ex fugiat", "laboris sed ut", "sint minim amet adipisicing", "ut commodo Duis nisi" ], "write": [ "nulla Excepteur", "laboris Ut reprehenderit veniam", "in laboris" ], "execute": [ "cillum", "officia Excepteur magna", "qui", "incididunt exercitation" ], "manage": [ "exercitation non", "Ut consectetur" ] } }, "createdBy": "ed50EE5ae9E412E3bFfa2E5c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e4A4f4c50CAfFB549239Bf7C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2a845f81c14F77fF850Dd255", "name": "minim magna in enim qui" }, { "_id": "0B763688EFB5d62FfDa9DEB5", "name": "nostrud cillum" } ] }, { "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": "82dD10e799c46FF4c78FDc87", "namespace": { "type": "project", "name": "aliquip dolore ullamco", "accessControl": { "read": [ "reprehenderit Lorem Ut incididunt", "culpa", "velit exercitation sunt cillum Duis", "elit", "Ut pariatur" ], "write": [ "non", "esse", "ad quis exercitation officia", "culpa", "pariatur" ], "execute": [ "sunt ad cillum", "in esse", "irure ipsum ea sed", "laboris consectetur" ], "manage": [ "ex in occaecat fugiat", "proident nisi mollit", "nostrud amet est esse qui", "incididunt eu reprehenderit", "reprehenderit in anim mollit officia" ] } }, "createdBy": "DF7e5924cbDdbf1Bf04bbfee", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "D6828FAedda5B1A146B3F278", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "dDEFedE98d53a94dF4fD42dA", "name": "cillum" }, { "_id": "12FBbDaC7a57465Edb23D6fF", "name": "anim" } ] }, { "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": "aD6EdeF822BFEF00b6B80f0B", "namespace": { "type": "project", "name": "veniam ullamco anim sint", "accessControl": { "read": [ "labore cupidatat Duis", "voluptate commodo", "anim", "aliquip cillum", "minim" ], "write": [ "minim proident", "in enim nisi" ], "execute": [ "in labore esse officia sit", "amet nisi nulla" ], "manage": [ "id voluptate", "deserunt Lorem veniam ut tempor" ] } }, "createdBy": "8d87333Ae5CE7d31fAdd780e", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1a59CBaF79cED28DfDbDbbDe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "e7fD9B452CEFDd1C70D6cA6a", "name": "in sit qui consectetur" }, { "_id": "cB0d7dBDFF15ce15bD7Fce2d", "name": "velit dolor dolor" }, { "_id": "731dDF9142Cc16eDB5e4AB29", "name": "sit nulla dolore mollit" }, { "_id": "AFdA0BbeDd31BCcEeDaBf37c", "name": "ad dolor ullamco" }, { "_id": "E9FD1af0939A86E9D262Beaf", "name": "anim labore reprehenderit" } ] }, { "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": "DCAb8a53bBC0A147BaeCbF95", "namespace": { "type": "project", "name": "aliquip exercitation", "accessControl": { "read": [ "pariatur aliqua dolore Ut", "elit veniam aute cillum", "quis qui ullamco minim", "irure fugiat eiusmod" ], "write": [ "culpa aliquip", "irure", "in" ], "execute": [ "aute in", "aliqua", "fugiat anim cupidatat", "officia adipisicing proident esse" ], "manage": [ "dolore in sunt et" ] } }, "createdBy": "Fb83cEACfeE814b5AFaEC0e3", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "86fDABd8aBeC6f81FAaA7DcD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "362E7A1BccbD15b059b45986", "name": "et amet sint est ipsum" }, { "_id": "bE763a791404F0D09Ccf4665", "name": "Duis pariatur cillum" }, { "_id": "ED75fde1Cafe557ea643E198", "name": "exercitation" }, { "_id": "8df2e9a396c95F3cfE6FbFfd", "name": "ut" }, { "_id": "21E7FdE5a9Ba8C0fdE79Ea10", "name": "voluptate aute esse" } ] } ], "total": 49841164, "start": 97742722, "end": -80532358, "count": 57264370, "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" } ] } } }