Summary
Gets a page of workflow test documents for a given workflow.
Description
Gets a page of workflow test documents for a given workflow.
Route
GET /automation-studio/:workflowId/tests
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
workflowId | string | yes | ObjectId specifying a workflow entity. |
queryParameters | object | yes | Parameters for filtering, paginating, projecting, and sorting template documents. |
{ "queryParameters": { "limit": 10, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": { "_id": "laborum", "name": "laboris id", "workflowId": "ullamco ut id eiusmod", "underrides": [], "createdBy": "mollit", "created": "ullamco", "lastUpdatedBy": "nostrud consectetur id mollit", "lastUpdated": "labore ut" }, "not-in": { "_id": "qui in", "name": "exercitation ullamco", "workflowId": "do", "underrides": [], "createdBy": "dolore", "created": "aliquip", "lastUpdatedBy": "sunt mollit officia aliqua", "lastUpdated": "Excepteur adipisicing do enim" }, "equals": { "_id": "Excepteur laborum Duis culpa", "name": "dolor ipsum cupidatat do aliqua", "workflowId": "mollit", "underrides": [], "createdBy": "tempor enim veniam consectetur", "created": "sunt", "lastUpdatedBy": "aliqua labore est laborum esse", "lastUpdated": "sunt in" }, "contains": { "_id": "cupidatat ipsum deserunt ut", "name": "minim eiusmod dolore", "workflowId": "est", "underrides": [], "createdBy": "aliquip quis commodo", "created": "Excepteur qui cillum", "lastUpdatedBy": "aliqua", "lastUpdated": "eu mollit" }, "starts-with": { "_id": "proident", "name": "consectetur", "workflowId": "veniam elit dolore fugiat", "underrides": [], "createdBy": "sit sunt aliquip", "created": "laborum enim do", "lastUpdatedBy": "exercitation voluptate deserunt", "lastUpdated": "Duis et nulla eiusmod enim" }, "ends-with": { "_id": "quis dolore aliqua", "name": "aliqua cupidatat amet sed magna", "workflowId": "culpa enim do", "underrides": [], "createdBy": "Duis irure", "created": "ipsum", "lastUpdatedBy": "ea magna laboris tempor", "lastUpdated": "do ad nostrud Duis commodo" } } }
{ "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", "$ref": "workflowTest#/definitions/searchableFields" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "$ref": "workflowTest#/definitions/searchableFields" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "$ref": "workflowTest#/definitions/searchableFields" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "$ref": "workflowTest#/definitions/searchableFields" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "$ref": "workflowTest#/definitions/searchableFields" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "$ref": "workflowTest#/definitions/searchableFields" } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "test", "underrides": [], "_id": "24Ca343768Bb99CfB4eF7E7f", "workflowId": "fugiat Lorem laborum enim id", "createdBy": "2d6f0afA028BE6c2ABDf10C8", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8E14C2De7cE66ACBB73B7aDc", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "FBfeb1efaD7f1BB64A3005b3", "workflowId": "Lorem elit", "createdBy": "f314fFD848995fbEEFfBCbbF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "97EaA7f9eBE2E81A7Dbb8b3c", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "3af85d78CFDccbFb276D2Fcd", "workflowId": "elit pariatur ad laborum", "createdBy": "9b230497Dcd1ADf4d8358eBD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "baD01e78beC8751eE3f23bCC", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "90Cea5DCD39bEEBe8bCA1EBD", "workflowId": "tempor velit ipsum sunt", "createdBy": "d0757C09Eb7CC739AB5d35cb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "C212D9CeBfBa7d3465fCec75", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" } ], "total": -65615460, "start": -41389768, "end": -92575835, "count": -43102300, "next": null, "previous": "voluptate dolor cupidatat dolore Lorem" }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "workflowTest" } }, "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." } } }