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": 50, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name", "exclude": "description", "in": "elit nostrud amet occaecat dolore", "not-in": "in", "equals": "deserunt ut", "contains": "do labore quis", "starts-with": "dolore consequat magna non exercitation", "ends-with": "do culpa commodo Excepteur" } }
{ "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": "BE1bab8bed2b2d334EF5BBE9", "namespace": { "type": "project", "name": "qui nisi labore irure ad", "accessControl": { "read": [ "voluptate", "magna nostrud culpa proident Duis", "nulla sit adipisicing Ut", "adipisicing irure in in ut", "exercitation nulla ea laboris" ], "write": [ "sint" ], "execute": [ "velit tempor" ], "manage": [ "id adipisicing", "Ut sed in nulla commodo" ] } }, "createdBy": "0f2d65aB58F4fEb46cccD229", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f6fBB90e37DBc4C646A1FBBD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "FFD77d8D58dC11ca87dd60db", "name": "pariatur nulla Ut incididunt" }, { "_id": "8C19EaDF0A3AEa07AFC7DfaA", "name": "sed" }, { "_id": "bF72672dBC69bEcfEdaDD76a", "name": "Lorem amet" }, { "_id": "Eec8FB1Bc97FDCBfE6377be3", "name": "dolore enim anim dolore" } ] }, { "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": "3Fac4cfb0A6CB4DBA43FB5b1", "namespace": { "type": "project", "name": "ullamco ea", "accessControl": { "read": [ "adipisicing ad ex proident" ], "write": [ "magna esse dolor", "veniam Duis quis eiusmod incididunt", "fugiat consequat sint in labore", "ut nostrud laboris voluptate" ], "execute": [ "et voluptate Duis Excepteur", "laborum", "aliquip cillum cupidatat" ], "manage": [ "deserunt sed commodo sit culpa", "sit minim fugiat", "in", "ullamco cillum sed pariatur dolore" ] } }, "createdBy": "EB2adCad7CEeC59CED79Bfa9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e11E53c44E3D6DA969B974aB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c8bf575d8b556B458d7C8413", "name": "consectetur ad incididunt 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": "d9F3e80BE6f892B1B9e49a1F", "namespace": { "type": "project", "name": "irure elit", "accessControl": { "read": [ "nostrud cillum consequat" ], "write": [ "Lorem aute", "cillum" ], "execute": [ "pariatur", "sed cupidatat laborum eiusmod", "do ad sunt", "velit do", "quis anim ut consequat velit" ], "manage": [ "laborum exercitation" ] } }, "createdBy": "3C20FDcAE5ab2aD06CDcA5e1", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "685AE7dEDF9d2AcC6E2bC1B0", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b999e39E9f7A5Af8607183F6", "name": "officia sint" }, { "_id": "B70Ba7E3C6f0AbEf35BD598C", "name": "sit in Duis" } ] }, { "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": "4B52dd6Cda5cfF8D7DBdFf2f", "namespace": { "type": "project", "name": "laboris ut id ad velit", "accessControl": { "read": [ "eiusmod dolore", "eu tempor", "nulla ad mollit occaecat eiusmod" ], "write": [ "eiusmod in incididunt", "dolor ipsum sit cillum", "sed tempor", "ipsum ex esse", "sint exercitation sit nostrud reprehenderit" ], "execute": [ "qui nulla anim proident" ], "manage": [ "ut Excepteur fugiat", "fugiat", "enim deserunt occaecat pariatur sunt", "sit incididunt dolor Lorem in", "ut" ] } }, "createdBy": "cff3C2D9dD9F156DAAc0e3ff", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1A893CF9CF8aB71c28F6cDF7", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E2a48f0eB8efDEF2CA7C4778", "name": "fugiat Lorem eiusmod" }, { "_id": "46Df3Dd91A4Cb4AA29be473D", "name": "elit aliqua anim reprehenderit in" }, { "_id": "7476D8d32d1c2dFc1A76DebD", "name": "irure adipisicing" } ] } ], "total": -37765686, "start": -64190419, "end": -24833501, "count": 86794060, "next": "id eiusmod consectetur veniam", "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" } ] } } }