Jump to

• Request
• Response
• Examples

Get one transaction record

get

/fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/{MessageGUID}

Request

Path Parameters

• MessageGUID(required): string
  Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : b2bMessageTransactions-item-response

Type: object

Show Source

• AccessKey: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the access key of the referenced inbound fiscal document.
• AltDeliveryMethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the alternate delivery method for the message.
• AltDelMethodTypeFlag: boolean
  Maximum Length: 10

  Contains one of the following values: true or false. If true, then the messages are processed using an alternate delivery method. If false, then the messages are processed using the primary delivery method. The default value is false.
• ChangeOrder: string
  Maximum Length: 256

  Value that identifies the change order.
• CollaborationPlan: string
  Read Only: true

  Maximum Length: 255

  Provides a collaboration name or a plan scenario name.
• ConfirmationStatus: string
  Maximum Length: 100

  Value that indicates the status of the confirmation message. Valid values are Received, Required, and Not Required.
• CorrelationId: string
  Maximum Length: 64

  Value that uniquely identifies the correlation ID to be retrieved and added to processing configuration.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• CustomerAccountNumber: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the customer account.
• CustomerName: string
  Read Only: true

  Maximum Length: 255

  Name of the customer.
• CustomerNumber: string
  Read Only: true

  Maximum Length: 255

  Number that uniquely identifies the customer.
• deliveryAttempts: array Delivery Attempts
  Title: Delivery Attempts

  The Delivery Attempts resource gets the failed or error status message transactions reprocessed in Oracle Fusion Collaboration Messaging Framework. If the delivery attempt fails, the message information includes the error subtype and description.
• DeliveryMethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the delivery method for the message.
• Direction: string
  Maximum Length: 100

  Value that indicates if the collaboration document operation is for an outbound or inbound collaboration.
• DocumentDescription: string
  Read Only: true

  Maximum Length: 256

  Description of the collaboration document.
• DocumentId: integer (int64)
  Value that uniquely identifies the collaboration documents. It is a primary key that the application generates.
• DocumentName: string
  Read Only: true

  Maximum Length: 256

  Name of the collaboration document.
• DocumentOperationId: integer (int64)
  Value that uniquely identifies the collaboration document operation.
• Error: string
  Maximum Length: 2048

  Text of the message for the error that occurred during message transaction.
• ErrorDescription: string (byte)
  Read Only: true

  Value that describes the reason for the error for which the record processing failed.
• ErrorType: string
  Maximum Length: 100

  Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing.
• ExternalMessageTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the external message definition associated with the message.
• ExternalPartnerId: integer (int64)
  Value that uniquely identifies the external partner. It is a primary key that the application generates.
• FileName: string
  Maximum Length: 512

  Value that identifies the file name used in processing the message.
• FlowId: integer (int64)
  Value that uniquely identifies the business flow instance in the SOA infrastructure.
• HasEventPayloadFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the event payload has a value.
• HasResponseDocumentFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the response document has a value.
• InputDocument: string (byte)
  Value that identifies the original payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.
• InstanceCount: integer (int32)
  Value that identifies the count of records in the inbound message payload.
• InvoiceNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the invoice.
• KeyContext: string
  Maximum Length: 100

  Discriminator value that identifies the messages to be searched for in the collaboration messaging transactions log and the attributes that are used to search. Valid values include PurchaseOrderToSuppllier, InvoiceFromSupplier, and so on.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• LineCount: integer (int64)
  Total number of lines in the B2B message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageGUID: string
  Maximum Length: 64

  Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.
• MessageId: integer (int64)
  Value that uniquely identifies the collaboration message. It is a primary key that the application generates.
• MessageLogId: integer (int64)
  Value that uniquely identifies the business-to-business message transaction. It is a primary key that the application generates when it creates a message log record. This attribute is required.
• MessageLogStatus: string
  Value that identifies the current state of the message. For example, Undelivered.
• MessageName: string
  Maximum Length: 256

  Name of the collaboration message. For example, OutboundProcessPurchaseOrder.
• OrderNumber: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the purchase order.
• OutputDocument: string (byte)
  Value that identifies the transformed payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.
• PartnerKeyType: string
  Maximum Length: 100

  Value that identifies the types of application-specific partner keys. For example, Legal Entity or Supplier Site.
• PartnerMessageId: integer (int64)
  Value that uniquely identifies the trading partner message. It is a primary key that the application generates.
• PartnerMessageName: string
  Maximum Length: 256

  Name of the trading partner message.
