Get one service provider
get
/fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}
Request
Path Parameters
-
ServiceProviderId(required): 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.
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 : b2bServiceProviders-item-response
Type:
Show Source
object
-
AttchProcessMthd: string
Read Only:
true
Maximum Length:100
Value that indicates how the service provider can send message attachments to trading partners. Valid values include In message, In payload, and MIME part. -
ConnectionType: string
Read Only:
true
Maximum Length:100
Value that indicates the type of outbound delivery connection that is configured for the service provider, i.e., Test or Production. This value is not editable. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the service provider. -
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. -
DelStatusUpdateEnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the service provider provides message delivery status updates. If false, then the service provider doesn't provide message delivery status updates. The default value is false. -
Description: string
Maximum Length:
256
Description of the service provider. -
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. -
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 service provider. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MsgExchangeStandard: string
Maximum Length:
100
Value that indicates the messaging standard used by the service provider. -
ObnId: string
Read Only:
true
Maximum Length:100
Value that uniquely identifies the Oracle Business Network Account identifier of the service provider. -
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. -
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 : 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 : b2bServiceProviders-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 service provider uses to send outbound messages. -
CsfkeyPassword: string
Value that indicates the encrypted password in the credential store.
-
CsfkeyUser: string
Value that indicates 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 service provider 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 the 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 : 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 : b2bServiceProviders-documents-item-response
Type:
Show Source
object
-
CollaborationObject: string
Read Only:
true
Maximum Length:256
Value that identifies the collaboration object. A list of accepted values is defined in the lookup type Collaboration Object. -
Direction: string
Read Only:
true
Maximum Length:100
Value that indicates if the collaboration document operation is for an outbound or an inbound collaboration. -
DocumentId: integer
(int64)
Read Only:
true
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 the trading partner document. -
DocumentType: string
Read Only:
true
Maximum Length:256
Value that identifies the type of collaboration document such as, Process Purchase Order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SenderRole: string
Read Only:
true
Maximum Length:100
Value that indicates the role of the sender in the collaboration such as Customer.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bServiceProviders-inboundCollaborationMessages-item-response
Type:
Show Source
object
-
AcknowledgementCode: string
Maximum Length:
100
Default Value:Never
Value that indicates whether the application processing feedback is 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 service provider.
-
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 the 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 service provider.
-
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.
-
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 indicates 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)
Values 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 the inbound message. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the retention duration of the inbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the retention duration type 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 : b2bServiceProviders-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 service provider's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the service provider'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 : b2bServiceProviders-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 service provider. -
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 the 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 service. -
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.
-
OverrideStatus: string
Maximum Length:
100
Value that indicates 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 inbound 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 indicates 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 indicates the action of the outbound message. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the retention duration of the outbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the retention duration type 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 : b2bServiceProviders-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 service provider's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the service provider'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
Links
- deliveryMethods
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/deliveryMethodsParameters:
- ServiceProviderId:
$request.path.ServiceProviderId
The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners. - ServiceProviderId:
- documents
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/documentsParameters:
- ServiceProviderId:
$request.path.ServiceProviderId
The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing. - ServiceProviderId:
- inboundCollaborationMessages
-
Parameters:
- ServiceProviderId:
$request.path.ServiceProviderId
The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud. - ServiceProviderId:
- outboundCollaborationMessages
-
Parameters:
- ServiceProviderId:
$request.path.ServiceProviderId
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:
Examples
This example describes how to get one service provider.
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/b2bServiceProviders/ServiceProviderId"
For example, the following command gets one service provider:
curl -u username:password "https://servername/fscmRestApi/resources/version/b2bServiceProviders/50033"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "ServiceProviderId": 50033, "ServiceProviderName": "OracleSN", "TradingPartner": "OracleSupplierNetwork", "TradingPartnerType": "ORA_Name", "FromPartnerIdTag": "SENDER_ID", "FromPartnerIdTypeTag": "SENDER_ID_TYPE", "ToPartnerIdTag": "RECEIVER_ID", "ToPartnerIdTypeTag": "RECEIVER_ID_TYPE", "ExternalMsgTypeTag": "DOC_TYPE", "ExternalMsgVersionTag": "FORMAT_VERSION", "ExternalMsgStandardTag": "DOC_FORMAT", "ServiceProviderIdTag": "SENDER_EHUB_ID", "Description": "Oracle Supplier Network" } ] }