Update samples#
Deprecated
This endpoint is deprecated and may be removed in a future release.
This endpoint was deprecated on 2026-02-12.
It is scheduled for sunset on 2027-01-31.
Description#
Updates multiple samples, with the requestBody of each specifying columns to update by their IDs. Columns not included in the request remain as-is.
POST /prototype/platform/audits/{auditId}/procedures/{procedureId}/matrices/{matrixId}/samples/update
Required OAuth Scopes
graph:write
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
false |
Version of the API (2022-01-01) |
auditId |
path |
string |
true |
The unique identifier of the audit |
procedureId |
path |
string |
true |
The unique identifier of the procedure |
matrixId |
path |
string |
true |
The unique identifier of the matrix |
body |
body |
true |
Details about the samples to update |
Body parameter example#
[
{
"dataValues": [
{
"column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
"value": "23897"
}
],
"id": "3dd42da0-3543-4e03-ac4a-2ddefebe27d6",
"resultValues": [
{
"column": "674a9283-fd03-425d-bd62-0552263699e2",
"value": "PASS"
}
]
},
{
"dataValues": [
{
"column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
"value": "9125"
}
],
"id": "4ee53eb1-3543-4e03-ac4a-3eef0fcf38e7",
"resultValues": [
{
"column": "674a9283-fd03-425d-bd62-0552263699e2",
"value": "FAIL"
}
]
}
]
Code Samples#
curl -X POST https://api.app.wdesk.com/prototype/platform/audits/{auditId}/procedures/{procedureId}/matrices/{matrixId}/samples/update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2022-01-01'
http POST https://api.app.wdesk.com/prototype/platform/audits/{auditId}/procedures/{procedureId}/matrices/{matrixId}/samples/update \
X-Version:2022-01-01 \
Content-Type:application/json \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/prototype/platform/audits/{auditId}/procedures/{procedureId}/matrices/{matrixId}/samples/update" \
--output-document - \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2022-01-01'
import requests
headers = {
'X-Version': '2022-01-01',
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/prototype/platform/audits/{auditId}/procedures/{procedureId}/matrices/{matrixId}/samples/update', headers = headers)
print(r.headers['Location'])
Returns#
202 - Accepted#
Header |
Description |
|---|---|
Location |
The location to poll for the operation result. |
Retry-After |
The number of seconds to wait before polling for a result and between polling attempts. |
400 - Bad Request#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
403 - Forbidden#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
404 - Not Found#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
409 - Conflict#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
429 - Too Many Requests#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
500 - Internal Server Error#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Example Responses#
{
"code": "400BadRequest",
"message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
"code": "401Unauthorized",
"message": "No valid API token provided"
}
{
"code": "403Forbidden",
"message": "The API token does not have permissions to perform the request"
}
{
"code": "404NotFound",
"message": "The requested resource could not be found"
}
{
"code": "409Conflict",
"message": "The request conflicts with another request"
}
{
"code": "429TooManyRequests",
"message": "Too many requests have been made against the API in too short a time"
}
{
"code": "500InternalServerError",
"message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
"code": "503ServiceUnavailable",
"message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}