Validate or publish a negotiation

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/action/ValidateAndPublishNegotiation

Validates the completeness and correctness of the negotiation before publishing, displaying errors or warnings for correction.

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.
Header Parameters
  • 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.
  • 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".
  • 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
Request Body - application/vnd.oracle.adf.action+json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : result
Type: object
Additional Properties Allowed
Show Source
If the request is successful, this action returns a confirmation message with a negotiation number, indicating that the negotiation was validated and published successfully.
Back to Top

Examples

This example describes how to validate or publish a negotiation.

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/supplierNegotiations/supplierNegotiationsUniqID/action/ValidateAndPublishNegotiation"

Example: Validate a Negotiation

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "ActionIntent": "Validate"
    
}

Example Response Body

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

{
    "result": {
        "ErrorsListId": null,
        "Message": "RFQ 35340 was validated. It's now ready for publishing.",
        "Negotiation": "35340",
        "Status": "SUCCESS"
    }
}

Example: Publish a Negotiation

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "ActionIntent":  "Publish"
    "IgnoreWarning": "Y"
}

Example Response Body

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

{
    "result": {
        "ErrorsListId": null,
        "Negotiation": 43653,
        "Message": "Negotiation successfully published.",
        "Status": "SUCCESS"
    }
}

Example: Validate with Errors

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "ActionIntent": "Validate"
    
}

Example Response Body

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

{
    "result": {
        "ErrorsListId": "513428",
        "Message": "RFQ 35340 was validated with errors. Resolve the errors to publish the negotiation.",
        "Negotiation": "35340",
        "Status": "ERROR"
    }
}

Example: View Error List

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

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/AuctionHeader_ID/publishNegotiationErrors?finder=RowFinderByErrorsListId;ErrorsListId=462428"

Example Response Body

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

{
    "items": [
        {
            "AuctionHeaderId": 300100634013085,
            "ErrorsListId": 1105367,
            "ErrorMessageCode": "PON_RQSTDLR_DATE_REQ_ERROR",
            "ErrorType": "ERROR",
            "ErrorMessageDisplay": "You must provide requested delivery date for line 2."
        },
        {
            "AuctionHeaderId": 300100634013085,
            "ErrorsListId": 1105367,
            "ErrorMessageCode": "PON_NO_REQ_BU_WARNING",
            "ErrorType": "WARNING",
            "ErrorMessageDisplay": "Requisitioning BU is missing for at least one line. You will be able to award the negotiation, but you won't be able to create purchasing documents."
        }
    ]
}
Back to Top