• PayloadRetrievalReqd: string
  Maximum Length: 100

  Value that identifies whether the payload is retrieved from the application for message processing. Valid values are null, Y, or the original message GUID. Null indicates that the payload is not retrieved from the application, Y indicates that it will be retrieved, and the original message GUID indicates that the payload was retrieved and this message is a part of the message listed.
• PONumber: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the purchase order.
• PrimaryRecipientFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the log message is a primary message. If false, then the log message is not a primary message. This attribute does not have a default value.
• ProcessingCode: string
  Maximum Length: 256

  Abbreviation that identifies the acknowledgement confirmation status of the trading partner.
• ProcessingDetail: string
  Maximum Length: 3072

  Describes the acknowledgment confirmation error or warning that occurred during message processing.
• ProcessingDuration: string
  Maximum Length: 10

  Time taken to process the message.
• ProviderType: string
  Read Only: true

  Maximum Length: 30

  This will show the Lookup code for the ProviderType of Service Provider. This will used in Ui only.
• ProviderTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  This will show the lookup meaning for the provider type of service provider.
• PublicationId: string
  Maximum Length: 64

  Value that uniquely identifies the publication. This value is generated by outbound processing while publishing messages to trading partners.
• receiptConfirmations: array Message Confirmations
  Title: Message Confirmations

  The Message Confirmations resource gets the confirm business object document received from the trading partner when the outbound message is set up for the confirm business object document in Oracle Fusion Collaboration Messaging Framework.
• RepositoryFileId: string
  Maximum Length: 32

  Value that uniquely identifies the file that contains the message payload in the Oracle content repository.
• RetentionDuration: integer (int32)
  Read Only: true

  Value indicating how long the message is retained.
• RetentionDurationType: string
  Read Only: true

  Maximum Length: 100

  Value that indicates the message's retention duration type.
• RetentionEndDate: string
  Read Only: true

  Maximum Length: 255

  The date indicating the end of the message retention period.
• RetryCount: integer (int32)
  Number of attempts made to deliver the message transaction.
• Revision: string
  Read Only: true

  Maximum Length: 255

  Revision number of the purchase orders.
• SenderMessageId: string
  Maximum Length: 64

  Value that uniquely identifies the sender of the message.
• SentAttachments: integer (int64)
  Number of attachments attached to outbound message.
• SentAttachmentsList: string
  Maximum Length: 2048

  List of attachments in the application payload.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider.
• ServiceProviderName: string
  Maximum Length: 256

  Name of the service provider.
• ServiceProviderPartnerId: string
  Maximum Length: 100

  Value that identifies the service provider's partner ID from the partner properties.
• ServiceProviderPartnerIdType: string
  Maximum Length: 100

  Value that identifies the service provider's partner ID type from the partner properties.
• ShipmentNumber: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the intratransit shipment.
• SizeInputDocument: number
  Read Only: true

  Size of the input document used in message processing.
• SizeOutputDocument: number
  Read Only: true

  Size of the output document generated during message processing.
• SoldToLegalEntity: string
  Read Only: true

  Maximum Length: 255

  Legal entity (company, organization, or individual) responsible for purchasing goods or services from a supplier or vendor.
• Status: string
  Maximum Length: 100

  Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.
• StatusDate: string (date-time)
  Date when the collaboration message log was created. The value must be in the ISO8601 format.
• SublineCount: integer (int64)
  Total number of sub lines in the B2B message.
• SupplierName: string
  Read Only: true

  Maximum Length: 255

  Name of supplier.
• SupplierNumber: string
  Read Only: true

  Maximum Length: 255

  Number that uniquely identifies the supplier.
• SupplierSiteName: string
  Read Only: true

  Maximum Length: 255

  Name of a supplier site.
• TestFlag: boolean
  Maximum Length: 10

  Contains one of the following values: true or false. If true, then this is a test message. If false, then this is not a test message. This attribute does not have a default value.
• TotalAttachments: integer (int64)
  Total number of attachments in the application payload.
• TradingPartnerId: string
  Maximum Length: 100

  Value that uniquely identifies the trading partner. It is a primary key that the application generates.
• TradingPartnerIdType: string
  Maximum Length: 100

  Value that identifies the type of trading partner. For example, DUNS.
• TransactionNumber: string
  Read Only: true

  Maximum Length: 255

  Cash receipt number of the cash receipt.
• UserDefinedServiceProvider: string
  Read Only: true

  Maximum Length: 1

  Default Value: Y

  Flag to Show the Service Provider is user defined or not
• Version: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the version of the purchase order.

