Partially update a single dimension

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

Partially updates the properties of a dimension. Only one property may be updated at a time.

Options

Path	PATCH Operations Supported
/active	replace, test
/name	replace, test
/values	replace, test

PATCH /prototype/platform/programs/{programId}/dimensions/{dimensionId}

Required OAuth Scopes

file:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
programId	path	string	true	The unique identifier of the program
dimensionId	path	string	true	The unique identifier of the dimension
body	body	JSONPatchDocument	true	A collection of patch operations to apply to the dimension. Currently only one operation may be applied at a time.

Body parameter example

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Updated Facility"
  }
]

Code Samples

curl

curl -X PATCH https://api.app.wdesk.com/prototype/platform/programs/{programId}/dimensions/{dimensionId} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http PATCH https://api.app.wdesk.com/prototype/platform/programs/{programId}/dimensions/{dimensionId} \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=PATCH "https://api.app.wdesk.com/prototype/platform/programs/{programId}/dimensions/{dimensionId}" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

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/prototype/platform/programs/{programId}/dimensions/{dimensionId}', headers = headers)

print(r.json())

Returns

200 - OK

Returns a Dimension object containing details about the updated Dimension.

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

200 Response

{
  "active": true,
  "id": "c38353ce-32bc-4ea7-852a-bf5e12b72d76",
  "name": "Updated Facility",
  "values": [
    {
      "id": "Ames, IA",
      "name": "Ames, Iowa"
    },
    {
      "id": "Portland, OR",
      "name": "Portland, Oregon"
    }
  ]
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}