Jump to

• Request
• Response
• Examples

Resubmit one purchase order for approval

post

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/action/submit

Resubmits a purchase order or change order for approval. Typically, your purchase orders go through an approval process and are implemented without any issues. If you encounter unexpected errors during order processing (for example, during submission check), you need to resubmit the order. You can use REST API to resubmit purchase orders in the Pending Approval status. Orders in the Pending Approval status will be automatically withdrawn before being resubmitted. Set the bypassApprovalsFlag attribute to True to bypass the approval workflow.

Request

Path Parameters

• purchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders 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

Show Source

• bypassApprovalsFlag: boolean
  Contains one of the following values: True or False. If True, then bypass the approval workflow. If False, then don't bypass it. The default value is False.

{
    "type":"object",
    "properties":{
        "bypassApprovalsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then bypass the approval workflow. If False, then don't bypass it. The default value is False.",
            "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): string
  If the request is successful, then this action returns a value of Success.

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

Back to Top

Examples

This example describes how to resubmit one purchase order for approval.

Example cURL Command

Use the following cURL command to submit a post 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/purchaseOrders/purchaseOrdersUniqID"

For example, the following command submits one purchase order for approval where POHeaderId is 100000019476400:

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

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. If you set bypassApprovalsFlag to true, manual approvals are not required when you resubmit.

{
  "name": "submit",
  "parameters": [
    {
      "bypassApprovalsFlag": "false"
    }
  ]
}

Example Response Body

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

{
    "result": "Success"
}

Back to Top