REST API for Oracle Fusion Cloud SCM

Update one application partner

patch

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

Request

Path Parameters

ApplicationPartnerId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

application/json

Root Schema : Discriminator: PartnerKeyType

Type: object

Discriminator: PartnerKeyType

{
    "discriminator":{
        "propertyName":"PartnerKeyType",
        "mapping":{
            "CustomerAccount":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request",
            "SoldToParty":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request",
            "Supplier Site":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersVO-patch-item"
}

Match One Schema

Show Source

CustomerAccount - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request
SoldToParty - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request
Supplier Site - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request

{
    "discriminator":{
        "propertyName":"PartnerKeyType",
        "mapping":{
            "CustomerAccount":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request",
            "SoldToParty":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request",
            "Supplier Site":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersVO-patch-item"
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request

Type: object

Show Source

documents: array Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.

{
    "type":"object",
    "properties":{
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-patch-request

Type: object

Show Source

BusinessUnit: string
documents: array Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.

{
    "type":"object",
    "properties":{
        "BusinessUnit":{
            "type":"string",
            "nullable":true
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request

Type: object

Show Source

documents: array Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.

{
    "type":"object",
    "properties":{
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
            }
        }
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object schema

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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.
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.

{
    "type":"object",
    "properties":{
        "ApplicationPartnerDocumentStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Direction":{
            "type":"string",
            "description":"Value that identifies the direction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "DocumentDescription":{
            "type":"string",
            "description":"Value that identifies the collaboration document description.",
            "nullable":true
        },
        "PrimaryRecipientFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies the primary recipient document.",
            "nullable":true,
            "x-queryable":false
        },
        "SenderRole":{
            "type":"string",
            "description":"Value that identifies the sender role.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the application partner document was created or updated.",
            "format":"date-time",
            "nullable":false
        }
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object schema

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object schema

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
    }
}

Response

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

Type: object

Discriminator: PartnerKeyType

Discriminator Values

CustomerAccount
SoldToParty
Supplier Site

{
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersVO-item"
}

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

{
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersVO-item"
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-response

Type: object

Show Source

ApplicationPartnerId: integer (int64)

Value that uniquely identifies the application partner. It's 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
CustomerName: string

Maximum Length: 512
CustomerNumber: string

Maximum Length: 256
documents: array Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.
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.

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the application partner. It's a primary key that the application generates when it creates a application partner record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates an application partner status. This value is defaults to Matched.",
            "nullable":true,
            "default":"Matched",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerAccountNumber":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "CustomerName":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "CustomerNumber":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.",
            "nullable":false,
            "default":"CustomerAccount"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "description":"Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-response

Type: object

Show Source

ApplicationPartnerId: integer (int64)

Value that uniquely identifies the application partner. It's 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
CustomerId: string

Maximum Length: 256
CustomerName: string

Maximum Length: 512
CustomerNumber: string

Maximum Length: 256
documents: array Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.
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.

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the application partner. It's a primary key that the application generates when it creates a application partner record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates an application partner status. This value is defaults to Matched.",
            "nullable":true,
            "default":"Matched",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnit":{
            "type":"string",
            "nullable":true
        },
        "CustomerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "CustomerName":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "CustomerNumber":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.",
            "nullable":false,
            "default":"SoldToParty"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "description":"Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-response

Type: object

Show Source

ApplicationPartnerId: integer (int64)

Value that uniquely identifies the application partner. It's 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 Application Partner Documents

Title: Application Partner Documents

A B2B document that an application partner exchanges.
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.
SPUserDefined: string

Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.
Supplier: string

Maximum Length: 512
SupplierId: string

Maximum Length: 256
SupplierNumber: string

Maximum Length: 512
SupplierSite: string

Maximum Length: 512
SupplierSiteId: string

Maximum Length: 256
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.

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the application partner. It's a primary key that the application generates when it creates a application partner record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates an application partner status. This value is defaults to Matched.",
            "nullable":true,
            "default":"Matched",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner name.",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates a partner key type. Values include Supplier Site, SoldToParty, and CustomerAccount.",
            "nullable":false,
            "default":"Supplier Site"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site or customer or customer account in inbound message processing.",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "Supplier":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "SupplierId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SupplierNumber":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "SupplierSite":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "SupplierSiteId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "TradingPartner":{
            "type":"string",
            "description":"Identifier of the trading partner, each trading partner identifier also has a trading partner identifier type.",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner and is a derived value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "title":"Application Partner Documents",
            "type":"array",
            "description":"A B2B document that an application partner exchanges.",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object b2bApplicationPartners-documents-item-response

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : b2bApplicationPartners-documents-item-response

Type: object

Show Source

ApplicationPartnerDocumentId: integer (int64)

Value that uniquely identifies one of the application partner's documents. It's 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.

{
    "type":"object",
    "properties":{
        "ApplicationPartnerDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies one of the application partner's documents. It's a primary key that the application generates when it creates a application partner document record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplicationPartnerDocumentStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Direction":{
            "type":"string",
            "description":"Value that identifies the direction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "DocumentDescription":{
            "type":"string",
            "description":"Value that identifies the collaboration document description.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentName":{
            "type":"string",
            "description":"Value that identifies the collaboration document name.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryRecipientFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies the primary recipient document.",
            "nullable":true,
            "x-queryable":false
        },
        "SenderRole":{
            "type":"string",
            "description":"Value that identifies the sender role.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the application partner document was created or updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object b2bApplicationPartners-documents-item-response

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Application Partner Documents

Type: array

Title: Application Partner Documents

A B2B document that an application partner exchanges.

Show Source

Array of: object b2bApplicationPartners-documents-item-response

{
    "title":"Application Partner Documents",
    "type":"array",
    "description":"A B2B document that an application partner exchanges.",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

documents

Operation: /fscmRestApi/resources/11.13.18.05/b2bApplicationPartners/{ApplicationPartnerId}/child/documents

Parameters:

ApplicationPartnerId: $request.path.ApplicationPartnerId

serviceProvidersLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders

The following properties are defined on the LOV link relation:

Source Attribute: ServiceProviderId; Target Attribute: ServiceProviderId
Display Attribute: ServiceProviderName

tradingPartnerIdTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners

The following properties are defined on the LOV link relation:

Source Attribute: TradingPartnerIdType; Target Attribute: LookupCode
Display Attribute: Meaning

tradingPartnersLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners

Parameters:

finder: ByServiceProviderFinder%3BbindServiceProviderId%3D{ServiceProviderId}

The following properties are defined on the LOV link relation:

Source Attribute: TradingPartnerId; Target Attribute: TradingPartnerId
Display Attribute: TradingPartner

Examples

This example describes how to update one application partner.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/ApplicationPartnerId"

Example Request Body

The following example includes the contents of the request body in JSON format. 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 updates.

{
"DvmGroup": "Rupee"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "ApplicationPartnerStatus": "Matched",
  "TradingPartnerId": 300100186134973,
  "DvmGroup": "Rupee",
  "PartnerKeyType": "SoldToParty",
  "ProcessingActionCode": "1001",
  "ServiceProviderId": 300100186134957,
  "ApplicationPartnerId": 300100186137263,
  "ServiceProviderName": "TEST_SP",
  "TradingPartner": "TEST_SP_TP",
  "TradingPartnerIdType": "ORA_Generic",
  "PartnerId": null,
  "PartnerIdType": null,
  "CustomerId": "1001",
  "CustomerNumber": "1001",
  "CustomerName": "Small, Inc.",
  "BusinessUnit": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263",
      "name": "b2bApplicationPartners",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263",
      "name": "b2bApplicationPartners",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263/child/documents",
      "name": "documents",
      "kind": "collection"
    }
  ]
}