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": false, "include": "name", "exclude": "description", "in": "sint commodo sunt", "not-in": "commodo magna esse amet", "equals": "minim ut aliqua", "contains": "officia", "starts-with": "laboris ullamco labore exercitation", "ends-with": "fugiat" } }
{ "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": "27D3ef96193f30BE8e5C3421", "namespace": { "type": "project", "name": "occaecat ullamco", "accessControl": { "read": [ "commodo", "Excepteur tempor aliqua dolore", "commodo incididunt qui", "veniam dolore" ], "write": [ "occaecat sint", "laborum cupidatat", "ut Lorem in", "consectetur" ], "execute": [ "enim quis consequat voluptate", "dolor enim", "pariatur minim", "ex cupidatat", "nisi mollit amet" ], "manage": [ "dolor proident", "cillum aliquip veniam in" ] } }, "createdBy": "4F03D96Bb2934AcAF7205bFC", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e24E7bBf7532Aaeb75D27Ebd", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D95c2d8bb9dA9abe8Aef6b23", "name": "anim ut" } ] }, { "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": "5Be2C46ECd5E749c6Ed8011B", "namespace": { "type": "project", "name": "Duis voluptate", "accessControl": { "read": [ "in adipisicing est commodo do" ], "write": [ "Ut amet", "aliqua ut culpa", "veniam", "Duis deserunt" ], "execute": [ "pariatur", "nulla officia ullamco ad tempor", "non magna Lorem proident nisi", "dolore", "sit deserunt consequat sunt" ], "manage": [ "proident", "laborum labore est", "do nulla voluptate amet" ] } }, "createdBy": "1394Cc5bEba0Daa8cCeC196F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B3868CFF5194Bb713De3B867", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "80e6aEc1b37e7E4CE8fA5fEd", "name": "aliqua ut" }, { "_id": "cdAe3FEad9E029246EbEb250", "name": "esse amet fugiat" }, { "_id": "7FAfE7B817ceDA2DE2fCa63B", "name": "id" }, { "_id": "6074BAc2Da1FC5973A6BE2B3", "name": "ad" }, { "_id": "dA2edbae19EDB41FB3456D5b", "name": "amet fugiat in" } ] }, { "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": "f2dDa052e641A4803E733ED4", "namespace": { "type": "project", "name": "ullamco esse", "accessControl": { "read": [ "ad tempor qui ullamco exercitation", "aute ex", "enim anim dolore aute esse" ], "write": [ "laboris in laborum sed", "laborum", "est", "elit et", "Ut est dolore magna officia" ], "execute": [ "occaecat" ], "manage": [ "proident in", "est", "tempor sed veniam est sint" ] } }, "createdBy": "a5dA54Dc7DfbBE7AbC861527", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9a43B3b02c78c9E48fae389b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "48C3cbE9B626CC823EdB8AfF", "name": "proident fugiat aliquip Duis" } ] } ], "total": 35386565, "start": 85642466, "end": 95956914, "count": -20636908, "next": "ut irure eu", "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" } ] } } }