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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "dolore", "not-in": "ipsum sit voluptate id incididunt", "equals": "pariatur in dolor", "contains": "qui commodo Ut nostrud labore", "starts-with": "deserunt non ut aliquip", "ends-with": "cupidatat proident commodo est" } }
{ "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": "21954c1901E08aAfFcf41588", "namespace": { "type": "project", "name": "dolore in aliqua voluptate", "accessControl": { "read": [ "labore est officia", "quis" ], "write": [ "velit est ad", "minim nulla eu labore fugiat", "ut esse deserunt est minim", "dolore dolor non dolor" ], "execute": [ "sunt" ], "manage": [ "Duis nulla consequat" ] } }, "createdBy": "169DE0f2Aaa03AaDFCc7f8f9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "17AaCBdc4d5d7499AFB6eD43", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "fC0613BC93cA8495c7Ebf006", "name": "quis incididunt ut" }, { "_id": "c81f69D8F5bdc3179C82dC8B", "name": "culpa" }, { "_id": "54A3C78B8c621BAdbf32b99C", "name": "elit" }, { "_id": "Ef4E48Ec3DFd78BD11bE805d", "name": "eu nisi deserunt" }, { "_id": "686C00c6D0EF5ABc5fAEEa5d", "name": "fugiat eiusmod enim" } ] }, { "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": "9B5362fd96f5C8F8Deff113c", "namespace": { "type": "project", "name": "eiusmod occaecat ea", "accessControl": { "read": [ "elit sint" ], "write": [ "in ad cillum sint", "ad proident est", "sit officia", "sunt fugiat enim" ], "execute": [ "ex sunt cillum" ], "manage": [ "ea", "aute ad culpa officia non", "irure amet nisi sed non", "consectetur ut Ut ut", "commodo consectetur mollit eiusmod in" ] } }, "createdBy": "bfBaC6dc9AcC8d3cCDf1FA68", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "0628E9eFCBAA7DEbD5A8Af44", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f3d5D8E6Cc609eF6AaC187A1", "name": "cillum dolor deserunt nulla dolore" }, { "_id": "fc2E2bAEE657c26bab5dA9e1", "name": "reprehenderit laborum et Excepteur qui" }, { "_id": "4C29d4E16c9E060FB6Aac3A3", "name": "magna veniam" }, { "_id": "9F62F57D87f5d595506537e9", "name": "labore" }, { "_id": "50c43C7f4a14BB8457cFce7c", "name": "officia labore reprehenderit consectetur in" } ] } ], "total": 59821025, "start": 22477881, "end": 54253794, "count": -9479483, "next": null, "previous": "ex labore" }
{ "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" } ] } } }