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": 25, "skip": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": { "_id": "consectetur", "name": "qui non", "workflowId": "dolor cupidatat consequat", "underrides": [], "createdBy": "esse cillum mollit", "created": "est", "lastUpdatedBy": "aliquip Lorem laborum", "lastUpdated": "enim sed nisi" }, "not-in": { "_id": "in ullamco nisi", "name": "sunt exercitation nulla aliquip deserunt", "workflowId": "in consequat velit culpa", "underrides": [], "createdBy": "enim", "created": "laborum aliqua incididunt labore", "lastUpdatedBy": "commodo aliquip", "lastUpdated": "sed nulla commodo deserunt" }, "equals": { "_id": "ex commodo cupidatat do", "name": "aliqua deserunt in enim et", "workflowId": "sit in veniam id", "underrides": [], "createdBy": "labore ex", "created": "sint proident laboris non reprehenderit", "lastUpdatedBy": "sunt deserunt ullamco occaecat nisi", "lastUpdated": "qui et laboris ut" }, "contains": { "_id": "irure deserunt", "name": "esse dolore", "workflowId": "amet in commodo mollit ipsum", "underrides": [], "createdBy": "ut in velit aliquip ipsum", "created": "Ut consequat magna adipisicing", "lastUpdatedBy": "nulla proident eiusmod ut non", "lastUpdated": "tempor qui pariatur" }, "starts-with": { "_id": "laborum deserunt amet", "name": "qui deserunt", "workflowId": "et in quis", "underrides": [], "createdBy": "consequat dolor dolore mollit pariatur", "created": "ut sint", "lastUpdatedBy": "aute mollit Excepteur", "lastUpdated": "elit eu Ut dolor" }, "ends-with": { "_id": "Ut", "name": "officia", "workflowId": "cillum irure eu Duis", "underrides": [], "createdBy": "sit", "created": "nostrud", "lastUpdatedBy": "reprehenderit in tempor magna ea", "lastUpdated": "ex cupidatat sed ipsum ullamco" } } }
{ "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": "fdadFBA68d86FAc01eAB2FcD", "workflowId": "anim", "createdBy": "1BbEbD2F4252FCadAb2FF7f3", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c0E3bade4F40862Fc49d6FBE", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "a7792Bc0aFEe89D7f91dea8F", "workflowId": "irure deserunt qui", "createdBy": "fb526e3d7FC77F9a8c5ad35B", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "a6B0cCE13e2c9fe04F1FD224", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" } ], "total": -44224534, "start": -32004483, "end": -5313709, "count": -34677585, "next": "consectetur aliqua", "previous": "nisi dolor Ut quis" }
{ "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." } } }