Jump to

• Request
• Response
• Examples

Withdraw and edit award approval

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/action/EditAndWithdrawAwardApproval

Withdraws and edits the award approval.

Request

Path Parameters

• AuctionHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• Action: string
  Values used to specify whether the custom action will withdraw the award approval and set the award to edit mode, or only set the award to edit mode. Possible values are WITHDRAW or EDIT_AWARD.
• Buyer: string
  Name of the buyer who has withdrawn and is editing the award decision.
• BuyerId: string
  Value that uniquely identifies the user who has withdrawn and editing the award decision.

{
    "type":"object",
    "properties":{
        "Action":{
            "type":"string",
            "description":"Values used to specify whether the custom action will withdraw the award approval and set the award to edit mode, or only set the award to edit mode. Possible values are WITHDRAW or EDIT_AWARD.",
            "nullable":true
        },
        "BuyerId":{
            "type":"string",
            "description":"Value that uniquely identifies the user who has withdrawn and editing the award decision.",
            "nullable":true
        },
        "Buyer":{
            "type":"string",
            "description":"Name of the buyer who has withdrawn and is editing the award decision.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  If the request is successful, this action returns a confirmation that the negotiation award has been withdrawn and is available for editing.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the request is successful, this action returns a confirmation that the negotiation award has been withdrawn and is available for editing."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, this action returns a confirmation that the negotiation award has been withdrawn and is available for editing."
}

If the request is successful, this action returns a confirmation that the negotiation award has been withdrawn and is available for editing.

Back to Top

Examples

This example describes how to edit and withdraw an award approval.

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/supplierNegotiationAwards/AuctionHeaderId/action/EditAndWithdrawAwardApproval"

For example:

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

Example

This example shows how to

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.

{
    "Buyer": "Clare Smith",
    "BuyerId": 300100572589892,
    "Action": "WITHDRAW"
}

Example Response Body

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

{
    "result": "SUCCESS"
}

Back to Top