Managing the Keystore Oracle Fusion Middleware Online Documentation Library

20-4 Oracle Fusion Middleware Users Guide for Oracle B2B

20.4 Using the Query API

The Query API retrieves the configured details from Oracle B2B, and share them with applications. Before initiating a message transmission from applications, a health check request is made for the given parameters. This check finds if any configurations exist, and how many are active. If no configuration is found, the application can stop message flow in its layer with the message no configuration found in B2B. The following APIs are provided: ■ Is Trading Partner Agreement Setup returns true if agreement found for the given inputs. See Section 20.4.1, Is Trading Partner Agreement Setup Parameters for parameter details. ■ Get Trading Partner Agreement Information returns agreement details. See Section 20.4.2, Get Trading Partner Agreement Information Parameters for parameter details.

20.4.1 Is Trading Partner Agreement Setup Parameters

documentTypeName String Example: 850 Document type name Yes encoding String Example: ISO-8859-1 Default: UTF-8 Encoding format No payload Xsd:anyType Holds the payload Yes Table 20–5 Translation Web Service Response Parameters Header Data Type Description Required payload Xsd:anyType Translated message, with the same encoding type sent in the request. Yes Table 20–6 Translation Web Service Fault Message Parameters Header Data Type Description ExceptionMessage String If a fault is found, the Exception Stack Trace is transmitted. Table 20–7 Is Trading Partner Agreement Setup Request Parameters Header Data Type Description Required from String Host name or identification value No to String Trading Partner name or identification value No Table 20–4 Cont. Translation Web Service Request Parameters Header Data Type Description Required Using the Oracle B2B Web Services 20-5

20.4.2 Get Trading Partner Agreement Information Parameters

type String Example: DUNS Identification type No document String Example: Sales Order Name of the internal application document or AIA EBO to be sent out Yes action String Example: Update A sub-classification which identifies the specific interaction with the Trading Partner Yes Table 20–8 Is Trading Partner Agreement Setup Response Parameters Header Data Type Description Required MatchedTPACount integer Number of Agreements present in an active state in the Oracle 2B Repository Yes Table 20–9 Is Trading Partner Agreement Setup Fault Message Parameters Header Data Type Description ExceptionMessage String If a fault is found, the Exception Stack Trace is transmitted. Table 20–10 Get Trading Partner Agreement Information Request Parameters Header Data Type Description Required from String Host name or identification value No to String Trading Partner name or identification value No type String Example: DUNS Identification type No document String Example: Sales Order Name of the internal application document or AIA EBO to be sent out No action String Example: Update A sub-classification which identifies the specific interaction with the Trading Partner No Table 20–11 Get Trading Partner Agreement Information Response Parameters Header Data Type Description Required AgreementID String Unique Agreement ID of the matching agreement Yes B2BDocumentDef String Document definition in Oracle B2B used for creating the Oracle B2B document type Yes B2BDocumentType String Document type defined in Oracle B2B for the requested application document and action Yes B2BDocumentRevision String Document revision defined in Oracle B2B for the requested application document and action Yes Table 20–7 Cont. Is Trading Partner Agreement Setup Request Parameters Header Data Type Description Required