Jump to

• Request
• Response
• Examples

Create one negotiation from a template

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/action/CreateNegotiationFromTemplate

Creates a draft negotiation using a negotiation template.

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

  Values used to create a negotiation using a template. Required attributes include ProcurementBU, NegotiationType, NegotiationStyle, Buyer, and NegotiationTemplate. Optional attributes include Currency and TwoStageEvaluationFlag.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Values used to create a negotiation using a template. Required attributes include ProcurementBU, NegotiationType, NegotiationStyle, Buyer, and NegotiationTemplate. Optional attributes include Currency and TwoStageEvaluationFlag.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Values used to create a negotiation using a template. Required attributes include ProcurementBU, NegotiationType, NegotiationStyle, Buyer, and NegotiationTemplate. Optional attributes include Currency and TwoStageEvaluationFlag.",
    "nullable":true
}

Values used to create a negotiation using a template. Required attributes include ProcurementBU, NegotiationType, NegotiationStyle, Buyer, and NegotiationTemplate. Optional attributes include Currency and TwoStageEvaluationFlag.

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 request is successful, then this action returns Negotiation and AuctionHeaderId of the negotiation created.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the request is successful, then this action returns Negotiation and AuctionHeaderId of the negotiation created."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, then this action returns Negotiation and AuctionHeaderId of the negotiation created."
}

If the request is successful, then this action returns Negotiation and AuctionHeaderId of the negotiation created.

Back to Top

Examples

This example describes how to create a negotiation from template.

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.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/supplierNegotiations/action/CreateNegotiationFromTemplate"

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 creates.

{
	"parameters":
	{
		"ProcurementBUId": "204",
		"ProcurementBU": "Vision Operations",
		"NegotiationTypeId": "5",
		"NegotiationType": "RFQ",
		"NegotiationStyleId": "1",
		"NegotiationStyle": "Standard Negotiation",
		"NegotiationTemplate": "Conference Room Remodel",
		"CurrencyCode": "USD",
		"Currency": "US Dollar",
		"Buyer": "Jones, Clare",
		"TwoStageEvaluationFlag": false
	}
}

Example Response Body

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

{
	"result":
	{
		"AuctionHeaderId": "300100194925050",
		"Negotiation": 40015
	}
}

Back to Top