Ctrl+K

Partially update a single sample

Partially update a single sample#

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 2029-01-31.

Description#

Partially updates the properties of a sample. Note: Cell values must always be strings, even if they represent a number.

Options#

Path

PATCH Operations Supported

/dataValues/<index>/value

replace

/resultValues/<index>/value

replace

PATCH /platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}

Required OAuth Scopes

graph:write

Parameters#

Parameter

In

Type

Required

Description

X-Version

header

string

false

Version of the API (2022-01-01)

testFormId

path

string

true

The unique identifier of the test form

testPhaseId

path

string

true

The unique identifier of the test phase

matrixId

path

string

true

The unique identifier of the matrix

sampleId

path

string

true

The unique identifier of the sample

body

body

JSONPatchDocument

true

A collection of patch operations to apply to the sample.

Body parameter example#

[
  {
    "op": "replace",
    "path": "/dataValues/0/value",
    "value": "22.5"
  }
]

Code Samples#

curl -X PATCH https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

http PATCH https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId} \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget --method=PATCH "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}" \
    --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.patch('https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}', headers = headers)

print(r.json())

Returns#

200 - OK#

This object represents a single row of a matrix.

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.

401 - Unauthorized#

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.

503 - Service Unavailable#

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#

{
  "dataValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
      "value": "22.5"
    },
    {
      "column": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "value": "101.20"
    }
  ],
  "id": "ce4a6c7f-15ad-445c-a76a-f457d53f667a",
  "resultValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "value": "PASS"
    }
  ]
}

{
  "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"
}