{
    "type":"object",
    "properties":{
        "AccessKey":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the access key of the referenced inbound fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltDelMethodTypeFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the messages are processed using an alternate delivery method. If false, then the messages are processed using the primary delivery method. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AltDeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate delivery method for the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrder":{
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationPlan":{
            "maxLength":255,
            "type":"string",
            "description":"Provides a collaboration name or a plan scenario name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfirmationStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the status of the confirmation message. Valid values are Received, Required, and Not Required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CorrelationId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the correlation ID to be retrieved and added to processing configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delivery method for the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Direction":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates if the collaboration document operation is for an outbound or inbound collaboration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the collaboration document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration documents. It is a primary key that the application generates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the collaboration document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Error":{
            "maxLength":2048,
            "type":"string",
            "description":"Text of the message for the error that occurred during message transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ErrorDescription":{
            "type":"string",
            "description":"Value that describes the reason for the error for which the record processing failed.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external message definition associated with the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external partner. It is a primary key that the application generates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FileName":{
            "maxLength":512,
            "type":"string",
            "description":"Value that identifies the file name used in processing the message.",
            "nullable":true,
            "x-queryable":true
        },
        "FlowId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business flow instance in the SOA infrastructure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":38
            },
            "x-queryable":true
        },
        "HasEventPayloadFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the event payload has a value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HasResponseDocumentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the response document has a value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InputDocument":{
            "type":"string",
            "description":"Value that identifies the original payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InstanceCount":{
            "type":"integer",
            "description":"Value that identifies the count of records in the inbound message payload.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyContext":{
            "maxLength":100,
            "type":"string",
            "description":"Discriminator value that identifies the messages to be searched for in the collaboration messaging transactions log and the attributes that are used to search. Valid values include PurchaseOrderToSuppllier, InvoiceFromSupplier, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineCount":{
            "type":"integer",
            "description":"Total number of lines in the B2B message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageGUID":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. It is a primary key that the application generates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageLogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business-to-business message transaction. It is a primary key that the application generates when it creates a message log record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageLogStatus":{
            "type":"string",
            "description":"Value that identifies the current state of the message. For example, Undelivered.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the collaboration message. For example, OutboundProcessPurchaseOrder.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputDocument":{
            "type":"string",
            "description":"Value that identifies the transformed payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PONumber":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the types of application-specific partner keys. For example, Legal Entity or Supplier Site.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner message. It is a primary key that the application generates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerMessageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the trading partner message.",
            "nullable":true,
            "x-queryable":true
        },
        "PayloadRetrievalReqd":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies whether the payload is retrieved from the application for message processing. Valid values are null, Y, or the original message GUID. Null indicates that the payload is not retrieved from the application, Y indicates that it will be retrieved, and the original message GUID indicates that the payload was retrieved and this message is a part of the message listed.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryRecipientFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the log message is a primary message. If false, then the log message is not a primary message. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingCode":{
            "maxLength":256,
            "type":"string",
            "description":"Abbreviation that identifies the acknowledgement confirmation status of the trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingDetail":{
            "maxLength":3072,
            "type":"string",
            "description":"Describes the acknowledgment confirmation error or warning that occurred during message processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingDuration":{
            "maxLength":10,
            "type":"string",
            "description":"Time taken to process the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderType":{
            "maxLength":30,
            "type":"string",
            "description":"This will show the Lookup code for the ProviderType of Service Provider. This will used in Ui only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProviderTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"This will show the lookup meaning for the provider type of service provider.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublicationId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the publication. This value is generated by outbound processing while publishing messages to trading partners.",
            "nullable":true,
            "x-queryable":true
        },
        "RepositoryFileId":{
            "maxLength":32,
            "type":"string",
            "description":"Value that uniquely identifies the file that contains the message payload in the Oracle content repository.",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDuration":{
            "type":"integer",
            "description":"Value indicating how long the message is retained.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "RetentionDurationType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the message's retention duration type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetentionEndDate":{
            "maxLength":255,
            "type":"string",
            "description":"The date indicating the end of the message retention period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetryCount":{
            "type":"integer",
            "description":"Number of attempts made to deliver the message transaction.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":255,
            "type":"string",
            "description":"Revision number of the purchase orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderMessageId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the sender of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "SentAttachments":{
            "type":"integer",
            "description":"Number of attachments attached to outbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SentAttachmentsList":{
            "maxLength":2048,
            "type":"string",
            "description":"List of attachments in the application payload.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProviderName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the service provider.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceProviderPartnerId":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the service provider's partner ID from the partner properties.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceProviderPartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the service provider's partner ID type from the partner properties.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the intratransit shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SizeInputDocument":{
            "type":"number",
            "description":"Size of the input document used in message processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SizeOutputDocument":{
            "type":"number",
            "description":"Size of the output document generated during message processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SoldToLegalEntity":{
            "maxLength":255,
            "type":"string",
            "description":"Legal entity (company, organization, or individual) responsible for purchasing goods or services from a supplier or vendor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the collaboration message log was created. The value must be in the ISO8601 format.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SublineCount":{
            "type":"integer",
            "description":"Total number of sub lines in the B2B message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of a supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TestFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then this is a test message. If false, then this is not a test message. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAttachments":{
            "type":"integer",
            "description":"Total number of attachments in the application payload.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerId":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the trading partner. It is a primary key that the application generates.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the type of trading partner. For example, DUNS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Cash receipt number of the cash receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserDefinedServiceProvider":{
            "maxLength":1,
            "type":"string",
            "description":"Flag to Show the Service Provider is user defined or not",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":true
        },
        "Version":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the version of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "deliveryAttempts":{
            "title":"Delivery Attempts",
            "type":"array",
            "description":"The Delivery Attempts resource gets the failed or error status message transactions reprocessed in Oracle Fusion Collaboration Messaging Framework. If the delivery attempt fails, the message information includes the error subtype and description.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageTransactions-deliveryAttempts-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "receiptConfirmations":{
            "title":"Message Confirmations",
            "type":"array",
            "description":"The Message Confirmations resource gets the confirm business object document received from the trading partner when the outbound message is set up for the confirm business object document in Oracle Fusion Collaboration Messaging Framework.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageTransactions-receiptConfirmations-item-response"
            }
        }
    }
}

Nested Schema : Delivery Attempts

Type: array

Title: Delivery Attempts

The Delivery Attempts resource gets the failed or error status message transactions reprocessed in Oracle Fusion Collaboration Messaging Framework. If the delivery attempt fails, the message information includes the error subtype and description.

Show Source

• Array of: object b2bMessageTransactions-deliveryAttempts-item-response

{
    "title":"Delivery Attempts",
    "type":"array",
    "description":"The Delivery Attempts resource gets the failed or error status message transactions reprocessed in Oracle Fusion Collaboration Messaging Framework. If the delivery attempt fails, the message information includes the error subtype and description.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageTransactions-deliveryAttempts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Message Confirmations

Type: array

Title: Message Confirmations

The Message Confirmations resource gets the confirm business object document received from the trading partner when the outbound message is set up for the confirm business object document in Oracle Fusion Collaboration Messaging Framework.

Show Source

• Array of: object b2bMessageTransactions-receiptConfirmations-item-response

{
    "title":"Message Confirmations",
    "type":"array",
    "description":"The Message Confirmations resource gets the confirm business object document received from the trading partner when the outbound message is set up for the confirm business object document in Oracle Fusion Collaboration Messaging Framework.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageTransactions-receiptConfirmations-item-response"
    }
}

Nested Schema : b2bMessageTransactions-deliveryAttempts-item-response

Type: object

Show Source

• Error: string
  Maximum Length: 2048

  Text of the error message that occurred during message transaction.
• ErrorDescription: string
  Maximum Length: 3072

  Description of the error encountered in message processing.
• ErrorType: string
  Maximum Length: 100

  Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing.
• HasErrorDescriptionFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether there is a long error description for the message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongErrorDescription: string (byte)
  Additional details about the encountered error.
• MessageGUID: string
  Read Only: true

  Value that uniquely identifies the message. It is generated by outbound processing and provided by an external partner in inbound messages.
• MessageLogDetailId: integer (int64)
  Value that uniquely identifies the message log details. It is a primary key that the application generates.
• MessageLogId: integer (int64)
  Value that uniquely identifies the message log.
• ProcessingStartTime: string (date-time)
  Date and time when the processing starts.
• RetryCount: integer (int32)
  Total number of attempts the application made to deliver the message.
• ScheduledProcessId: integer (int64)
  Value that uniquely identifies the scheduled process that is used to upload data to the specific application.
• ScheduledProcessName: string
  Maximum Length: 100

  Name of the scheduled process that is used to upload data to the specific application.
• Status: string
  Maximum Length: 100

  Value that identifies the current state of the message. Valid values are Hold, Error, and Success.

{
    "type":"object",
    "properties":{
        "Error":{
            "maxLength":2048,
            "type":"string",
            "description":"Text of the error message that occurred during message transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ErrorDescription":{
            "maxLength":3072,
            "type":"string",
            "description":"Description of the error encountered in message processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HasErrorDescriptionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether there is a long error description for the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LongErrorDescription":{
            "type":"string",
            "description":"Additional details about the encountered error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MessageGUID":{
            "type":"string",
            "description":"Value that uniquely identifies the message. It is generated by outbound processing and provided by an external partner in inbound messages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLogDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the message log details. It is a primary key that the application generates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageLogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the message log.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessingStartTime":{
            "type":"string",
            "description":"Date and time when the processing starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RetryCount":{
            "type":"integer",
            "description":"Total number of attempts the application made to deliver the message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "ScheduledProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process that is used to upload data to the specific application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduledProcessName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the scheduled process that is used to upload data to the specific application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the current state of the message. Valid values are Hold, Error, and Success.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : b2bMessageTransactions-receiptConfirmations-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageGUID: string
  Maximum Length: 64

  Value that uniquely identifies the message. It is generated by outbound processing and provided by an external partner in inbound messages.
• MessageLogId: integer (int64)
  Value that uniquely identifies the collaboration message log.
• ProcessingCode: string
  Maximum Length: 256

  Abbreviation that identifies the processing of the message.
• ProcessingDetail: string
  Maximum Length: 3072

  Describes the processing of the message.
• SenderMessageId: string
  Maximum Length: 64

  Value that uniquely identifies the message sender.
• StatusDate: string (date-time)
  Date when the status of the message changed.

{
    "type":"object",
    "properties":{
        "MessageGUID":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the message. It is generated by outbound processing and provided by an external partner in inbound messages.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageLogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message log.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProcessingCode":{
            "maxLength":256,
            "type":"string",
            "description":"Abbreviation that identifies the processing of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingDetail":{
            "maxLength":3072,
            "type":"string",
            "description":"Describes the processing of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderMessageId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the message sender.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the status of the message changed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

deliveryAttempts

Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/{MessageGUID}/child/deliveryAttempts

Parameters:

• MessageGUID: $request.path.MessageGUID

The Delivery Attempts resource gets the failed or error status message transactions reprocessed in Oracle Fusion Collaboration Messaging Framework. If the delivery attempt fails, the message information includes the error subtype and description.

receiptConfirmations

Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/{MessageGUID}/child/receiptConfirmations

Parameters:

• MessageGUID: $request.path.MessageGUID

The Message Confirmations resource gets the confirm business object document received from the trading partner when the outbound message is set up for the confirm business object document in Oracle Fusion Collaboration Messaging Framework.

Back to Top

Examples

This example describes how to get one transaction record.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/MessageGUID"

For example, the following command gets one transaction record where the message GUID is OUT_19043:

curl -u username:password "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "MessageLogId" : 300100119640009,
  "MessageGUID" : "OUT_19043",
  "ServiceProviderId" : 50066,
  "ServiceProviderName" : "SEFAZ",
  "Status" : "Sent",
  "StatusDate" : "2017-07-26T11:19:20.103+00:00",
  "TestFlag" : false,
  "Error" : null,
  "ErrorType" : null,
  "MessageName" : "BR_ORA_CONFIRM_NFE_1.00_OUT",
  "MessageId" : 60078,
  "ProcessingDuration" : null,
  "RetryCount" : 0,
  "SenderMessageId" : null,
  "DocumentOperationId" : 60077,
  "ExternalPartnerId" : null,
  "TradingPartnerId" : null,
  "TradingPartnerIdType" : null,
  "PartnerMessageName" : "ORA_SZ_BR_CONFIRM_NFE_1.00_OUT",
  "PartnerMessageId" : 8031,
  "PartnerKeyType" : "ServiceProvider",
  "CorrelationId" : null,
  "ProcessingCode" : null,
  "ProcessingDetail" : null,
  "SentAttachments" : null,
  "TotalAttachments" : null,
  "SentAttachmentsList" : null,
  "DocumentId" : 60077,
  "Direction" : "Out",
  "DocumentName" : "PROCESS_BR_NFE_CONFIRMATION_OUT",
  "MessageLogStatus" : "History",
  "PublicationId" : null,
  "PrimaryRecipientFlag" : false,
  "ConfirmationStatus" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043",
    "name" : "b2bMessageTransactions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043",
    "name" : "b2bMessageTransactions",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/ErrorTypeLOV",
    "name" : "ErrorTypeLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/ConfirmationStatusLOV",
    "name" : "ConfirmationStatusLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/ErrorSubTypeLOV",
    "name" : "ErrorSubTypeLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/ProcessingStatusLOV",
    "name" : "ProcessingStatusLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/MessageDirectionLOV",
    "name" : "MessageDirectionLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/lov/ExternalPartnerIdTypeLOV",
    "name" : "ExternalPartnerIdTypeLOV",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/child/deliveryAttempts",
    "name" : "deliveryAttempts",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_19043/child/receiptConfirmations",
    "name" : "receiptConfirmations",
    "kind" : "collection"
  } ]
}

Back to Top