Get all application partners
get
/fscmRestApi/resources/11.13.18.05/b2bApplicationPartners
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find application partners according to the unique application partner identifier.
Finder Variables:- ApplicationPartnerId; integer; 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.
- PrimaryKey: Find application partners according to the unique application partner identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : b2bApplicationPartners
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Items
Type:
array
Title:
Items
The items in the collection.
Show Source
-
Array of:
object Discriminator: PartnerKeyType
Discriminator:
{ "propertyName":"PartnerKeyType", "mapping":{ "CustomerAccount":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response", "SoldToParty":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response", "Supplier Site":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: PartnerKeyType
Type:
object
Discriminator: PartnerKeyType
Discriminator Values
Match One Schema
Show Source
-
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
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response
Type:
Show Source
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.
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response
Type:
Show Source
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.
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bApplicationPartners-documents-item-response
Type:
Show Source
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all application partners.
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/b2bApplicationPartners"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ApplicationPartnerStatus": "Matched", "TradingPartnerId": 300100083098945, "DvmGroup": "1427736239-CMKQA_MNYST2", "PartnerKeyType": "Supplier Site", "ProcessingActionCode": "1427736239-CMKQA_MNYST2", "ServiceProviderId": 50044, "ApplicationPartnerId": 300100083098984, "ServiceProviderName": "OracleSNTest", "TradingPartner": "CMKQAOSN_MULTSITES", "TradingPartnerIdType": "ORA_MISC", "PartnerId": null, "PartnerIdType": null, "SupplierId": "300100076618084", "SupplierSiteId": "300100076618116", "Supplier": "CMKQASUP_MNYSTS", "SupplierNumber": "1427736239", "SupplierSite": "CMKQA_MNYST2", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100083098984", "name": "b2bApplicationPartners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100083098984", "name": "b2bApplicationPartners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100083098984/child/documents", "name": "documents", "kind": "collection" } ] }, { "ApplicationPartnerStatus": "Matched", "TradingPartnerId": 300100073922568, "DvmGroup": "RRFST_NONE", "PartnerKeyType": "Supplier Site", "ProcessingActionCode": "RRFST_NONE", "ServiceProviderId": 50055, "ApplicationPartnerId": 300100073922577, "ServiceProviderName": "None", "TradingPartner": "CMKRRF_NONE_EXT", "TradingPartnerIdType": "ORA_Generic", "PartnerId": null, "PartnerIdType": null, "SupplierId": "300100073922525", "SupplierSiteId": "300100073922542", "Supplier": "RRFSUP_NONE", "SupplierNumber": "1427736174", "SupplierSite": "RRFST_NONE", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100073922577", "name": "b2bApplicationPartners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100073922577", "name": "b2bApplicationPartners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100073922577/child/documents", "name": "documents", "kind": "collection" } ] }, ], "count": 2, "hasMore": true, "limit": 2, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners", "name": "b2bApplicationPartners", "kind": "collection" } ] }