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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : b2bMessageTransactions-item-response
Type:
Show Source
object
-
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 identifes the change order. -
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. -
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. -
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 are Object Retrieval and Outbound Processing. -
ExternalPartnerId: integer
(int64)
Value that uniquely identifies the external partner. It is a primary key that the application generates.
-
FlowId: integer
(int64)
Value that uniquely identifies the business flow instance in the SOA infrastructure.
-
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.
-
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. -
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. -
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. -
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. -
RetryCount: integer
(int32)
Number of attempts made to deliver the message transaction.
-
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. -
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.
-
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
Error: string
Maximum Length:
2048
Text of the error message that occurred during message transaction. -
ErrorType: string
Maximum Length:
100
Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : b2bMessageTransactions-receiptConfirmations-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- deliveryAttempts
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/{MessageGUID}/child/deliveryAttemptsParameters:
- 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. - MessageGUID:
- receiptConfirmations
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/{MessageGUID}/child/receiptConfirmationsParameters:
- 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. - MessageGUID:
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" } ] }