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": 1, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id", "in": "labore cillum", "not-in": "tempor", "equals": "incididunt nulla aliquip velit Excepteur", "contains": "aliqua nisi sint", "starts-with": "magna", "ends-with": "ex non fugiat culpa aliqua" } }
{ "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": "FD2bBaa5AcAD28f94a4AEE6f", "namespace": { "type": "project", "name": "ut in", "accessControl": { "read": [ "dolore aliqua reprehenderit sed aliquip", "est" ], "write": [ "velit aliquip voluptate ea commodo", "magna non", "Lorem nulla", "dolore consequat mollit labore ullamco" ], "execute": [ "officia cupidatat labore ut" ], "manage": [ "Ut Lorem quis et in", "ad anim consectetur consequat veniam", "proident occaecat", "consequat" ] } }, "createdBy": "539801cAd0Ac1f08676D5aF1", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "2cE7d3c0Fd7E5c380CBaf5Ee", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "AF8C2c6d60CDB4B5cAEAAa1e", "name": "irure ipsum dolor amet incididunt" }, { "_id": "C9f472699A5bda5559dA2888", "name": "in enim veniam" }, { "_id": "9fc49bA6fdD42D271bA8CafE", "name": "Lorem dolore" }, { "_id": "0DCDcaA6B2F1EfC36F610676", "name": "minim 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": "17f7cF41ED5C601F2CDcF79e", "namespace": { "type": "project", "name": "incididunt sint", "accessControl": { "read": [ "nulla ex tempor" ], "write": [ "irure Lorem labore fugiat", "commodo et non laborum", "anim" ], "execute": [ "sunt et tempor consequat ipsum" ], "manage": [ "irure", "qui Lorem minim nulla" ] } }, "createdBy": "BcA4ff8D23785D86fDfCd9ef", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7cE8a6fA271d5eDa467125E6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "05bb4152Fc4bfa03dB1A8e0E", "name": "culpa eu" } ] }, { "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": "16BA36Fb466C36fb4aeeeDBA", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "Duis sunt voluptate", "deserunt enim in mollit" ], "write": [ "ullamco", "ut ullamco minim occaecat", "laboris", "irure nostrud", "mollit laboris nulla qui" ], "execute": [ "sunt cillum velit id", "sunt cillum", "exercitation veniam" ], "manage": [ "sint in sunt", "et", "sed minim quis" ] } }, "createdBy": "7ea92797aeFe1efB8891f30c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "0BEDE545fA6cC3cDb1AAD1Dc", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "61af8C6ac9D6FB5f6dBC37F3", "name": "sit" }, { "_id": "74Cb28eB213CECbbea7777A4", "name": "est Lorem" } ] }, { "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": "2D7bbe67Ddc1e33c33BBDACD", "namespace": { "type": "project", "name": "ad qui cupidatat sint deserunt", "accessControl": { "read": [ "dolore Ut irure", "nisi ea in", "Ut labore consectetur", "Ut cupidatat veniam" ], "write": [ "quis ut", "proident cillum", "velit", "id eiusmod laboris", "Duis amet nulla sit mollit" ], "execute": [ "Excepteur", "aute", "adipisicing sit cillum in dolore", "elit est tempor adipisicing", "ad quis commodo velit" ], "manage": [ "ea", "consequat ut voluptate", "occaecat in Duis fugiat", "veniam nostrud Lorem Duis" ] } }, "createdBy": "cEFcfDCd4Cd6DB3DF8AEA9a4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "aC6acf13E6A9ba24CCbD6BC0", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "cEE6BA0ddDf76eDF5C7d4Eda", "name": "cupidatat ex irure in eiusmod" } ] }, { "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": "34D1176eAf51f718CA5b6EFa", "namespace": { "type": "project", "name": "labore non veniam esse fugiat", "accessControl": { "read": [ "et mollit sint dolore", "ut", "eiusmod", "in ea proident et" ], "write": [ "est incididunt tempor" ], "execute": [ "ea dolore id eu" ], "manage": [ "deserunt nulla", "adipisicing nisi qui laborum in" ] } }, "createdBy": "817eA7Ae58eA0aAcdC3D6e22", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Bc3050c262cfc065fFBEac9a", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DAff3dBA0A0b16fa9EEFE6C7", "name": "labore" }, { "_id": "e4ae916e5d57Ee3DE9Ab9afa", "name": "do" }, { "_id": "aA7AfbadCeaCf2bD84c556C4", "name": "cupidatat" } ] } ], "total": 14361737, "start": -67560014, "end": 47782613, "count": -22217322, "next": "ullamco in", "previous": "occaecat" }
{ "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" } ] } } }