Get all transaction records
get
/fscmRestApi/resources/11.13.18.05/b2bMessageTransactions
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- MessageGUIDFinder Finds business-to-business message transactions according to the unique message GUID identifier.
Finder Variables- MessageGUID; string; Value that uniquely identifies the business-to-business message transaction. This attribute is required.
- MessageSearch Finds B2B message transactions that match the specified criteria.
Finder Variables- pDocumentId; integer; Value that uniquely identifies the document.
- pError; string; Value that uniquely identifies the type of error incurred during message processing, for example, OutboundProcessing.
- pSearchIdentifier; string; Name of the document, for example, PROCESS_PO_OUT.
- pSearchText; string; Value that identifies a document, such as PO number or invoice number. This attribute is required.
- pStatus; string; Value that identifies the status of the B2B message transaction, for example, Failed or Error.
- PrimaryKey Finds business-to-business message transactions according to the unique message transaction identifier.
Finder Variables- MessageLogId; integer; Value that uniquely identifies the business-to-business message transaction. It's a primary key that the application generates when it creates a message log record. This attribute is required.
- hcmSearchFinder Finds B2B messages that match the bindSearchInput variables.
Finder Variables- pDirection; string; Value that indicates the direction of the B2B message.
- pDocumentId; integer; Value that uniquely identifies the document associated with the B2B message.
- pEndDate; string; End date used to search for a messages.
- pError; string; Value that uniquely identifies the type of error incurred during message processing, such as OutboundProcessing.
- pErrorType; string; Value that identifies the error type of the message.
- pPartnerIdType; string; Value that identifies the type of partner ID.
- pResponseStatus; string; Value that identifies the response status of a message.
- pSPId; integer; Value that identifies the service provider.
- pSearchText; string; Values that are provided to search for B2B messages.
- pSpExtPtrnId; string; Value that uniquely identifies the service provider.
- pStartDate; string; Start date used to search for messages.
- pStatus; string; Value that identifies the status of the B2B message transaction, such as Failed or Error.
- MessageGUIDFinder Finds business-to-business message transactions according to the unique message GUID identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccessKey; string; Number that identifies the access key of the referenced inbound fiscal document.
- AltDelMethodTypeFlag; boolean; 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.
- AltDeliveryMethodId; integer; Value that uniquely identifies the alternate delivery method for the message.
- ChangeOrder; string; Value that identifies the change order.
- CollaborationPlan; string; Provides a collaboration name or a plan scenario name.
- ConfirmationStatus; string; Value that indicates the status of the confirmation message. Valid values are Received, Required, and Not Required.
- CorrelationId; string; Value that uniquely identifies the correlation ID to be retrieved and added to processing configuration.
- CreationDate; string; Date when the record was created.
- CustomerAccountNumber; string; Unique identifier for the customer account.
- CustomerName; string; Name of the customer.
- CustomerNumber; string; Number that uniquely identifies the customer.
- DeliveryMethodId; integer; Value that uniquely identifies the delivery method for the message.
- Direction; string; Value that indicates if the collaboration document operation is for an outbound or inbound collaboration.
- DocumentDescription; string; Description of the collaboration document.
- DocumentId; integer; Value that uniquely identifies the collaboration documents. It's a primary key that the application generates.
- DocumentName; string; Name of the collaboration document.
- DocumentOperationId; integer; Value that uniquely identifies the collaboration document operation.
- Error; string; Text of the message for the error that occurred during message transaction.
- ErrorType; string; Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing.
- ExternalMessageTypeId; integer; Value that uniquely identifies the external message definition associated with the message.
- ExternalPartnerId; integer; Value that uniquely identifies the external partner. It's a primary key that the application generates.
- FileName; string; Value that identifies the file name used in processing the message.
- FlowId; integer; Value that uniquely identifies the business flow instance in the SOA infrastructure.
- InstanceCount; integer; Value that identifies the count of records in the inbound message payload.
- KeyContext; string; 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 when the record was last updated.
- LineCount; integer; Total number of lines in the B2B message.
- MessageGUID; string; Value that uniquely identifies the business-to-business message transaction. It has different prefixes for outbound and inbound processing.
- MessageId; integer; Value that uniquely identifies the collaboration message. It's a primary key that the application generates.
- MessageLogId; integer; Value that uniquely identifies the business-to-business message transaction. It's a primary key that the application generates when it creates a message log record. This attribute is required.
- MessageName; string; Name of the collaboration message. For example, OutboundProcessPurchaseOrder.
- ObjectKey1; string; The first partner key value, which provides additional information about the partner for message processing.
- ObjectKey2; string; The second partner key value, which provides additional information about the partner for message processing.
- ObjectKey3; string; The third partner key value, which provides additional information about the partner for message processing.
- ObjectKey4; string; The fourth partner key value, which provides additional information about the partner for message processing.
- ObjectKey5; string; The fifth partner key value, which provides additional information about the partner for message processing.
- ObjectKey6; string; The sixth partner key value, which provides additional information about the partner for message processing.
- OrderNumber; string; Unique identifier for the purchase order.
- OrderNumberLog; string; The value that identifies the Order Number column in the log table.
- PONumber; string; Unique identifier for the purchase order.
- PartnerKey1; string; The first object key value, which provides additional information about the object for message processing.
- PartnerKey2; string; The second object key value, which provides additional information about the object for message processing.
- PartnerKey3; string; The third object key value, which provides additional information about the object for message processing.
- PartnerKey4; string; The fourth object key value, which provides additional information about the object for message processing.
- PartnerKey5; string; The fifth object key value, which provides additional information about the object for message processing.
- PartnerKey6; string; The sixth object key value, which provides additional information about the object for message processing.
- PartnerKeyType; string; Value that identifies the types of application-specific partner keys. For example, Legal Entity or Supplier Site.
- PartnerMessageId; integer; Value that uniquely identifies the trading partner message. It's a primary key that the application generates.
- PartnerMessageName; string; Name of the trading partner message.
- PayloadRetrievalReqd; string; 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 isn't 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; 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 isn't a primary message. This attribute doesn't have a default value.
- ProcessingCode; string; Abbreviation that identifies the acknowledgment confirmation status of the trading partner.
- ProcessingDetail; string; Describes the acknowledgment confirmation error or warning that occurred during message processing.
- ProcessingDuration; string; Time taken to process the message.
- ProviderType; string; This will show the lookup code for the provider type of Service Provider. This will used on the UI only.
- ProviderTypeMeaning; string; This will show the lookup meaning for the provider type of service provider.
- PublicationId; string; Value that uniquely identifies the publication. This value is generated by outbound processing while publishing messages to trading partners.
- RepositoryFileId; string; Value that uniquely identifies the file that contains the message payload in the Oracle content repository.
- RetentionDuration; integer; Value indicating how long the message is retained.
- RetentionDurationType; string; Value that indicates the message's retention duration type.
- RetentionEndDate; string; The date indicating the end of the message retention period.
- RetryCount; integer; Number of attempts made to deliver the message transaction.
- Revision; string; Revision number of the purchase orders.
- SenderMessageId; string; Value that uniquely identifies the sender of the message.
- SentAttachments; integer; Number of attachments attached to outbound message.
- SentAttachmentsList; string; List of attachments in the application payload.
- ServiceProviderId; integer; Value that uniquely identifies the service provider.
- ServiceProviderName; string; Name of the service provider.
- ServiceProviderPartnerId; string; Value that identifies the service provider's partner ID from the partner properties.
- ServiceProviderPartnerIdType; string; Value that identifies the service provider's partner ID type from the partner properties.
- ShipmentNumber; string; Unique identifier for the intra transit shipment.
- SoldToLeName; string; Value that identifies Sold to Entity Name column from the log table.
- SoldToLegalEntity; string; Legal entity is a company, organization, or individual that's responsible for purchasing goods or services from a supplier.
- Status; string; Value that identifies the current state of the collaboration message. Valid values are Hold, Error, and Success.
- StatusDate; string; Date when the collaboration message log was created. The value must be in the ISO8601 format.
- SublineCount; integer; Total number of sublines in the B2B message.
- SupplierName; string; Name of supplier.
- SupplierNumber; string; Number that uniquely identifies the supplier.
- SupplierSiteName; string; Name of a supplier site.
- TestFlag; boolean; Contains one of the following values, true or false. If true, then this is a test message. If false, then this isn't a test message. This attribute doesn't have a default value.
- TotalAttachments; integer; Total number of attachments in the application payload.
- TradingPartnerId; string; Value that uniquely identifies the trading partner. It's a primary key that the application generates.
- TradingPartnerIdType; string; Value that identifies the type of trading partner, for example, name.
- TransactionNumber; string; Cash receipt number of the cash receipt.
- UserDefinedServiceProvider; string; Checkbox to show if the service provider is user defined or not.
- Version; string; Value that identifies the version of the purchase order.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 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
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bMessageTransactions-item-response
Type:
Show Source
object-
AccessKey: string
Read Only:
trueMaximum Length:255Number that identifies the access key of the referenced inbound fiscal document. -
AltDeliveryMethodId: integer
(int64)
Read Only:
trueValue that uniquely identifies the alternate delivery method for the message. -
AltDelMethodTypeFlag: boolean
Maximum Length:
10Contains 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. -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ChangeOrder: string
Maximum Length:
256Value that identifies the change order. -
CollaborationPlan: string
Read Only:
trueMaximum Length:255Provides a collaboration name or a plan scenario name. -
ConfirmationStatus: string
Maximum Length:
100Value that indicates the status of the confirmation message. Valid values are Received, Required, and Not Required. -
CorrelationId: string
Maximum Length:
64Value that uniquely identifies the correlation ID to be retrieved and added to processing configuration. -
CreationDate: string
(date-time)
Read Only:
trueDate when the record was created. -
CustomerAccountNumber: string
Read Only:
trueMaximum Length:255Unique identifier for the customer account. -
CustomerName: string
Read Only:
trueMaximum Length:255Name of the customer. -
CustomerNumber: string
Read Only:
trueMaximum Length:255Number that uniquely identifies the customer. -
deliveryAttempts: array
Delivery Attempts
Title:
Delivery AttemptsThe 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:
trueValue that uniquely identifies the delivery method for the message. -
Direction: string
Maximum Length:
100Value that indicates if the collaboration document operation is for an outbound or inbound collaboration. -
DocumentDescription: string
Read Only:
trueMaximum Length:256Description of the collaboration document. -
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration documents. It's a primary key that the application generates.
-
DocumentName: string
Read Only:
trueMaximum Length:256Name of the collaboration document. -
DocumentOperationId: integer
(int64)
Value that uniquely identifies the collaboration document operation.
-
Error: string
Maximum Length:
2048Text of the message for the error that occurred during message transaction. -
ErrorDescription: string
(byte)
Read Only:
trueValue that describes the reason for the error for which the record processing failed. -
ErrorType: string
Maximum Length:
100Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing. -
ExternalMessageTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the external message definition associated with the message. -
ExternalPartnerId: integer
(int64)
Value that uniquely identifies the external partner. It's a primary key that the application generates.
-
FileName: string
Maximum Length:
512Value 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:
trueMaximum Length:255Indicates whether the event payload has a value. -
HasResponseDocumentFlag: boolean
Read Only:
trueMaximum Length:255Indicates 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:
trueMaximum Length:255Number that identifies the invoice. -
KeyContext: string
Maximum Length:
100Discriminator 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:
trueDate when the record was last updated. -
LineCount: integer
(int64)
Total number of lines in the B2B message.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageGUID: string
Maximum Length:
64Value 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's a primary key that the application generates.
-
MessageLogId: integer
(int64)
Value that uniquely identifies the business-to-business message transaction. It's 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:
256Name of the collaboration message. For example, OutboundProcessPurchaseOrder. -
ObjectKey1: string
Maximum Length:
256The first partner key value, which provides additional information about the partner for message processing. -
ObjectKey2: string
Maximum Length:
256The second partner key value, which provides additional information about the partner for message processing. -
ObjectKey3: string
Maximum Length:
256The third partner key value, which provides additional information about the partner for message processing. -
ObjectKey4: string
Maximum Length:
256The fourth partner key value, which provides additional information about the partner for message processing. -
ObjectKey5: string
Maximum Length:
256The fifth partner key value, which provides additional information about the partner for message processing. -
ObjectKey6: string
Maximum Length:
256The sixth partner key value, which provides additional information about the partner for message processing. -
OrderNumber: string
Read Only:
trueMaximum Length:255Unique identifier for the purchase order. -
OrderNumberLog: string
Title:
OrderMaximum Length:256The value that identifies the Order Number column in the log table. -
OutputDocument: string
(byte)
Value that identifies the transformed payload to be processed by Oracle Fusion Collaboration Messaging Framework for outbound processing.
-
PartnerKey1: string
Maximum Length:
256The first object key value, which provides additional information about the object for message processing. -
PartnerKey2: string
Maximum Length:
256The second object key value, which provides additional information about the object for message processing. -
PartnerKey3: string
Maximum Length:
512The third object key value, which provides additional information about the object for message processing. -
PartnerKey4: string
Maximum Length:
512The fourth object key value, which provides additional information about the object for message processing. -
PartnerKey5: string
Maximum Length:
512The fifth object key value, which provides additional information about the object for message processing. -
PartnerKey6: string
Maximum Length:
256The sixth object key value, which provides additional information about the object for message processing. -
PartnerKeyType: string
Maximum Length:
100Value 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's a primary key that the application generates.
-
PartnerMessageName: string
Maximum Length:
256Name of the trading partner message. -
PayloadRetrievalReqd: string
Maximum Length:
100Value 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 isn't 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:
trueMaximum Length:255Unique identifier for the purchase order. -
PrimaryRecipientFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the log message is a primary message. If false, then the log message isn't a primary message. This attribute doesn't have a default value. -
ProcessingCode: string
Maximum Length:
256Abbreviation that identifies the acknowledgment confirmation status of the trading partner. -
ProcessingDetail: string
Maximum Length:
3072Describes the acknowledgment confirmation error or warning that occurred during message processing. -
ProcessingDuration: string
Maximum Length:
10Time taken to process the message. -
ProviderType: string
Read Only:
trueMaximum Length:30This will show the lookup code for the provider type of Service Provider. This will used on the UI only. -
ProviderTypeMeaning: string
Title:
MeaningRead Only:trueMaximum Length:80This will show the lookup meaning for the provider type of service provider. -
PublicationId: string
Maximum Length:
64Value that uniquely identifies the publication. This value is generated by outbound processing while publishing messages to trading partners. -
receiptConfirmations: array
Message Confirmations
Title:
Message ConfirmationsThe 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:
32Value that uniquely identifies the file that contains the message payload in the Oracle content repository. -
RetentionDuration: integer
(int32)
Read Only:
trueValue indicating how long the message is retained. -
RetentionDurationType: string
Read Only:
trueMaximum Length:100Value that indicates the message's retention duration type. -
RetentionEndDate: string
Read Only:
trueMaximum Length:255The 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:
trueMaximum Length:255Revision number of the purchase orders. -
SenderMessageId: string
Maximum Length:
64Value that uniquely identifies the sender of the message. -
SentAttachments: integer
(int64)
Number of attachments attached to outbound message.
-
SentAttachmentsList: string
Maximum Length:
2048List of attachments in the application payload. -
ServiceProviderId: integer
(int64)
Value that uniquely identifies the service provider.
-
ServiceProviderName: string
Maximum Length:
256Name of the service provider. -
ServiceProviderPartnerId: string
Maximum Length:
100Value that identifies the service provider's partner ID from the partner properties. -
ServiceProviderPartnerIdType: string
Maximum Length:
100Value that identifies the service provider's partner ID type from the partner properties. -
ShipmentNumber: string
Read Only:
trueMaximum Length:255Unique identifier for the intra transit shipment. -
SizeInputDocument: number
Read Only:
trueSize of the input document used in message processing. -
SizeOutputDocument: number
Read Only:
trueSize of the output document generated during message processing. -
SoldToLegalEntity: string
Read Only:
trueMaximum Length:255Legal entity is a company, organization, or individual that's responsible for purchasing goods or services from a supplier. -
SoldToLeName: string
Title:
Sold to Legal EntityMaximum Length:256Value that identifies Sold to Entity Name column from the log table. -
Status: string
Maximum Length:
100Value 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 sublines in the B2B message.
-
SupplierName: string
Read Only:
trueMaximum Length:255Name of supplier. -
SupplierNumber: string
Read Only:
trueMaximum Length:255Number that uniquely identifies the supplier. -
SupplierSiteName: string
Read Only:
trueMaximum Length:255Name of a supplier site. -
TestFlag: boolean
Maximum Length:
10Contains one of the following values, true or false. If true, then this is a test message. If false, then this isn't a test message. This attribute doesn't have a default value. -
TotalAttachments: integer
(int64)
Total number of attachments in the application payload.
-
TradingPartnerId: string
Maximum Length:
100Value that uniquely identifies the trading partner. It's a primary key that the application generates. -
TradingPartnerIdType: string
Maximum Length:
100Value that identifies the type of trading partner, for example, name. -
TransactionNumber: string
Read Only:
trueMaximum Length:255Cash receipt number of the cash receipt. -
UserDefinedServiceProvider: string
Read Only:
trueMaximum Length:1Default Value:YCheckbox to show if the service provider is user defined or not. -
Version: string
Read Only:
trueMaximum Length:255Value that identifies the version of the purchase order.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Delivery Attempts
Type:
arrayTitle:
Delivery AttemptsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Message Confirmations
Type:
arrayTitle:
Message ConfirmationsThe 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-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-deliveryAttempts-item-response
Type:
Show Source
object-
Error: string
Maximum Length:
2048Text of the error message that occurred during message transaction. -
ErrorDescription: string
Maximum Length:
3072Description of the error encountered in message processing. -
ErrorType: string
Maximum Length:
100Value that identifies the type of error. Valid values include Object Retrieval and Outbound Processing. -
HasErrorDescriptionFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether there's a long error description for the message. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LongErrorDescription: string
(byte)
Additional details about the encountered error.
-
MessageGUID: string
Read Only:
trueValue that uniquely identifies the message. It's 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's 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's used to upload data to the specific application.
-
ScheduledProcessName: string
Maximum Length:
100Name of the scheduled process that's used to upload data to the specific application. -
Status: string
Maximum Length:
100Value that identifies the current state of the message. Valid values are Hold, Error, and Success.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bMessageTransactions-receiptConfirmations-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageGUID: string
Maximum Length:
64Value that uniquely identifies the message. It's 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:
256Abbreviation that identifies the processing of the message. -
ProcessingDetail: string
Maximum Length:
3072Describes the processing of the message. -
SenderMessageId: string
Maximum Length:
64Value that uniquely identifies the message sender. -
StatusDate: string
(date-time)
Date when the status of the message changed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- cancelMessage
-
Cancels further processing of a message.
- deleteMessages
-
Deletes transactions from the message log, including log details.
- downloadMessagePayloads
-
Downloads the original and transformed payloads for a message.
- exportMessages
-
Export selected B2B messages to a CSV file.
- findByAdvancedSearchQuery
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/action/findByAdvancedSearchQuerySearches for messages using global search.
- messageProcessing
-
Process A B2B message using the details provided via the AI Agent, B2B Message Format Converter
- refreshStatus
-
Refreshes the status of an individual message that's in either an in-process or a received status to reflect the most current state of processing.
- reprocessMessage
-
Reprocesses a failed, error, B2BError, or skipped message for processing.
- resubmitMessage
-
Resubmits a success or sent message for processing.
- retransmitPurchaseOrders
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageTransactions/action/retransmitPurchaseOrdersRetransmits purchase orders that were terminated or not initiated.
- terminateProcessing
-
Terminates processing of outbound purchase orders that are in process.
- updateMessageStatus
-
Updates the status of a message to either Error or Delivered.
- viewCollaborationEvent
-
View details of the event that was triggered to process the message.
- viewResponseDocument
-
View the details of the payload of the response document for a selected message.
Examples
This example describes how to get all transaction records.
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" -H 'cache-control: no-cache'"
Example Response Body
The following shows an example of the response body in JSON format.
{
"items" : [ {
"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"
} ]
}, {
"MessageLogId" : 300100120932351,
"MessageGUID" : "OUT_22043",
"ServiceProviderId" : 50055,
"ServiceProviderName" : "None",
"Status" : "Error",
"StatusDate" : "2017-07-26T22:13:27.890+00:00",
"TestFlag" : false,
"Error" : "NoWSEndpointSetup",
"ErrorType" : "OutboundProcessing",
"MessageName" : "OAGIS_10.1_PROCESS_PLANNING_SCHEDULE_COLLAB_MSG_OUT",
"MessageId" : 50011,
"ProcessingDuration" : null,
"RetryCount" : 0,
"SenderMessageId" : null,
"DocumentOperationId" : 50088,
"ExternalPartnerId" : 300100112121990,
"TradingPartnerId" : "CV_SUPPA05",
"TradingPartnerIdType" : "ORA_Generic",
"PartnerMessageName" : "CV_SUPPA05",
"PartnerMessageId" : 300100112121995,
"PartnerKeyType" : "Supplier Site",
"CorrelationId" : null,
"ProcessingCode" : null,
"ProcessingDetail" : null,
"SentAttachments" : null,
"TotalAttachments" : null,
"SentAttachmentsList" : null,
"DocumentId" : 50088,
"Direction" : "Out",
"DocumentName" : "PROCESS_FORECAST_OUT",
"MessageLogStatus" : "Undelivered",
"PublicationId" : null,
"PrimaryRecipientFlag" : false,
"ConfirmationStatus" : null,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043",
"name" : "b2bMessageTransactions",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
}, {
"rel" : "canonical",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043",
"name" : "b2bMessageTransactions",
"kind" : "item"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/ErrorTypeLOV",
"name" : "ErrorTypeLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/ConfirmationStatusLOV",
"name" : "ConfirmationStatusLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/ErrorSubTypeLOV",
"name" : "ErrorSubTypeLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/ProcessingStatusLOV",
"name" : "ProcessingStatusLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/MessageDirectionLOV",
"name" : "MessageDirectionLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/lov/ExternalPartnerIdTypeLOV",
"name" : "ExternalPartnerIdTypeLOV",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/child/deliveryAttempts",
"name" : "deliveryAttempts",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions/OUT_22043/child/receiptConfirmations",
"name" : "receiptConfirmations",
"kind" : "collection"
} ]
} ],
"count" : 2,
"hasMore" : true,
"limit" : 2,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/b2bMessageTransactions",
"name" : "b2bMessageTransactions",
"kind" : "collection"
} ]
}