Create application partners
/fscmRestApi/resources/11.13.18.05/b2bApplicationPartners
Request
-
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.
-
Upsert-Mode:
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.
- application/json
object
Discriminator Values
-
CustomerAccount -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-post-request
-
SoldToParty -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-post-request
-
Supplier Site -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-post-request
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
CustomerAccountNumber: string
Maximum Length:
256
Value that uniquely identifies the customer's account. -
CustomerName: string
Maximum Length:
512
Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount. -
CustomerNumber: string
Maximum Length:
256
Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount. -
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType(required): string
Maximum Length:
100
Default Value:CustomerAccount
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId(required): integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
TradingPartner(required): string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType(required): string
Value that uniquely identifies the trading partner type.
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
BusinessUnit: string
Value that identifies the customer's business unit.
-
CustomerId: string
Maximum Length:
256
Value that uniquely identifies the customer. This attribute is a foreign key reference to the customer and it is a derived value. -
CustomerName: string
Maximum Length:
512
Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount. -
CustomerNumber: string
Maximum Length:
256
Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount. -
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType(required): string
Maximum Length:
100
Default Value:SoldToParty
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId(required): integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
TradingPartner(required): string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType(required): string
Value that uniquely identifies the trading partner type.
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
documents: array
documents
-
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType(required): string
Maximum Length:
100
Default Value:Supplier Site
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId(required): integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
Supplier: string
Maximum Length:
512
Value that identifies the supplier name. -
SupplierId: string
Maximum Length:
256
Value that uniquely identifies the supplier. This attribute is a forgeign key reference to the supplier and it is a derived value. -
SupplierNumber: string
Maximum Length:
512
Number that uniquely identifies the supplier and is required when the PartnerKeyType is equal to Supplier Site. -
SupplierSite: string
Maximum Length:
512
Value that identifies the supplier site by name. -
SupplierSiteId: string
Maximum Length:
256
Value that uniquely identifies the supplier site. This attribute is a forgeign key reference to the supplier site and it is a derived value. -
TradingPartner(required): string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType(required): string
Value that uniquely identifies the trading partner type.
object
-
ApplicationPartnerDocumentId: integer
(int64)
Value that uniquely identifies one of the application partner's documents. It is a primary key that the application generates when it creates a application partner document record. This attribute is required.
-
ApplicationPartnerDocumentStatus: string
Maximum Length:
100
Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled. -
Direction: string
Value that identifies the direction.
-
DocumentDescription: string
Value that identifies the collaboration document description.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Value that identifies the collaboration document name.
-
PrimaryRecipientFlag: boolean
Maximum Length:
1
Value that identifies the primary recipient document. -
SenderRole: string
Value that identifies the sender role.
-
ServiceProviderId: integer
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
StatusDate: string
(date-time)
Date when the application partner document was created or updated.
Response
- application/json
Default Response
-
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.
object
Discriminator Values
-
CustomerAccount -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response
-
SoldToParty -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response
-
Supplier Site -
object
oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
CustomerAccountNumber: string
Maximum Length:
256
Value that uniquely identifies the customer's account. -
CustomerName: string
Maximum Length:
512
Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount. -
CustomerNumber: string
Maximum Length:
256
Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount. -
documents: array
documents
-
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType: string
Maximum Length:
100
Default Value:CustomerAccount
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId: integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
TradingPartner: string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType: string
Value that uniquely identifies the trading partner type.
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
BusinessUnit: string
Value that identifies the customer's business unit.
-
CustomerId: string
Maximum Length:
256
Value that uniquely identifies the customer. This attribute is a foreign key reference to the customer and it is a derived value. -
CustomerName: string
Maximum Length:
512
Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount. -
CustomerNumber: string
Maximum Length:
256
Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount. -
documents: array
documents
-
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType: string
Maximum Length:
100
Default Value:SoldToParty
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId: integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
TradingPartner: string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType: string
Value that uniquely identifies the trading partner type.
object
-
ApplicationPartnerId: integer
(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
-
ApplicationPartnerStatus: string
Maximum Length:
100
Default Value:Matched
Value that indicates an application partner status. This value is defaults to Matched. -
documents: array
documents
-
DvmGroup: string
Maximum Length:
256
Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerId: string
Maximum Length:
256
Value that uniquely identifies the buyer trading partner name. -
PartnerIdType: string
Maximum Length:
100
Value that uniquely identifies the buyer trading partner type. -
PartnerKeyType: string
Maximum Length:
100
Default Value:Supplier Site
Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount. -
ProcessingActionCode: string
Title:
Application Partner Code
Maximum Length:256
Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing. -
ServiceProviderId: integer
(int64)
Title:
Service Provider
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider. -
ServiceProviderName: string
Value that identifies the service provider name.
-
Supplier: string
Maximum Length:
512
Value that identifies the supplier name. -
SupplierId: string
Maximum Length:
256
Value that uniquely identifies the supplier. This attribute is a forgeign key reference to the supplier and it is a derived value. -
SupplierNumber: string
Maximum Length:
512
Number that uniquely identifies the supplier and is required when the PartnerKeyType is equal to Supplier Site. -
SupplierSite: string
Maximum Length:
512
Value that identifies the supplier site by name. -
SupplierSiteId: string
Maximum Length:
256
Value that uniquely identifies the supplier site. This attribute is a forgeign key reference to the supplier site and it is a derived value. -
TradingPartner: string
Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
-
TradingPartnerId: integer
(int64)
Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
-
TradingPartnerIdType: string
Value that uniquely identifies the trading partner type.
array
Links
object
-
ApplicationPartnerDocumentId: integer
(int64)
Value that uniquely identifies one of the application partner's documents. It is a primary key that the application generates when it creates a application partner document record. This attribute is required.
-
ApplicationPartnerDocumentStatus: string
Maximum Length:
100
Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled. -
Direction: string
Value that identifies the direction.
-
DocumentDescription: string
Value that identifies the collaboration document description.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Value that identifies the collaboration document name.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryRecipientFlag: boolean
Maximum Length:
1
Value that identifies the primary recipient document. -
SenderRole: string
Value that identifies the sender role.
-
ServiceProviderId: integer
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
StatusDate: string
(date-time)
Date when the application partner document was created or updated.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
array
Links
array
Links
- documents
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bApplicationPartners/{ApplicationPartnerId}/child/documentsParameters:
- ApplicationPartnerId:
$request.path.ApplicationPartnerId
The Application Partner Documents resource gets all the documents associated with the application partner that cross reference between fusion applications and trading partners for business-to-business message processing. - ApplicationPartnerId:
- serviceProvidersLOV
-
List of values for the service providers of the application partner.
The following properties are defined on the LOV link relation:- Source Attribute: ServiceProviderId; Target Attribute: ServiceProviderId
- Display Attribute: ServiceProviderName
- tradingPartnerIdTypeLOV
-
List of values for the trading partner types.
The following properties are defined on the LOV link relation:- Source Attribute: TradingPartnerIdType; Target Attribute: LookupCode
- Display Attribute: Meaning
- tradingPartnersLOV
-
Parameters:
- finder:
ByServiceProviderFinder%3BbindServiceProviderId%3D{ServiceProviderId}
List of values for the tarding partners of the application partner.
The following properties are defined on the LOV link relation:- Source Attribute: TradingPartnerId; Target Attribute: TradingPartnerId
- Display Attribute: TradingPartner
- finder:
Examples
This example describes how to create one application partner.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/b2bApplicationPartners"
Example 1 Request Body
The following example includes the contents of the request body in JSON format to create an application partner using customer collaboration configuration. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "CustomerNumber": "1001", "PartnerKeyType": "SoldToParty", "ServiceProviderName": "TEST_SP", "TradingPartner": "TEST_SP_TP", "TradingPartnerIdType": "ORA_Generic", "PartnerId": "Partner ID 1", "BusinessUnit": "10_CRM_MultiBU", "ProcessingActionCode": "1234", "DvmGroup": "ABCDEFG" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "ApplicationPartnerStatus": "Matched", "TradingPartnerId": 300100186134973, "DvmGroup": "ABCDEFG", "PartnerKeyType": "SoldToParty", "ProcessingActionCode": "1234", "ServiceProviderId": 300100186134957, "ApplicationPartnerId": 300100186140473, "ServiceProviderName": "TEST_SP", "TradingPartner": "TEST_SP_TP", "TradingPartnerIdType": "ORA_Generic", "PartnerId": "Partner ID 1", "PartnerIdType": null, "CustomerId": "1001", "CustomerNumber": "1001", "CustomerName": "Small, Inc.", "BusinessUnit": "10_CRM_MultiBU", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140473", "name": "b2bApplicationPartners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140473", "name": "b2bApplicationPartners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140473/child/documents", "name": "documents", "kind": "collection" } ] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format to create an application partner using supplier collaboration configuration. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SupplierNumber": "515571", "SupplierSite": "Sacramento", "PartnerKeyType": "Supplier Site", "ServiceProviderName": "TEST_SP", "TradingPartner": "TEST_SP_TP", "TradingPartnerIdType": "ORA_Generic", "PartnerId": "Partner ID 1", "ProcessingActionCode": " 515571-Sacramento", "DvmGroup": "ABCDEFG" }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "ApplicationPartnerStatus": "Matched", "TradingPartnerId": 300100186134973, "DvmGroup": "ABCDEFG", "PartnerKeyType": "Supplier Site", "ProcessingActionCode": " 515571-Sacramento", "ServiceProviderId": 300100186134957, "ApplicationPartnerId": 300100186140512, "ServiceProviderName": "TEST_SP", "TradingPartner": "TEST_SP_TP", "TradingPartnerIdType": "ORA_Generic", "PartnerId": "Partner ID 1", "PartnerIdType": null, "SupplierId": "300100016486225", "SupplierSiteId": "300100129803123", "Supplier": "Advanced Devices", "SupplierNumber": "515571", "SupplierSite": "Sacramento", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512", "name": "b2bApplicationPartners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512", "name": "b2bApplicationPartners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512/child/documents", "name": "documents", "kind": "collection" } ] }