Update a System Option
PATCH
system-options/{id}
Updates a system option by its ID.
Resource Information
| Method and URI | PATCH /AutodeskDM/Services/api/vault/v2/system-options/{id} |
| Authentication Context | User context required |
| Required OAuth Scopes | No scopes required |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.
The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
| Content-Type* string | Must be application/json |
* Required
Request
URI Parameters
| id string | The unique identifier of an option. |
Request
Body Structure
| value string | The new value of the system option. |
Response
HTTP Status Code Summary
| 200 OK | The system option was successfully updated. |
| 400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
| 401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
| 403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
| 404 Not Found | The requested resource was not found. |
Response
Body Structure (200)
| id string | The unique identifier of the option. |
| name string | The name of the option. |
| value string | The value of the option. |
| url string | The relative URL to access this object. |
Example
This example illustrates updating the value of a system option ‘test’.
Note: {VaultServerAddress} is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/system-options/dABlAHMAdAA_' \
-X 'PATCH' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'\
-d '{
"value": "test-value-edit"
}'
Response
{
"id": "dABlAHMAdAA_",
"name": "test",
"value": "test-value-edit",
"url": "/AutodeskDM/Services/api/vault/v2/system-options/dABlAHMAdAA_"
}