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,description", "in": "proident laborum", "not-in": "deserunt cillum aliquip eu", "equals": "reprehenderit consequat", "contains": "in", "starts-with": "adipisicing", "ends-with": "aliqua irure amet ad reprehenderit" } }
{ "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": "5b01BA08e8Db494d1Cefd268", "namespace": { "type": "project", "name": "sit proident dolore", "accessControl": { "read": [ "fugiat incididunt", "ut", "adipisicing esse" ], "write": [ "fugiat aute ad labore cillum" ], "execute": [ "esse consectetur in commodo eu", "irure veniam in", "consequat dolor Duis veniam eu", "laboris laborum aliquip", "amet cillum cupidatat" ], "manage": [ "et", "non anim", "labore laborum est do Excepteur", "velit" ] } }, "createdBy": "3dD5E1eecCE38FBDb887Ba43", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c50bFEE3aFA8b67Da6f7Dfd0", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Bea2Bd1E35cC43f73BeeCAa0", "name": "proident ullamco aute" }, { "_id": "0EFA1ee9EB523dfd3037b034", "name": "consequat exercitation ullamco in reprehenderit" }, { "_id": "2D4FacbC51bcdbFc99880dbF", "name": "fugiat id et dolore" }, { "_id": "f5C112d27E94AfA1EbaEba6c", "name": "irure nostrud" }, { "_id": "fB70A7dcfbFcC0fDF9A9FFc5", "name": "aliquip" } ] }, { "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": "Ca0A55c4B8d928f3A2efec01", "namespace": { "type": "project", "name": "eiusmod id", "accessControl": { "read": [ "officia cupidatat labore amet", "in aute enim sint", "labore velit est do" ], "write": [ "fugiat" ], "execute": [ "dolor", "tempor officia", "aute incididunt dolor dolor", "quis consectetur" ], "manage": [ "non nulla ad aute adipisicing", "occaecat" ] } }, "createdBy": "06B1d0C6dF2D4eA4F6b3ecea", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B00Bcb6Dbf9FdCB3bAC2eECD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "67D81B2E71aF3832FdD44509", "name": "nulla" }, { "_id": "70B5E5940dccFfFB6ef44F49", "name": "elit anim" }, { "_id": "dd6eafdeAc933AA0EBcEC4bB", "name": "aute Excepteur" } ] }, { "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": "e540Bfef0cC01C0B1319FaCf", "namespace": { "type": "project", "name": "id dolor reprehenderit in adipisicing", "accessControl": { "read": [ "labore occaecat cillum", "eu Lorem sit Excepteur ut", "cillum consectetur tempor anim elit", "exercitation consequat dolor dolore non" ], "write": [ "amet commodo incididunt", "nisi ullamco laboris", "minim nostrud ut sunt tempor", "nostrud", "eiusmod incididunt ut magna" ], "execute": [ "et", "culpa dolore Lorem fugiat pariatur", "exercitation dolor proident", "aliqua eiusmod" ], "manage": [ "voluptate cillum quis Ut irure" ] } }, "createdBy": "d3dBD9624dbebC98ebCf8a5c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "406EE85B821fcFd8878EF860", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "aCFa5Dd4aadE80Ba8D2abAa9", "name": "anim ea" }, { "_id": "45f97fbbB5B0e9AfEfDe8fc7", "name": "enim in exercitation" }, { "_id": "21bA41620625BAfc8da47abb", "name": "enim dolore tempor est consequat" }, { "_id": "aBEe4D279Ff9fb1AFeac61F9", "name": "Duis nisi id do laboris" }, { "_id": "39264F406cA6Cab2D185bDCF", "name": "amet in" } ] } ], "total": -6033035, "start": 49920155, "end": -2202589, "count": 76439718, "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" } ] } } }