POST /osImages/customSettings
Use this method to validate the JSON scheme in a custom configuration settings file. If valid, this method returns a list of custom macros that are derived from the file. If not valid, this method returns a detailed error report that includes the locations in the file that failed validation.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/osImages/customSettings
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| customConfigValues | Required | Object | JSON-formatted string that represents the custom configuration settings If valid, a list of custom macros that are derived from the custom configuration settings are returned in the customMacros response attribute. If not valid, a list of errors and locations in the schema are returned in the errorReport response attribute. | ||
The following example represents the custom configuration settings to be validated.
[{
"customConfigValues": {
"category": "dynamic",
"content": [{
"category": "dynamic",
"common": false,
"name": "server-settings",
"optional": false,
"template": [{
"category": "dynamic",
"common": false,
"content": [{
"category": "dynamic",
"choices": ["en_US","ja_JP","pt_BR"],
"common": false,
"description": "This parameter defines the OS language locale to use with this
deployment. (English, Brazilian Portuguese, Japanese) are
supported.",
"label": "OS Locale",
"name": "locale",
"optional": false,
"type": "string",
"value": "en_US"
},
{
"category": "dynamic",
"choices": ["english-us","japanese","portugese-br"],
"common": false,
"description": "This parameter defines the keyboard locale to use with this
deployment. (English, Brazilian Portuguese, Japanese) are
supported.",
"label": "Keyboard Locale",
"name": "keyboardLocale",
"optional": false,
"type": "string",
"value": "english-us"
}],
"name": "node",
"optional": false,
"type": "assoc_array"
}],
"type": "assoc_array"
}],
"description": "Custom configuration file for deployment of custom locale to OS.",
"label": "My Custom Deployment",
"name": "myCustomDeploy",
"optional": false,
"type": "array"
}
}]
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| result | String | Result of the request. This can be one of the following values.
| ||
| customMacros | Array of objects | List of custom macros that are defined for the custom configuration settings | ||
| macroName | String | Name of a custom macro that is derived from the specified JSON schema | ||
| errorReport | Array of objects | List of schema errors that were found during the validation | ||
| location | String | Location of error in the JSON schema | ||
| message | String | Detailed message about the schema error | ||
| messages | Array of objects | Information about one or more messages If the result is successful, an empty array is returned. | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
The following example is returned if the request is successful with no validation errors.
{
"result": "success",
"customMacros": [{
"macroName": ""
}],
"messages":[]
}
The following example is returned if the request is successful with validation errors.
{
"result": "success",
"errorReport": [{
"location": "",
"message": ""
}],
"messages":[]
}
The following example is returned if the request is not successful.
{
"result": "failed",
"messages": [{
"explanation": "",
"id": "FQXHMFC0004M",
"text": "An internal error occurred.",
"recovery": {
"text": "Attempt to perform the operation again. If the problem persists, contact
Support.",
"URL": ""
}
}]
}
Give documentation feedback