Jump to

• Request
• Response

Initiate approver checkout

post

/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/action/initiateApproverCheckout

Initiates approver checkout flow when an approver chooses to edit a requisition from a requisition approval notification. The approver checkout flow ends when the approver submits the requisition after completing the changes.

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

• approverCheckoutContext: object approverCheckoutContext
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "approverCheckoutContext":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : approverCheckoutContext

Type: object

Additional Properties Allowed

Show Source

• string

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

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): string
  If the request is successful, then this action returns a value of SUCCESS. Otherwise, this action returns a value of FAILURE.

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

Back to Top