Summary
Replaces a workflow test document for a workflow.
Description
Replaces a workflow test document for a workflow.
Route
PUT /automation-studio/:workflowId/tests/:id
Roles
admin
apiwrite
designer
Parameters
Details Example Schema
Name
Type
Required
Description
workflowId
string
yes
ObjectId specifying a workflow entity.
id
string
yes
Workflow test id.
update
object
yes
Complete workflow test definition to replace the existing workflow test document with. May not contain fields '_id', 'workflowId', 'created', 'createdBy', 'lastUpdated', or 'lastUpdatedBy'.
Copied to Clipboard
{
"update": {
"name": "test",
"underrides": [],
"workflowId": "laboris"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"update": {
"title": "update",
"description": "Complete workflow test definition to replace the existing workflow test document with. May not contain fields '_id', 'workflowId, 'created', 'createdBy', 'lastUpdated', or 'lastUpdatedBy'.",
"$ref": "workflowTestUpdate"
}
},
"required": [
"update"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
response
object
Response object.
Copied to Clipboard
{
"updated": {
"name": "test",
"underrides": [],
"_id": "6cdF3DEcE4CC1FC3Ca9a1AF7",
"workflowId": "tempor ex velit culpa",
"createdBy": "2133ac45ccA175E4cB1ddBF5",
"created": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": "6bAF84426b8A228375FEdfa9",
"lastUpdated": "2019-11-25T22:51:39.201Z",
"version": 1,
"pkgVersion": "3.40.3"
},
"edit": "eiusmod anim"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"updated": {
"description": "Workflow test document after applying the update.",
"$ref": "workflowTest"
},
"edit": {
"type": "string",
"description": "URI to the edit page for the updated workflow test."
}
},
"required": [
"updated",
"edit"
]
}
