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

Get all transaction records

get

/fscmRestApi/resources/11.13.18.05/b2bMessageTransactions

Request

Query Parameters
  • 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
  • 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.
      • 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 is 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 is 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 is 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.
    • InvoiceNumber; string; Number that identifies the invoice.
    • 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 is a primary key that the application generates.
    • MessageLogId; integer; 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.
    • MessageName; string; Name of the collaboration message. For example, OutboundProcessPurchaseOrder.
    • OrderNumber; string; Unique identifier for the purchase order.
    • PONumber; string; Unique identifier for the purchase order.
    • 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 is 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 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; 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; Abbreviation that identifies the acknowledgement 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 ProviderType of Service Provider. This will used in 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 intratransit shipment.
    • SoldToLegalEntity; string; Legal entity (company, organization, or individual) responsible for purchasing goods or services from a supplier or vendor.
    • 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 sub lines 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 is not a test message. This attribute does not have a default value.
    • TotalAttachments; integer; Total number of attachments in the application payload.
    • TradingPartnerId; string; Value that uniquely identifies the trading partner. It is a primary key that the application generates.
    • TradingPartnerIdType; string; Value that identifies the type of trading partner. For example, DUNS.
    • TransactionNumber; string; Cash receipt number of the cash receipt.
    • UserDefinedServiceProvider; string; Flag to Show the Service Provider is user defined or not
    • Version; string; Value that identifies the version of the purchase order.
  • 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
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : b2bMessageTransactions-item-response
Type: object
Show Source
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
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
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 is 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.
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
Back to Top

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"
  } ]
}
Back to Top