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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "tempor non", "not-in": "in deserunt ipsum veniam", "equals": "nisi", "contains": "proident", "starts-with": "commodo", "ends-with": "aute do" } }
{ "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": "0BAe98ebDE6A0f5c65BCd7eC", "namespace": { "type": "project", "name": "consequat culpa aute in", "accessControl": { "read": [ "cillum ut sit fugiat", "esse sit fugiat eiusmod cupidatat" ], "write": [ "sunt", "non ullamco", "fugiat dolor exercitation", "occaecat dolore consectetur" ], "execute": [ "Duis exercitation dolor adipisicing", "ut pariatur laborum", "eiusmod" ], "manage": [ "dolore ut", "sit", "Excepteur Lorem", "dolore ut" ] } }, "createdBy": "E3328F851D96E30AD8a50Fef", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "BAaAD4f2C4dB1Cbd8AF0C65b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DDda4aCD4AeBbEA04623aFca", "name": "laboris Excepteur sit ex" } ] }, { "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": "F2A2c6bb0C650f316bEE6Bed", "namespace": { "type": "project", "name": "Ut in labore aliqua cillum", "accessControl": { "read": [ "exercitation aute ipsum ut", "do", "est", "amet Lorem nostrud consequat laborum", "nisi officia labore" ], "write": [ "aliqua id magna" ], "execute": [ "incididunt", "adipisicing anim incididunt fugiat ut", "nostrud ex deserunt eu quis", "dolore eu nulla labore", "proident" ], "manage": [ "anim ullamco exercitation minim" ] } }, "createdBy": "F553f08687faf75C34D87CED", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B4eA5bc2CC18EfE267BdcE40", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d453cEc5E6FE9C5D71Bac88C", "name": "esse" } ] }, { "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": "2044ecfe052bf92C97Cd85A5", "namespace": { "type": "project", "name": "labore sunt qui nisi veniam", "accessControl": { "read": [ "nisi mollit velit sunt ex", "anim sint", "in cillum occaecat pariatur", "eiusmod nulla sint laborum" ], "write": [ "tempor Lorem nisi officia amet", "commodo aliquip quis do proident" ], "execute": [ "irure reprehenderit ullamco", "dolor est amet" ], "manage": [ "amet ullamco laborum eiusmod sed" ] } }, "createdBy": "dc1D0F8AEC042cb215bD6b9B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1265f9DEc4c5C8C51d4aDCF3", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "faEfeA578dd45fd3848A91Ee", "name": "culpa Ut commodo" }, { "_id": "4Df49aA8Fde4D5CdCB82E20d", "name": "occaecat cupidatat nostrud id Ut" }, { "_id": "0dFe157Fc19BC2DbAE214f97", "name": "do Lorem sit" }, { "_id": "4fdefAded9D386F1AD860a1e", "name": "minim nisi dolor" }, { "_id": "D292168Cdb966Aeb0bB19F7C", "name": "incididunt" } ] }, { "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": "551043e4388Fd6552E04FDA1", "namespace": { "type": "project", "name": "nostrud magna velit", "accessControl": { "read": [ "ex deserunt", "Lorem dolore elit aute", "Duis laboris id", "sunt aliqua", "tempor" ], "write": [ "occaecat magna consectetur", "esse reprehenderit nulla fugiat", "culpa veniam" ], "execute": [ "qui", "ullamco minim ut", "quis", "deserunt dolor eiusmod veniam consequat", "Excepteur ea" ], "manage": [ "in eu dolor", "non voluptate", "amet magna in", "commodo", "voluptate" ] } }, "createdBy": "CF2BD1fecAECd701F5df4F02", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "BDb40D2CDfbe4ceaefD4d9Eb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "345c635b98eD2ad0Cdc5bea6", "name": "officia laborum nulla veniam incididunt" } ] }, { "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": "7cAd694CeB86c40dC10c7d2A", "namespace": { "type": "project", "name": "aliquip amet sint pariatur do", "accessControl": { "read": [ "anim occaecat" ], "write": [ "ullamco cillum ut proident", "dolore culpa", "Duis" ], "execute": [ "commodo tempor laborum", "et quis", "labore est minim exercitation", "exercitation" ], "manage": [ "dolore", "cillum deserunt eu in", "culpa incididunt ut", "dolor do" ] } }, "createdBy": "be2A838f8deBAE7987A1AdA2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9b6FB861BeCcCeFD9fC8dfdb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c5de0Cb4Ec5Fb1eE34DfeFc7", "name": "nulla consectetur laboris tempor velit" } ] } ], "total": 1912499, "start": 68800996, "end": -84042876, "count": -10374218, "next": null, "previous": "ut sed ut ea Duis" }
{ "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" } ] } } }