1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. B2B Trading Partners

Get one trading partner

get

/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : b2bTradingPartners-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : b2bTradingPartners-confirmationCodes-item-response
Type: object
Show Source
Nested Schema : b2bTradingPartners-deliveryMethods-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Date when the user created the delivery method that the trading partner uses to send outbound messages.
  • Value that stores the password in the credential store.
  • Value that stores the username in the credential store.
  • 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.
  • Title: Name
    Maximum Length: 256
    Name of the delivery method. This attribute is required.
  • Maximum Length: 100
    Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.
  • Maximum Length: 10
    Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
  • Maximum Length: 256
    Value that identifies the file that is being delivered using SFTP.
  • Read Only: true
    Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages.
  • Links
  • Title: Recipient Email ID
    Maximum Length: 256
    Value that uniquely identifies the email to which the outbound message is sent.
  • Maximum Length: 2000
    Value that identifies the directory where outbound messages are delivered using SFTP.
  • Title: Security Policy
    Maximum Length: 256
    Value that indicates the security policy used with the delivery method.
  • Title: Service Name
    Maximum Length: 256
    Value that identifies the external service of the delivery method.
  • Value that specifies the meaning of the service.
  • Value that specifies the service endpoint stored in topology manager.
  • Value that identifies the host name for outbound message delivery using SFTP.
  • Maximum Length: 255
    Value that identifies the port for outbound message delivery using SFTP.
  • Title: Repository Account
    Maximum Length: 1024
    Value that specifies the location from where files are picked for outbound process.
Nested Schema : b2bTradingPartners-documents-item-response
Type: object
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: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • 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.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • 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.
  • 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 : b2bTradingPartners-inboundCollaborationMessages-item-response
Type: object
Show Source
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 : 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: object
Show Source
  • Read Only: true
    Date when the user set up the domain value map associated with the trading partner's predefined message definition.
  • Read Only: true
    Maximum Length: 256
    Name of the domain value map defined in the SOA composer.
  • Read Only: true
    Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition.
  • Links
  • 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.
  • Read Only: true
    Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
  • Read Only: true
    Name of the collaboration message.
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • 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.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • 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.
  • 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 : b2bTradingPartners-outboundCollaborationMessages-item-response
Type: object
Show Source
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 : 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: object
Show Source
  • Read Only: true
    Date when the user set up the domain value map associated with the trading partner's predefined message definition.
  • Read Only: true
    Maximum Length: 256
    Name of the domain value map defined in the SOA composer.
  • Read Only: true
    Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition.
  • Links
  • 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.
  • Read Only: true
    Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
  • Read Only: true
    Name of the collaboration message.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • 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.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • 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.
  • 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.
Links
b2bServiceProviders
Parameters:
  • 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.
confirmationCodes
Parameters:
  • 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.
deliveryMethods
Parameters:
  • TradingPartnerId: $request.path.TradingPartnerId
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
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.
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.
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.
Back to Top

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