Jump to

• Request
• Response

Process a B2B message.

post

/fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/action/messageProcessing

Process A B2B message using the details provided via the AI Agent, B2B Message Format Converter

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

• documentIdentifier: string
  Value that uniquely identifies the document.
• intent: string
  Value that indicates what the user wants the Agent to process.
• messageIdentifier: string
  Value that uniquely identifies the B2B message to be converted.
• options: string

{
    "type":"object",
    "properties":{
        "documentIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the document.",
            "nullable":true
        },
        "messageIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the B2B message to be converted.",
            "nullable":true
        },
        "options":{
            "type":"string",
            "nullable":true
        },
        "intent":{
            "type":"string",
            "description":"Value that indicates what the user wants the Agent to process.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  The response summary object.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The response summary object."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The response summary object."
}

The response summary object.

Back to Top