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": 0, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": { "_id": "sed dolore consequat aute minim", "name": "laborum ea cupidatat sunt tempor", "workflowId": "dolore fugiat Ut nisi anim", "underrides": [], "createdBy": "occaecat", "created": "Ut sunt", "lastUpdatedBy": "in cillum eu ipsum", "lastUpdated": "fugiat" }, "not-in": { "_id": "dolor", "name": "do culpa eiusmod fugiat", "workflowId": "ut aliquip esse", "underrides": [], "createdBy": "tempor cillum ad", "created": "irure sit", "lastUpdatedBy": "id occaecat", "lastUpdated": "cillum laborum fugiat ipsum" }, "equals": { "_id": "nulla", "name": "labore cupidatat nisi", "workflowId": "magna incididunt esse culpa laboris", "underrides": [], "createdBy": "ipsum ad irure amet", "created": "dolor mollit id velit officia", "lastUpdatedBy": "ut in dolor", "lastUpdated": "aliqua Lorem officia proident est" }, "contains": { "_id": "amet elit", "name": "est", "workflowId": "proident", "underrides": [], "createdBy": "eu magna", "created": "sunt cupidatat ex aute", "lastUpdatedBy": "in reprehenderit Duis", "lastUpdated": "irure aliquip culpa et" }, "starts-with": { "_id": "ullamco anim", "name": "cillum", "workflowId": "adipisicing", "underrides": [], "createdBy": "nostrud", "created": "ut amet Ut labore voluptate", "lastUpdatedBy": "aute amet", "lastUpdated": "Duis exercitation ut" }, "ends-with": { "_id": "pariatur", "name": "nostrud commodo", "workflowId": "dolore", "underrides": [], "createdBy": "adipisicing sit exercitation tempor ea", "created": "ullamco qui culpa proident", "lastUpdatedBy": "est ex minim nostrud ut", "lastUpdated": "occaecat minim dolor in sunt" } } }
{ "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": "E5DcCDA7CCA4f76B74EF7af8", "workflowId": "minim aliquip consectetur qui aliqua", "createdBy": "ACAD93fDddcD359ec6aaDc76", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "294EBb5Ea84a8B38bD0BfbAc", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "a3BcdebB63f5afAEEEA34aaD", "workflowId": "ullamco non incididunt consectetur", "createdBy": "4aC70057b2FA47EABFFb4D9c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "F03762126aB9AEf4E6e164bd", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" }, { "name": "test", "underrides": [], "_id": "c34e79DaF822faF62F6a7BbB", "workflowId": "fugiat aliquip do exercitation", "createdBy": "97ba4dCFDEdDce51FcF09B4a", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "7ce11eB01e0BEC8Eb21E9B0d", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "pkgVersion": "3.40.3" } ], "total": -34826622, "start": 64900277, "end": 39246767, "count": -134447, "next": null, "previous": "ea aliquip pariatur Excepteur dolore" }
{ "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." } } }