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", "include": "name", "exclude": "_id", "in": "dolore nostrud", "not-in": "ut ex deserunt commodo non", "equals": "culpa ullamco do non ut", "contains": "amet consequat ea culpa", "starts-with": "esse est mollit", "ends-with": "Ut nulla anim" } }
{ "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" ] }, "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": "274e751084E1B4E6Eac0f173", "createdBy": "8417Aae55bcbbb2c9f3d2090", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E5e0ab73eAD691029ea66b0d", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "ae06547c659cE4855286Cd8a", "name": "reprehenderit deserunt", "description": "A user-defined object to help group documents." }, { "_id": "3E75A26bfd2abe851924A6D2", "name": "nisi ipsum", "description": "A user-defined object to help group documents." }, { "_id": "9d858caD6A65bEB8F012c46b", "name": "ipsum tempor", "description": "A user-defined object to help group documents." }, { "_id": "ad3ECf9FFd4E7F2E3b90b60E", "name": "consequat ad adipisicing culpa ut", "description": "A user-defined object to help group documents." }, { "_id": "19f0e10da5629A1FAB4C66e9", "name": "ad Ut occaecat eu pariatur", "description": "A user-defined object to help group documents." } ] }, { "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": "E08FFE22c7AC59fCd16aDA1C", "createdBy": "B5CCe8404BC0CFb1f20C9edd", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "da8F8dAE55D11af770Ff9F4A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "baC41B470172D7Fa812ca215", "name": "Duis mollit", "description": "A user-defined object to help group documents." }, { "_id": "Ba506cBBFeF70d7B0Ef9d10d", "name": "ullamco Excepteur dolore", "description": "A user-defined object to help group documents." }, { "_id": "Df5b218D9ECdf116225C2B7a", "name": "exercitation", "description": "A user-defined object to help group documents." }, { "_id": "33D46fAF1B4bFE714fb2006a", "name": "et anim amet", "description": "A user-defined object to help group documents." }, { "_id": "98002DadFDDf0DF7caF7e3F6", "name": "nulla officia ea laborum", "description": "A user-defined object to help group documents." } ] } ], "total": 61868445, "start": -88758444, "end": 83332890, "count": 53373837, "next": null, "previous": "officia est esse aliqua" }
{ "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": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }