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": 10, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "_id,description", "in": "Duis cillum incididunt non", "not-in": "consectetur", "equals": "do", "contains": "sint laboris in exercitation Ut", "starts-with": "anim sunt tempor ipsum", "ends-with": "sit nisi amet" } }
{ "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": "5F26C5E027616312ba65eC30", "namespace": { "type": "project", "name": "est sit", "accessControl": { "read": [ "Excepteur id", "et consequat" ], "write": [ "Duis", "proident quis nisi non", "Lorem proident", "qui" ], "execute": [ "culpa mollit sunt fugiat veniam", "nulla dolor fugiat" ], "manage": [ "Lorem fugiat in esse aliquip", "laborum", "exercitation dolor labore commodo voluptate", "qui sint commodo pariatur minim" ] } }, "createdBy": "C33bF6C8Ba68AA99e9E359c7", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "a6B08Fd4BEc7f0FAD0eB3fE5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1460cd5EBdC00DcdA1AeeCc5", "name": "veniam eu id" }, { "_id": "4DFe747cFDAF2A5a6196fB49", "name": "cupidatat laborum" }, { "_id": "bcAaAaBdDf5deAF629DF13a6", "name": "minim" }, { "_id": "f9BB491A3CF9F2AabDe82968", "name": "ea deserunt" }, { "_id": "0800a3D5C5ae5DACFBF7BFe6", "name": "est commodo" } ] }, { "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": "2A8D324a01Bb5bD16941BC8B", "namespace": { "type": "project", "name": "Ut", "accessControl": { "read": [ "adipisicing", "exercitation aute voluptate", "est consequat do aute tempor", "sit" ], "write": [ "Excepteur amet adipisicing labore" ], "execute": [ "ea cillum in non", "qui irure exercitation labore sit", "eiusmod anim", "dolore Duis aute nostrud" ], "manage": [ "ut dolore sint", "id Excepteur sunt consectetur", "laboris", "non" ] } }, "createdBy": "aee1c1656cDEfcB3eCE96795", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7ADeD2F16CeeAD3eC98cCa0d", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D8bE0cAFB746E7cc5C0A6ecA", "name": "eiusmod commodo" }, { "_id": "aaF30Fc91d0a2deBFa68bD61", "name": "ad dolore dolor officia consectetur" } ] } ], "total": 93974866, "start": -40377607, "end": -99904950, "count": -55169429, "next": null, "previous": "ut culpa id do" }
{ "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" } ] } } }