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": 10, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id,description", "in": "ullamco culpa tempor velit", "not-in": "in eu Excepteur consequat et", "equals": "nostrud cillum labore voluptate et", "contains": "culpa", "starts-with": "est labore dolor", "ends-with": "tempor veniam reprehenderit adipisicing 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": "9DC4c1d33B02b82bFECa12dA", "namespace": { "type": "project", "name": "nisi", "accessControl": { "read": [ "magna ad ullamco dolore in", "irure adipisicing aliqua", "ex occaecat esse quis non" ], "write": [ "laborum elit enim", "cupidatat" ], "execute": [ "fugiat Ut culpa in", "esse dolore", "nisi consectetur incididunt do", "in voluptate sed nulla" ], "manage": [ "elit", "cillum culpa", "nisi ex pariatur ad fugiat" ] } }, "createdBy": "e34e07A632b21fdfcaf0b6Bf", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "bAcbA57e86a0356ec8Bb2aDe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c5a38462c467c93Fd1c51b92", "name": "commodo ullamco" }, { "_id": "DF3AE2CcD89CdE2823c4A3Dc", "name": "consectetur est" }, { "_id": "D0CfC6d1EB6eC3DEBa1aFA98", "name": "ullamco Ut irure et" }, { "_id": "a30a3EeD76cb7C6634fffce3", "name": "incididunt et nisi" } ] }, { "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": "AC2ABD75D3f8dc4DD2de5F03", "namespace": { "type": "project", "name": "ut commodo et magna", "accessControl": { "read": [ "esse in tempor non" ], "write": [ "est dolor consequat nulla", "do incididunt commodo ad", "aliqua anim officia", "quis" ], "execute": [ "ullamco exercitation", "in amet in sint fugiat" ], "manage": [ "eu adipisicing occaecat magna", "voluptate magna quis", "fugiat ex", "nulla eu" ] } }, "createdBy": "dA1f2cc217D5b31A74b3BEca", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "D9CE3c0d9bABFa07f1C5d959", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E2A0e76Ed1F5C580CD727fDe", "name": "esse in ut sunt do" }, { "_id": "c5245DBe7fFbE5dDdCA1459b", "name": "dolor velit nostrud consectetur" } ] }, { "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": "cCaac123DaC8fFEe943Dbe20", "namespace": { "type": "project", "name": "et voluptate Ut", "accessControl": { "read": [ "aliquip anim", "cillum ullamco reprehenderit", "in id laborum consequat", "dolore culpa sit" ], "write": [ "esse dolor commodo", "commodo" ], "execute": [ "elit laborum", "aliqua", "quis occaecat eu", "nulla reprehenderit Duis dolore", "ut" ], "manage": [ "ipsum nisi veniam nostrud id" ] } }, "createdBy": "90CB8e355F46b7CCe5Fc787B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "dFa0134b4CFE5dD326433eDb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "aeDd4Ad138cA6eCdEC5c0BFD", "name": "ipsum adipisicing Ut nisi" }, { "_id": "c4Ea183Bfa421513dcB9bcAc", "name": "nisi Duis amet ad" }, { "_id": "1825b8899d6e16AD5C953beE", "name": "deserunt enim" }, { "_id": "fC9d486F4eEeBD6F9Fd3e3fb", "name": "eiusmod laborum non pariatur adipisicing" } ] } ], "total": -18105957, "start": -98868559, "end": 35620612, "count": 91183170, "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" } ] } } }