Get one trading partner
get
/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}
Request
Path Parameters
-
TradingPartnerId(required): integer(int64)
Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.
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(required):
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(required):
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 : b2bTradingPartners-item-response
Type:
Show Source
object
-
b2bServiceProviders: array
B2B Service Providers
Title:
B2B Service Providers
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers. -
confirmationCodes: array
Confirmation Codes
Title:
Confirmation Codes
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the trading partner record. -
deliveryMethods: array
Delivery Methods
Title:
Delivery Methods
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners. -
documents: array
Trading Partner Documents
Title:
Trading Partner Documents
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing. -
ExternalMessageStandardTag: string
Maximum Length:
512
Tag used for outbound headers to identify the standard of the partner sending the message. -
ExternalMessageTypeTag: string
Maximum Length:
512
Tag used for outbound headers to identify the type of partner sending the message. -
ExternalMessageVersionTag: string
Maximum Length:
512
Tag used for outbound headers to identify the version of the partner sending the message. -
FromPartnerIdTag: string
Maximum Length:
512
Tag used in protocol headers to identify the partner sending the message. -
FromPartnerIdTypeTag: string
Maximum Length:
512
Tag used in protocol headers to identify the type of partner sending the message. -
inboundCollaborationMessages: array
Inbound Collaboration Messages
Title:
Inbound Collaboration Messages
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the trading partner record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualEntryIndicator: string
Maximum Length:
10
Default Value:Yes
Value that indicates a manual entry. The value is Y when trading partner record is manually entered from the user interface. -
ObnId: string
Read Only:
true
Maximum Length:100
Value that uniquely identifies the Oracle Business Network identifier of the trading partner. -
outboundCollaborationMessages: array
Outbound Collaboration Messages
Title:
Outbound Collaboration Messages
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud. -
ServiceProviderId: integer
(int64)
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider for a trading partner.
-
ServiceProviderName: string
Name of the service provider.
-
ToPartnerIdTag: string
Maximum Length:
512
Tag used in protocol headers to identify the partner to whom the message is being sent. -
ToPartnerIdTypeTag: string
Maximum Length:
512
Tag used in protocol headers to identify the identifier type of the partner to whom the message is being sent. -
TradingPartner: string
Title:
Trading Partner ID
Maximum Length:100
Value that uniquely identifies the trading partner name. -
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.
-
TradingPartnerIdType: string
Maximum Length:
100
Value that identifies the type of trading partner.
Nested Schema : B2B Service Providers
Type:
array
Title:
B2B Service Providers
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers.
Show Source
Nested Schema : Confirmation Codes
Type:
array
Title:
Confirmation Codes
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing.
Show Source
Nested Schema : Delivery Methods
Type:
array
Title:
Delivery Methods
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
Show Source
Nested Schema : Trading Partner Documents
Type:
array
Title:
Trading Partner Documents
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
Show Source
Nested Schema : Inbound Collaboration Messages
Type:
array
Title:
Inbound Collaboration Messages
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Outbound Collaboration Messages
Type:
array
Title:
Outbound Collaboration Messages
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
Show Source
Nested Schema : b2bTradingPartners-b2bServiceProviders-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the service provider associated with trading partner. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the service provider associated with the trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerId: string
Title:
Provider ID
Maximum Length:100
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner for a service provider. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the type of trading partner. -
ServiceProviderId: integer
(int64)
Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.
-
ServiceProviderName: string
Maximum Length:
256
Name of the service provider.
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 : b2bTradingPartners-confirmationCodes-item-response
Type:
Show Source
object
-
CollaborationStatus: string
Maximum Length:
100
Value that specifies the status of the collaboration message. -
ConfStatusXrefId: integer
(int64)
Value that uniquely identifies the confirmation code. It is a primary key that the application generates when it creates a confirmation code record. This attribute is required.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user defined the confirmation code for the trading partner. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the confirmation code associated with the trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerStatus: string
Maximum Length:
256
Value that specifies the status of confirmation of the trading partner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-deliveryMethods-item-response
Type:
Show Source
object
-
AttachXmlFlag: boolean
Title:
Attach Payload
Maximum Length:10
Contains one of the following values: true or false. If true, then the transformed payload is sent along with the email as attachment. If false, then the transformed payload is not sent along with the email as attachment. The default value is false. -
B2bRoutingFlag: boolean
Title:
B2B Routing Enabled
Maximum Length:10
Default Value:false
Contains one of the following values: true or false. If true, then the messages to the service provider are routed through the internal B2B gateway. If false, then the messages to the service provider are not routed through the internal B2B gateway. The default value is false. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the delivery method that the trading partner uses to send outbound messages. -
CsfkeyPassword: string
Value that stores the password in the credential store.
-
CsfkeyUser: string
Value that stores the username in the credential store.
-
DeliveryMethodId: integer
(int64)
Value that uniquely identifies the delivery method. It is a primary key that the application generates when it creates a delivery method record. This attribute is required.
-
DeliveryMethodName: string
Title:
Name
Maximum Length:256
Name of the delivery method. This attribute is required. -
DeliveryMethodType: string
Maximum Length:
100
Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service. -
FileExtension: string
Maximum Length:
10
Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used. -
FileName: string
Maximum Length:
256
Value that identifies the file that is being delivered using SFTP. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecipientEmailId: string
Title:
Recipient Email ID
Maximum Length:256
Value that uniquely identifies the email to which the outbound message is sent. -
RemoteDir: string
Maximum Length:
2000
Value that identifies the directory where outbound messages are delivered using SFTP. -
SecurityPolicy: string
Title:
Security Policy
Maximum Length:256
Value that indicates the security policy used with the delivery method. -
Service: string
Title:
Service Name
Maximum Length:256
Value that identifies the external service of the delivery method. -
ServiceMeaning: string
Value that specifies the meaning of the service.
-
ServiceUri: string
Value that specifies the service endpoint stored in topology manager.
-
SftpHost: string
Value that identifies the host name for outbound message delivery using SFTP.
-
SftpPort: string
Maximum Length:
255
Value that identifies the port for outbound message delivery using SFTP. -
UcmExportDocumentAccount: string
Title:
Repository Account
Maximum Length:1024
Value that specifies the location from where files are picked for outbound process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-documents-item-response
Type:
Show Source
object
-
DocumentId: integer
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Name of the trading partner document.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. -
ServiceRequestId: integer
Value that uniquely identifies the service request. The application generates this value when a setup request is made to a service provider.
-
TradingPartnerDocumentId: integer
Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.
-
TradingPartnerDocumentStatus: string
Value that specifies the status of the trading partner document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-documents-messageProcessingRules-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the processing rule for the trading partner's collaboration message. -
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the processing rule for the trading partner's collaboration message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
NodeId: integer
(int64)
Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
-
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-item-response
Type:
Show Source
object
-
AcknowledgementCode: string
Maximum Length:
100
Default Value:Never
Value that indicates whether the application processing feedback should be sent for inbound messages or not. -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000
Value that stores the application partner code cross reference path. -
CreationDate: string
(date-time)
Date when the user set up the inbound collaboration message for the trading partner.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Read Only:
true
Maximum Length:256
Name of document associated with the inbound collaboration message. -
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
LastUpdateDate: string
(date-time)
Date when the user most recently updated the inbound collaboration message for the trading partner.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message.
-
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. -
ObjectKey1Xpath: string
Maximum Length:
2000
Value that identifies the first key of the XPath in the input payload. -
ObjectKey2Xpath: string
Maximum Length:
2000
Value that identifies the second key of the XPath in the input payload. -
ObjectKey3Xpath: string
Maximum Length:
2000
Value that identifies the third key of the XPath in the input payload. -
ObjectKey4Xpath: string
Maximum Length:
2000
Value that identifies the fourth key of the XPath in the input payload. -
ObjectKey5Xpath: string
Maximum Length:
2000
Value that identifies the fifth key of the XPath in the input payload. -
ObjectKey6Xpath: string
Maximum Length:
2000
Value that identifies the sixth key of the XPath in the input payload. -
OverrideStatus: string
Maximum Length:
100
Value that specifies the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the inbound collaboration message was overridden.
-
PartnerMessageCustomizationId: integer
(int64)
Value that uniquely identifies the partner message customization. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required. This is a read-only attribute.
-
PartnerMessageId: integer
(int64)
Value that uniquely identifies the trading partner message. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required.
-
PartnerMessageName: string
Title:
Name
Maximum Length:256
Name of the inbound collaboration message. -
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
PartnerMessageStatusDate: string
(date-time)
Date when the inbound collaboration message was created or updated.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of inbound and outbound that is sent through SOAP headers. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the duration of retention of the inbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the type of duration of retention of the inbound collaboration message. -
UserDefinedFlag: boolean
Read Only:
true
Value that indicates whether the inbound collaboration message is user defined. This value is not editable.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the domain value map associated with the trading partner's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map defined in the SOA composer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true
Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required. -
MessageId: integer
(int64)
Read Only:
true
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Read Only:
true
Name of the collaboration message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the processing rule for the trading partner's collaboration message. -
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the processing rule for the trading partner's collaboration message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
NodeId: integer
(int64)
Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
-
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-item-response
Type:
Show Source
object
-
AlternateDeliveryMethodId: integer
(int64)
Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.
-
AlternateDeliveryMethodName: string
Name of the alternate delivery method.
-
AttachmentProcessingMethod: string
Maximum Length:
64
Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the inbound collaboration message for the trading partner. -
DeliveryMethodId: integer
(int64)
Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.
-
DeliveryMethodName: string
Name of the delivery method for the outbound collaboration message.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Read Only:
true
Maximum Length:256
Name of document associated with the outbound collaboration message. -
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the inbound collaboration message for the trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message name.
-
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. -
OverrideStatus: string
Maximum Length:
100
Value that specifies the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the status of the outbound collaboration message was overridden.
-
PartnerMessageCustomizationId: integer
(int64)
Value that uniquely identifies the trading partner message customization. This attribute is a foreign key reference to the trading partner message customization.
-
PartnerMessageId: integer
(int64)
Value that uniquely identifies the trading partner message. This attribute is a foreign key reference to the trading partner message.
-
PartnerMessageName: string
Title:
Name
Maximum Length:256
Name of the outbound collaboration message. -
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the outbound collaboration message. -
PartnerMessageStatusDate: string
(date-time)
Date when the outbound collaboration message status is set.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of outbound message which is sent through SOAP headers. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that specifies the duration of retention of the outbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that specifies the type of duration of retention of the outbound collaboration message. -
ServiceProviderId: integer
(int64)
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
UserDefinedFlag: boolean
Read Only:
true
Value that indicates whether the outbound collaboration message is user defined. This value is not editable.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the domain value map associated with the trading partner's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map defined in the SOA composer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true
Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required. -
MessageId: integer
(int64)
Read Only:
true
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Read Only:
true
Name of the collaboration message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the processing rule for the trading partner's collaboration message. -
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the processing rule for the trading partner's collaboration message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
NodeId: integer
(int64)
Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
-
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- b2bServiceProviders
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/b2bServiceProvidersParameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The B2B Service Providers resource gets the relevant details of external parties that provide service to trading partners for message processing. This is a reference to the independent root resource B2B service providers. - TradingPartnerId:
- confirmationCodes
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/confirmationCodesParameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The Confirmation Codes resource gets the status mapping between trading partner and Oracle Collaboration Messaging Framework Cloud required in message processing. - TradingPartnerId:
- deliveryMethods
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/deliveryMethodsParameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners. - TradingPartnerId:
- documents
-
Parameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing. - TradingPartnerId:
- inboundCollaborationMessages
-
Parameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud. - TradingPartnerId:
- outboundCollaborationMessages
-
Parameters:
- TradingPartnerId:
$request.path.TradingPartnerId
The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud. - TradingPartnerId:
Examples
This example describes how to get one trading partner.
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/b2bTradingPartners/TradingPartnerId"
For example, the following command gets one trading partner:
curl -u username:password "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017"
Example Response Body
The following shows an example of the response body in JSON format.
{ "TradingPartnerId" : 300100073313017, "TradingPartner" : "891678078", "TradingPartnerIdType" : "ORA_DUNS", "ManualEntryIndicator" : "Yes", "ServiceProviderId" : 50055, "ServiceProviderName" : "None", "FromPartnerIdTag" : null, "FromPartnerIdTypeTag" : null, "ToPartnerIdTag" : null, "ToPartnerIdTypeTag" : null, "ExternalMessageTypeTag" : null, "ExternalMessageVersionTag" : null, "ExternalMessageStandardTag" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017", "name" : "b2bTradingPartners", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017", "name" : "b2bTradingPartners", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/lov/tradingPartnerTypeLOV", "name" : "tradingPartnerTypeLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/lov/serviceProvidersLOV", "name" : "serviceProvidersLOV", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/documents", "name" : "documents", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages", "name" : "inboundCollaborationMessages", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages", "name" : "outboundCollaborationMessages", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/confirmationCodes", "name" : "confirmationCodes", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/b2bServiceProviders", "name" : "b2bServiceProviders", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods", "name" : "deliveryMethods", "kind" : "collection" } ] }