Jump to

• Request
• Response

Update message status to error

post

/fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/action/updateOrderStatus

Updates the status of a message to Error when import of a sales order ends in error.

Request

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

• BuyingPartyId: string
  Value that identifies the buying partner identifier associated with the message to be updated.
• CompletionStatus: string
  Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.
• HeaderId: string
  Value that identifies the header identifier of the sales order associated with the message to be updated.
• messages: array messages
  Details of the error message that occurred during the import of the sales order.
• OrderNumber: string
  Value that identifies the sales order number associated with the message to be updated.
• RequestedOperationMode: string
  Value that identifies whether the sales order import operation is New, Modify, or Cancel.
• SourceTransactionId: string
  Value that identifies the source transaction identifier associated with the message to be updated.
• SourceTransactionNumber: string
  Value that identifies the source transaction number associated with the message to be updated.
• SourceTransactionSystem: string
  Value that identifies the source transaction system associated with the message to be updated.

{
    "type":"object",
    "properties":{
        "RequestedOperationMode":{
            "type":"string",
            "description":"Value that identifies whether the sales order import operation is New, Modify, or Cancel.",
            "nullable":true
        },
        "BuyingPartyId":{
            "type":"string",
            "description":"Value that identifies the buying partner identifier associated with the message to be updated.",
            "nullable":true
        },
        "SourceTransactionSystem":{
            "type":"string",
            "description":"Value that identifies the source transaction system associated with the message to be updated.",
            "nullable":true
        },
        "CompletionStatus":{
            "type":"string",
            "description":"Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.",
            "nullable":true
        },
        "HeaderId":{
            "type":"string",
            "description":"Value that identifies the header identifier of the sales order associated with the message to be updated.",
            "nullable":true
        },
        "SourceTransactionId":{
            "type":"string",
            "description":"Value that identifies the source transaction identifier associated with the message to be updated.",
            "nullable":true
        },
        "messages":{
            "type":"array",
            "description":"Details of the error message that occurred during the import of the sales order.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "OrderNumber":{
            "type":"string",
            "description":"Value that identifies the sales order number associated with the message to be updated.",
            "nullable":true
        },
        "SourceTransactionNumber":{
            "type":"string",
            "description":"Value that identifies the source transaction number associated with the message to be updated.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : messages

Type: array

Details of the error message that occurred during the import of the sales order.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Details of the error message that occurred during the import of the sales order.",
    "nullable":true,
    "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

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
  Returns the status of the update operation as success or failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns the status of the update operation as success or failure."
        }
    },
    "additionalProperties":false
}

Back to Top