Jump to

• Request
• Response

Validate a configuration

post

/fscmRestApi/resources/11.13.18.05/configurations/{ConfigurationId}/action/validate

Validates a configuration.

Request

Path Parameters

• ConfigurationId(required): string
  Value that uniquely identifies a configuration according to the ConfigHeaderId and ConfigRevisionId attributes. This value is derived by concatenating the value of ConfigHeaderId and ConfigRevisionId, and seperating them by an underscore. For example: 300100557352135_300100557352136 where ConfigHeaderId is 300100557352135 and ConfigRevisionId is 300100557352136

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• parameterId: number
  Value that uniquely identifies the initialization parameter used to validate the configuration.

{
    "type":"object",
    "properties":{
        "parameterId":{
            "type":"number",
            "description":"Value that uniquely identifies the initialization parameter used to validate the configuration.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the configuration validation is successful, then this action returns a JSON string that contains the state of configuration. If validation is not successful, then the JSON string contains the cause of the failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the configuration validation is successful, then this action returns a JSON string that contains the state of configuration. If validation is not successful, then the JSON string contains the cause of the failure."
        }
    },
    "additionalProperties":false
}

Back to Top