Create a system option
POST
system-options
Creates a system wide option with input name and value
Resource Information
Method and URI | POST /AutodeskDM/Services/api/vault/v2/system-options |
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 obtained via a three-legged OAuth flow. |
Content-Type* string | Must be application/json |
* Required
Request
Body Structure
name string | The name of the option. |
value string | The value of the option. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the new created system option. |
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. |
409 Conflict | Duplicate name |
Response
Body Structure (200)
id string | |
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 the creation of a system option.
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' \
-X 'POST' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'\
-d '{
"name": "test1",
"value": "test-value"
}'
Show More
Response
{
"id": "dABlAHMAdAAyAA__",
"name": "test1",
"value": "test-value",
"url": "/AutodeskDM/Services/api/vault/v2/system-options/dABlAHMAdAAyAA__"
}