Create
post
/fscmRestApi/resources/11.13.18.05/b2bServiceProviders
Request
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
deliveryMethods: array
deliveryMethods
-
DelStatusUpdateEnabledFlag: boolean
Maximum Length:
1 -
Description: string
Maximum Length:
256 -
documents: array
documents
-
inboundCollaborationMessages: array
inboundCollaborationMessages
-
MsgExchangeStandard: string
Maximum Length:
100 -
outboundCollaborationMessages: array
outboundCollaborationMessages
-
PartnerId(required): string
Title:
Provider IDMaximum Length:100 -
PartnerIdType: string
Maximum Length:
100 -
ServiceProviderId: integer
(int64)
-
ServiceProviderName: string
Maximum Length:
256 -
UserDefined: string
Maximum Length:
1Default Value:Y
Nested Schema : schema
Type:
Show Source
object-
AttachXmlFlag: boolean
Title:
Attach PayloadMaximum Length:10 -
B2bRoutingFlag: boolean
Title:
B2B Routing EnabledMaximum Length:10Default Value:false -
CsfkeyPassword: string
-
CsfkeyUser: string
-
DeliveryMethodId: integer
(int64)
-
DeliveryMethodName: string
Title:
NameMaximum Length:256 -
DeliveryMethodType: string
Maximum Length:
100 -
FileExtension: string
Maximum Length:
10 -
FileName: string
Maximum Length:
256 -
RecipientEmailId: string
Title:
Recipient Email IDMaximum Length:256 -
RemoteDir: string
Maximum Length:
2000 -
RequestHeaders: string
Maximum Length:
2000 -
SecurityPolicy: string
Title:
Security PolicyMaximum Length:256 -
Service: string
Title:
Service NameMaximum Length:256 -
ServiceMeaning: string
-
ServiceUri: string
-
SftpHost: string
-
SftpPort: string
Maximum Length:
255 -
UcmExportDocumentAccount: string
Title:
Repository AccountMaximum Length:1024
Nested Schema : schema
Type:
Show Source
object-
AcknowledgementCode: string
Maximum Length:
100Default Value:Never -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000 -
CreationDate: string
(date-time)
-
DocumentId: integer
(int64)
-
domainValueMaps: array
domainValueMaps
-
LastUpdateDate: string
(date-time)
-
MessageId(required): integer
(int64)
Title:
Collaboration Message Definition -
MessageName(required): string
-
ObjectKey1Xpath: string
Maximum Length:
2000 -
ObjectKey2Xpath: string
Maximum Length:
2000 -
ObjectKey3Xpath: string
Maximum Length:
2000 -
ObjectKey4Xpath: string
Maximum Length:
2000 -
ObjectKey5Xpath: string
Maximum Length:
2000 -
ObjectKey6Xpath: string
Maximum Length:
2000 -
OverrideStatus(required): string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageCustomizationId(required): integer
(int64)
-
PartnerMessageId: integer
(int64)
-
PartnerMessageName(required): string
Title:
NameMaximum Length:256 -
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100
Nested Schema : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-post-request
Type:
Show Source
objectNested Schema : schema
Type:
Show Source
object-
AlternateDeliveryMethodId: integer
(int64)
-
AlternateDeliveryMethodName: string
-
AttachmentProcessingMethod: string
Maximum Length:
64 -
DeliveryMethodId: integer
(int64)
-
DeliveryMethodName: string
-
DocumentId: integer
(int64)
-
domainValueMaps: array
domainValueMaps
-
MessageId(required): integer
(int64)
Title:
Collaboration Message Definition -
MessageName(required): string
-
OverrideStatus(required): string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageCustomizationId(required): integer
(int64)
-
PartnerMessageId: integer
(int64)
-
PartnerMessageName(required): string
Title:
NameMaximum Length:256 -
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100 -
ServiceProviderId: integer
(int64)
Nested Schema : b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-post-request
Type:
Show Source
objectResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : b2bServiceProviders-item-response
Type:
Show Source
object-
AttchProcessMthd: string
Read Only:
trueMaximum Length:100 -
ConnectionType: string
Read Only:
trueMaximum Length:100 -
CreationDate: string
(date-time)
Read Only:
true -
deliveryMethods: array
deliveryMethods
-
DelStatusUpdateEnabledFlag: boolean
Maximum Length:
1 -
Description: string
Maximum Length:
256 -
documents: array
documents
-
inboundCollaborationMessages: array
inboundCollaborationMessages
-
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MsgExchangeStandard: string
Maximum Length:
100 -
ObnId: string
Read Only:
trueMaximum Length:100 -
outboundCollaborationMessages: array
outboundCollaborationMessages
-
PartnerId: string
Title:
Provider IDMaximum Length:100 -
PartnerIdType: string
Maximum Length:
100 -
ServiceProviderId: integer
(int64)
-
ServiceProviderName: string
Maximum Length:
256 -
UserDefined: string
Maximum Length:
1Default Value:Y
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bServiceProviders-deliveryMethods-item-response
Type:
Show Source
object-
AttachXmlFlag: boolean
Title:
Attach PayloadMaximum Length:10 -
B2bRoutingFlag: boolean
Title:
B2B Routing EnabledMaximum Length:10Default Value:false -
CreationDate: string
(date-time)
Read Only:
true -
CsfkeyPassword: string
-
CsfkeyUser: string
-
DeliveryMethodId: integer
(int64)
-
DeliveryMethodName: string
Title:
NameMaximum Length:256 -
DeliveryMethodType: string
Maximum Length:
100 -
FileExtension: string
Maximum Length:
10 -
FileName: string
Maximum Length:
256 -
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RecipientEmailId: string
Title:
Recipient Email IDMaximum Length:256 -
RemoteDir: string
Maximum Length:
2000 -
RequestHeaders: string
Maximum Length:
2000 -
SecurityPolicy: string
Title:
Security PolicyMaximum Length:256 -
Service: string
Title:
Service NameMaximum Length:256 -
ServiceMeaning: string
-
ServiceUri: string
-
SftpHost: string
-
SftpPort: string
Maximum Length:
255 -
UcmExportDocumentAccount: string
Title:
Repository AccountMaximum Length:1024
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
trueMaximum Length:256 -
Direction: string
Read Only:
trueMaximum Length:100 -
DocumentId: integer
(int64)
Read Only:
true -
DocumentName: string
Read Only:
trueMaximum Length:256 -
DocumentType: string
Read Only:
trueMaximum Length:256 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SenderRole: string
Read Only:
trueMaximum Length:100
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bServiceProviders-inboundCollaborationMessages-item-response
Type:
Show Source
object-
AcknowledgementCode: string
Maximum Length:
100Default Value:Never -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000 -
CreationDate: string
(date-time)
-
DocumentId: integer
(int64)
-
DocumentName: string
Read Only:
trueMaximum Length:256 -
domainValueMaps: array
domainValueMaps
-
LastUpdateDate: string
(date-time)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition -
MessageName: string
-
ObjectKey1Xpath: string
Maximum Length:
2000 -
ObjectKey2Xpath: string
Maximum Length:
2000 -
ObjectKey3Xpath: string
Maximum Length:
2000 -
ObjectKey4Xpath: string
Maximum Length:
2000 -
ObjectKey5Xpath: string
Maximum Length:
2000 -
ObjectKey6Xpath: string
Maximum Length:
2000 -
OverrideStatus: string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageCustomizationId: integer
(int64)
-
PartnerMessageId: integer
(int64)
-
PartnerMessageName: string
Title:
NameMaximum Length:256 -
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100 -
UserDefinedFlag: boolean
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 -
DvmName: string
Read Only:
trueMaximum Length:256 -
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true -
MessageId: integer
(int64)
Read Only:
true -
MessageName: string
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bServiceProviders-outboundCollaborationMessages-item-response
Type:
Show Source
object-
AlternateDeliveryMethodId: integer
(int64)
-
AlternateDeliveryMethodName: string
-
AttachmentProcessingMethod: string
Maximum Length:
64 -
CreationDate: string
(date-time)
Read Only:
true -
DeliveryMethodId: integer
(int64)
-
DeliveryMethodName: string
-
DocumentId: integer
(int64)
-
DocumentName: string
Read Only:
trueMaximum Length:256 -
domainValueMaps: array
domainValueMaps
-
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition -
MessageName: string
-
OverrideStatus: string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageCustomizationId: integer
(int64)
-
PartnerMessageId: integer
(int64)
-
PartnerMessageName: string
Title:
NameMaximum Length:256 -
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100 -
ServiceProviderId: integer
(int64)
-
UserDefinedFlag: boolean
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 -
DvmName: string
Read Only:
trueMaximum Length:256 -
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true -
MessageId: integer
(int64)
Read Only:
true -
MessageName: string
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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
- ServiceProviderId:
- documents
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/documentsParameters:
- ServiceProviderId:
$request.path.ServiceProviderId
- ServiceProviderId:
- inboundCollaborationMessages
-
Parameters:
- ServiceProviderId:
$request.path.ServiceProviderId
- ServiceProviderId:
- outboundCollaborationMessages
-
Parameters:
- ServiceProviderId:
$request.path.ServiceProviderId
- ServiceProviderId: