Jump to

• Request
• Response
• Examples

Validate and submit a negotiation response

post

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/action/ValidateAndSubmitNegotiationResponse

Validates and submits a negotiation response.

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• parameters: object parameters
  Additional Properties Allowed: additionalProperties

  Value used to validate and submit a response for a negotiation. Required values are Response and Response Action.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Value used to validate and submit a response for a negotiation. Required values are Response and Response Action.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Value used to validate and submit a response for a negotiation. Required values are Response and Response Action.",
    "nullable":true
}

Value used to validate and submit a response for a negotiation. Required values are Response and Response Action.

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): object result
  Additional Properties Allowed: additionalProperties

  If the action is successful, then it's response is successfully validated or submitted. If it's submitted, the response status changes from Draft to Active.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the action is successful, then it's response is successfully validated or submitted. If it's submitted, the response status changes from Draft to Active."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the action is successful, then it's response is successfully validated or submitted. If it's submitted, the response status changes from Draft to Active."
}

If the action is successful, then it's response is successfully validated or submitted. If it's submitted, the response status changes from Draft to Active.

Back to Top

Examples

These example describes how to validate and submit a negotiation response.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/action/ValidateAndSubmitNegotiationResponse"

Validate a Draft Response

This example shows you how to verify if there are any errors in the response values updated in a draft response using the Validate user-defined action.

Example Request Body

The following example includes the contents of the request body in JSON format. The request payload specifies attribute values that the command will use in the record that it updates.

{
   "parameters": {
        
                "Response": "188755",
                "ResponseAction": "Validate"                
  }
    }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "Response": "188755",
        "ResponseStatus": "Draft",
        "Negotiation": "40124",
        "NegotiationTitle": "Laptop Procurement FY23",
        "ProcurementBU": "Vision Operations",
        "Message": "Response was validated without errors"
    }
}

Submit a Draft Response

After successfully validating the response, you can submit the draft response for the negotiation using the Submit user-defined action. After the draft response is successfully submitted, the response status changes from Draft to Active.

Example Request Body

The following example includes the contents of the request body in JSON format. The request payload specifies attribute values that the command will use in the record that it updates.

{
   "parameters": {
        
                "Response": "188755",
                "ResponseAction": "Submit"                
  }
    }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "Response": "188755",
        "ResponseStatus": "Active",
        "Negotiation": "40124",
        "NegotiationTitle": "Laptop Procurement FY23",
        "ProcurementBU": "Vision Operations",
        "Message": "Response submitted successfully"
    }
}

Back to Top