Jump to

• Request
• Response
• Examples

Withdraw a requisition

post

/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/{purchaseRequisitionsUniqID}/action/withdraw

Withdraws an approval of a requisition while the approval request is still in process, or when it's completed and none of the requisition lines is associated with a purchase order, transfer order, or negotiation reference, or is being modified by the buyer.

Request

Path Parameters

• purchaseRequisitionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Requisitions resource and used to uniquely identify an instance of Purchase Requisitions. The client should not generate the hash key value. Instead, the client should query on the Purchase Requisitions collection resource in order to navigate to a specific instance of Purchase Requisitions to get the hash key.

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

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 a value of SUCCESS within the object. Otherwise, this action returns a value of FAILURE.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"If the request is successful, then this action returns a value of SUCCESS within the object. Otherwise, this action returns a value of FAILURE."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"If the request is successful, then this action returns a value of SUCCESS within the object. Otherwise, this action returns a value of FAILURE."
}

If the request is successful, then this action returns a value of SUCCESS within the object. Otherwise, this action returns a value of FAILURE.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Examples

This example describes how to upload an attachment.

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/purchaseRequisitions/purchaseRequisitionsUniqID/action/withdraw"

Example Request Body

The following example includes the contents of the request body in JSON format. In this example, a file attahment is uploaded to the purchase order header successfully. 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.

{
    "name":"withdraw",
    "parameters":[]
}

Example Response Body

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

{
    "result": {
        "STATUS": [
            {
                "CODE": "SUCCESS"
            }
        ]
    }
}

Back to Top