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": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name,description", "exclude": "_id", "in": "ut culpa labore reprehenderit", "not-in": "esse dolore anim", "equals": "dolore cillum in occaecat", "contains": "dolore", "starts-with": "ea esse Ut", "ends-with": "est velit" } }
{ "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": "07eaDCCBDEcF65C3605c1387", "namespace": { "type": "project", "name": "ipsum", "accessControl": { "read": [ "Lorem mollit Ut laboris" ], "write": [ "do Ut" ], "execute": [ "anim", "laborum laboris aute dolore qui" ], "manage": [ "minim est ad ipsum", "culpa cillum", "labore sed" ] } }, "createdBy": "9B6aDdF3aEAB80AeEE1DfC6F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "bd0a9a162FFBfC5B3D51E41f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "efADc955F7DdFCa95b19Dd4f", "name": "ipsum nisi" }, { "_id": "EE09edB16cEbf6F2bb7EC747", "name": "et eiusmod esse fugiat" }, { "_id": "1F68601ECDbB2beA0EEAA5B7", "name": "aute dolore 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": "a56c6aAEAaA8747AFdEBaAca", "namespace": { "type": "project", "name": "fugiat irure velit", "accessControl": { "read": [ "Duis ipsum minim cillum nisi", "eiusmod elit" ], "write": [ "eu deserunt occaecat anim" ], "execute": [ "Duis culpa", "irure", "aliqua non tempor" ], "manage": [ "anim", "elit Excepteur", "sint deserunt sunt ullamco dolore" ] } }, "createdBy": "4F00B248F42c42E5F0586b84", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ff0ED89bdaf8d0efc0BaF3F8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F3Acb9AeBBb3CaE4dc5df922", "name": "nisi consectetur" }, { "_id": "D7e7936E30fa96874beDcC0d", "name": "magna Excepteur" }, { "_id": "3C61061eFA37Fe13bA5CDB5d", "name": "dolore id quis" }, { "_id": "58FAaCbA7fA9b0d0fC019744", "name": "non" }, { "_id": "02B71ecAe04cB3CaFfbB8Cb5", "name": "ut anim nulla consequat 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": "dF4e177cd2fb07aFeBAe4B46", "namespace": { "type": "project", "name": "aliquip adipisicing veniam culpa incididunt", "accessControl": { "read": [ "sint Excepteur ex sed et" ], "write": [ "Excepteur ipsum fugiat aliqua ut", "ea et", "fugiat ut tempor", "reprehenderit id magna Lorem cupidatat" ], "execute": [ "dolore", "irure Lorem qui in", "id adipisicing officia", "id" ], "manage": [ "occaecat", "enim proident irure" ] } }, "createdBy": "6446Cb5971d3fC1dfb8F8C85", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eEa5Df3e16C24AcfF4d6dCd4", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "bdC575453f9aFb0EF8e376EB", "name": "ex dolore sit Duis eu" }, { "_id": "cffDDdeEB65df89B7e73E95F", "name": "id est anim" } ] } ], "total": -72476825, "start": -60688838, "end": -72374223, "count": 5189143, "next": "laboris quis ullamco Excepteur consequat", "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" } ] } } }