Validate a Process#
Description#
Run a validation check on a Process and return any structural or configuration errors found. Returns an empty errors array if the Process is valid.
POST /processes/{processId}/validation
Required OAuth Scopes
file:read
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-04-01.processes.preview) |
processId |
path |
string |
true |
Identifier of the process |
Code Samples#
curl -X POST https://api.app.wdesk.com/processes/{processId}/validation \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-04-01.processes.preview'
http POST https://api.app.wdesk.com/processes/{processId}/validation \
X-Version:2026-04-01.processes.preview \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/processes/{processId}/validation" \
--output-document - \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-04-01.processes.preview'
import requests
headers = {
'X-Version': '2026-04-01.processes.preview',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/processes/{processId}/validation', headers = headers)
print(r.json())
Returns#
200 - Validation completed successfully#
Process validation result
400 - Invalid request#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
401 - Unauthenticated request.#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
404 - Not found#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
409 - Collision#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
429 - Too Many Requests#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
500 - Server error#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
Example Responses#
{
"errors": [
{
"code": "MISSING_REQUIRED_FIELD",
"message": "Job is missing required field: assigneeUser",
"target": "/root/children/0/job"
},
{
"code": "INVALID_DUE_DATE",
"message": "Due date must be in the future",
"target": "/dueDate"
}
]
}
{
"errors": []
}
{
"code": "invalidUser",
"documentationUrl": "http://developerdocs.example.com",
"message": "The provided user is invalid.",
"meta": {
"argumentName": "assignee",
"jobId": "job1234"
},
"target": "assignee"
}
{
"code": "Unauthorized",
"message": "Bad credentials"
}
{
"code": "403",
"message": "Forbidden"
}
{
"code": "404",
"message": "Could not find process id 51bcc3ec3d0b4aadb69659e2a7ed767b"
}
resource on the server.
{
"code": "409",
"message": "Letter is not in a status that supports submissions"
}
No example available
{
"code": "429",
"message": "Rate limit of 1000 per 60 seconds exceeded for listJobs requests. Retry request in 10 seconds."
}
No example available
This is a generic error message, meaning the server cannot provide a more specific error code.
{
"code": "500",
"message": "unknown error"
}
No example available
maintenance. This status code implies that the server is functional and understands the request, but it cannot fulfill it at the moment.
{
"code": "503",
"message": "Service Unavailable."
}
No example available