1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. B2B Message Transactions

Get one transaction record

get

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

Request

Path Parameters
  • Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
  • 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.
  • Maximum Length: 256
    Value that identifes the change order.
  • Maximum Length: 100
    Value that indicates the status of the confirmation message. Valid values are Received, Required, and Not Required.
  • Maximum Length: 64
    Value that uniquely identifies the correlation ID to be retrieved and added to processing configuration.
  • Read Only: true
    Date when the record was created.
  • 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.
  • Maximum Length: 100
    Value that indicates if the collaboration document operation is for an outbound or inbound collaboration.
  • Read Only: true
    Maximum Length: 256
    Description of the collaboration document.
  • Value that uniquely identifies the collaboration documents. It is a primary key that the application generates.
  • Read Only: true
    Maximum Length: 256
    Name of the collaboration document.
  • Value that uniquely identifies the collaboration document operation.
  • Maximum Length: 2048
    Text of the message for the error that occurred during message transaction.
  • Read Only: true
    Value that describes the reason for the error for which the record processing failed.
  • Maximum Length: 100
    Value that identifies the type of error. Valid values are Object Retrieval and Outbound Processing.
  • Value that uniquely identifies the external partner. It is a primary key that the application generates.
  • Value that uniquely identifies the business flow instance in the SOA infrastructure.
  • Value that identifies the original payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.
  • Value that identifies the count of records in the inbound message payload.
  • 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.
  • Read Only: true
    Date when the record was last updated.
  • Total number of lines in the B2B message.
  • Links
  • Maximum Length: 64
    Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.
  • Value that uniquely identifies the collaboration message. It is a primary key that the application generates.
  • 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.
  • Value that identifies the current state of the message. For example, Undelivered.
  • Maximum Length: 256
    Name of the collaboration message. For example, OutboundProcessPurchaseOrder.
  • Value that identifies the transformed payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.
  • Maximum Length: 100
    Value that identifies the types of application-specific partner keys. For example, Legal Entity or Supplier Site.
  • Value that uniquely identifies the trading partner message. It is a primary key that the application generates.
  • Maximum Length: 256
    Name of the trading partner message.
  • 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.
  • 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.
  • Maximum Length: 256
    Abbreviation that identifies the acknowledgement confirmation status of the trading partner.
  • Maximum Length: 3072
    Describes the acknowledgment confirmation error or warning that occurred during message processing.
  • Maximum Length: 10
    Time taken to process the message.
  • Maximum Length: 64
    Value that uniquely identifies the publication. This value is generated by outbound processing while publishing messages to trading partners.
  • 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.
  • Maximum Length: 32
    Value that uniquely identifies the file that contains the message payload in the Oracle content repository.
  • Number of attempts made to deliver the message transaction.
  • Maximum Length: 64
    Value that uniquely identifies the sender of the message.
  • Number of attachments attached to outbound message.
  • Maximum Length: 2048
    List of attachments in the application payload.
  • Value that uniquely identifies the service provider.
  • Maximum Length: 256
    Name of the service provider.
  • Maximum Length: 100
    Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.
  • Date when the collaboration message log was created. The value must be in the ISO8601 format.
  • Total number of sub lines in the B2B message.
  • 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.
  • Total number of attachments in the application payload.
  • Maximum Length: 100
    Value that uniquely identifies the trading partner. It is a primary key that the application generates.
  • Maximum Length: 100
    Value that identifies the type of trading partner. For example, DUNS.
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
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
Nested Schema : b2bMessageTransactions-deliveryAttempts-item-response
Type: object
Show Source
Nested Schema : b2bMessageTransactions-receiptConfirmations-item-response
Type: object
Show Source
Links
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
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