Summary
Creates a new workflow test document for a workflow.
Description
Creates a new workflow test document for a workflow.
Route
POST /automation-studio/:workflowId/tests
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
workflowId |
string |
yes |
ObjectId specifying a workflow entity. |
workflowTest |
object |
yes |
Workflow test entity to create. |
Copied to Clipboard
{
"workflowTest": {
"name": "test",
"underrides": [],
"_id": "d7104b0d1ec2802F9Af92Dd7",
"workflowId": "esse sed",
"createdBy": "ECBD3B83d890B2db1CcEcc2f",
"created": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": "3fE39bbC34Ae8B2Cc1Cf9707",
"lastUpdated": "2019-11-25T22:51:39.201Z",
"version": 1,
"pkgVersion": "3.40.3"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflowTest": {
"title": "workflowTest",
"$ref": "workflowTest"
}
},
"required": [
"workflowTest"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Created workflow test and associated edit URI. |
Copied to Clipboard
{
"created": {
"name": "test",
"underrides": [],
"_id": "c6da58fF26800879EdeA7e09",
"workflowId": "occaecat laboris minim id sint",
"createdBy": "67e2127EF479BFF0CEDCDe57",
"created": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": "B4b95EcF7f421e8c69C01A9c",
"lastUpdated": "2019-11-25T22:51:39.201Z",
"version": 1,
"pkgVersion": "3.40.3"
},
"edit": "cillum anim consequat"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"description": "Created workflow test and associated edit URI.",
"properties": {
"created": {
"$ref": "workflowTest"
},
"edit": {
"type": "string",
"description": "URI to the edit page for the newly created template."
}
},
"required": [
"created",
"edit"
]
}