Jump to

• Request
• Response
• Examples

Recommunicate one purchase order

post

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

Recommunicates a purchase order through the Oracle Business-to-Business channel. You can send purchase orders electronically to suppliers using business-to-business messages. Sometimes, these messages aren't received or can't be processed by the supplier. In such a situation, you can use REST API to recommunicate your orders.

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

• changeOrderNumber: string
  Value that indicates the change order number to communicate. This attribute doesn't have a default value.
• forceCommunicationFlag: boolean
  Contains one of the following values: True or False. If True, then resend the purchase order that you already communicated. If False, then don't resend. The default value is False.

{
    "type":"object",
    "properties":{
        "forceCommunicationFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then resend the purchase order that you already communicated. If False, then don't resend. The default value is False.",
            "nullable":true
        },
        "changeOrderNumber":{
            "type":"string",
            "description":"Value that indicates the change order number to communicate. This attribute doesn't have a default value.",
            "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

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/purchaseOrders/purchaseOrdersUniqID"

Example Number	Description
Example 1	Recommunicate the latest purchase-order revision using the Oracle Business-to-Business channel.
Example 2	Recommunicate a given purchase-order revision using the Oracle Business-to-Business channel.

Example 1

This example describes how to recommunicate the latest purchase-order revision using the Oracle Business-to-Business channel.

Example 1 Request Body

The following example includes the contents of the request body in JSON format. This example illustrates how to recommunicate the latest revision of the purchase order. 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": "communicate",
    "parameters": [
        {
            "forceCommunicationFlag": "true"
        }
    ]
}

Example 1 Response Body

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

{
    "result": "Success"
}

Example 2

This example describes how to recommunicate a given purchase-order revision using the Oracle Business-to-Business channel.

Example 2 Request Body

The following example includes the contents of the request body in JSON format. This example illustrates how to recommunicate a specific purchase-order revision. 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.

Note:

• You must enable the option Extensible Data Model Used for Electronic Messaging profile to communicate a given purchase-order revision.
• The Document History page captures the communicate action under the change-order number for which a user initiates the recommunication using the REST API.

{
    "name": "communicate",
    "parameters": [
        {
            "forceCommunicationFlag": "true"
        },
        {
            "changeOrderNumber": "1"
        }
    ]
}

Example 2 Response Body

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

{
    "result": "Success"
}

Back to Top