Get one application partner

get

/fscmRestApi/resources/11.13.18.05/b2bApplicationPartners/{ApplicationPartnerId}

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 : Discriminator: PartnerKeyType
Type: object
Discriminator: PartnerKeyType

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response
Type: object
Show Source
  • 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.
  • Maximum Length: 100
    Default Value: Matched
    Value that indicates an application partner status. This value is defaults to Matched.
  • Maximum Length: 256
    Value that uniquely identifies the customer's account.
  • Maximum Length: 512
    Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount.
  • Maximum Length: 256
    Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount.
  • documents
  • 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
  • Maximum Length: 256
    Value that uniquely identifies the buyer trading partner name.
  • Maximum Length: 100
    Value that uniquely identifies the buyer trading partner type.
  • Maximum Length: 100
    Default Value: CustomerAccount
    Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.
  • 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.
  • Title: Service Provider
    Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
  • Value that identifies the service provider name.
  • Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
  • Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
  • Value that uniquely identifies the trading partner type.
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response
Type: object
Show Source
  • 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.
  • Maximum Length: 100
    Default Value: Matched
    Value that indicates an application partner status. This value is defaults to Matched.
  • Value that identifies the customer's business unit.
  • 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.
  • Maximum Length: 512
    Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount.
  • Maximum Length: 256
    Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount.
  • documents
  • 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
  • Maximum Length: 256
    Value that uniquely identifies the buyer trading partner name.
  • Maximum Length: 100
    Value that uniquely identifies the buyer trading partner type.
  • Maximum Length: 100
    Default Value: SoldToParty
    Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.
  • 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.
  • Title: Service Provider
    Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
  • Value that identifies the service provider name.
  • Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
  • Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
  • Value that uniquely identifies the trading partner type.
Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response
Type: object
Show Source
  • 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.
  • Maximum Length: 100
    Default Value: Matched
    Value that indicates an application partner status. This value is defaults to Matched.
  • documents
  • 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
  • Maximum Length: 256
    Value that uniquely identifies the buyer trading partner name.
  • Maximum Length: 100
    Value that uniquely identifies the buyer trading partner type.
  • Maximum Length: 100
    Default Value: Supplier Site
    Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.
  • 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.
  • Title: Service Provider
    Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
  • Value that identifies the service provider name.
  • Maximum Length: 512
    Value that identifies the supplier name.
  • 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.
  • Maximum Length: 512
    Number that uniquely identifies the supplier and is required when the PartnerKeyType is equal to Supplier Site.
  • Maximum Length: 512
    Value that identifies the supplier site by name.
  • 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.
  • Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.
  • Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.
  • Value that uniquely identifies the trading partner type.
Nested Schema : documents
Type: array
Show Source
Nested Schema : b2bApplicationPartners-documents-item-response
Type: object
Show Source
Nested Schema : documents
Type: array
Show Source
Nested Schema : documents
Type: array
Show Source
Back to Top

Examples

This example describes how to get one application 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/b2bApplicationPartners/ApplicationPartnerId"

For example, the following command gets one application partner:

curl -u username:password "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100083098984"

Example Response Body

The following shows an example of the response body in JSON format.

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