Jump to

• Request
• Response
• Examples

Update one application partner

patch

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

Request

Path Parameters

• ApplicationPartnerId(required): 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

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-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"
        }
    ]
}

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"
        }
    ]
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-patch-request

Type: object

Show Source

• documents: array documents
• DvmGroup: string
  Maximum Length: 256

  Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner.
• PartnerId: string
  Maximum Length: 256

  Value that uniquely identifies the buyer trading partner name.
• PartnerIdType: string
  Maximum Length: 100

  Value that uniquely identifies the buyer trading partner type.
• 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.

{
    "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
        },
        "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "documents":{
            "type":"array",
            "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
  Value that identifies the customer's business unit.
• documents: array documents
• DvmGroup: string
  Maximum Length: 256

  Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner.
• PartnerId: string
  Maximum Length: 256

  Value that uniquely identifies the buyer trading partner name.
• PartnerIdType: string
  Maximum Length: 100

  Value that uniquely identifies the buyer trading partner type.
• 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.

{
    "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
        },
        "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
            }
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Value that identifies the customer's business unit.",
            "nullable":true
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-patch-request

Type: object

Show Source

• documents: array documents
• DvmGroup: string
  Maximum Length: 256

  Value that identifies the domain-value map for the trading partner. This value is the same as the trading partner qualifier used when setting up the domain values for the selected trading partner.
• PartnerId: string
  Maximum Length: 256

  Value that uniquely identifies the buyer trading partner name.
• PartnerIdType: string
  Maximum Length: 100

  Value that uniquely identifies the buyer trading partner type.
• 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.

{
    "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
        },
        "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
            }
        }
    }
}

Nested Schema : documents

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "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":{
        "PrimaryRecipientFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies the primary recipient document.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the application partner document was created or updated.",
            "format":"date-time",
            "nullable":false
        },
        "DocumentDescription":{
            "type":"string",
            "description":"Value that identifies the collaboration document description.",
            "nullable":true
        },
        "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"
            }
        },
        "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"
            }
        },
        "SenderRole":{
            "type":"string",
            "description":"Value that identifies the sender role.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "Direction":{
            "type":"string",
            "description":"Value that identifies the direction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : documents

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
    }
}

Nested Schema : documents

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-patch-request"
    }
}

Back to Top

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.

Body ()

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"
        }
    ]
}

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"
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "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"
            }
        },
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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",
            "description":"Value that uniquely identifies the customer's account.",
            "nullable":true
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "CustomerNumber":{
            "maxLength":"256",
            "type":"string",
            "description":"Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount.",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount.",
            "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "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"
            }
        },
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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"
            }
        },
        "CustomerId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the customer. This attribute is a foreign key reference to the customer and it is a derived value.",
            "nullable":true
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "CustomerNumber":{
            "maxLength":"256",
            "type":"string",
            "description":"Number that uniquely identifies the customer, and is required when PartnerKeyType is equal to SoldToParty or CustomerAccount.",
            "nullable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Value that identifies the customer's business unit.",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the customer, this is a derived value when the PartnerKeyType is SoldToParty or CustomerAccount.",
            "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Value that identifies the service provider name.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-response"
            }
        },
        "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"
            }
        },
        "ApplicationPartnerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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"
            }
        },
        "SupplierNumber":{
            "maxLength":"512",
            "type":"string",
            "description":"Number that uniquely identifies the supplier and is required when the PartnerKeyType is equal to Supplier Site.",
            "nullable":true
        },
        "TradingPartnerIdType":{
            "type":"string",
            "description":"Value that uniquely identifies the trading partner type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the supplier. This attribute is a forgeign key reference  to the supplier and it is a derived value.",
            "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
        },
        "SupplierSiteId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the supplier site. This attribute is a forgeign key reference  to the supplier site and it is a derived value.",
            "nullable":true
        },
        "SupplierSite":{
            "maxLength":"512",
            "type":"string",
            "description":"Value that identifies the supplier site by name.",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "maxLength":"512",
            "type":"string",
            "description":"Value that identifies the supplier name.",
            "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
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the buyer trading partner type.",
            "nullable":true
        }
    }
}

Nested Schema : documents

Type: array

Show Source

• Array of: object b2bApplicationPartners-documents-item-response

{
    "type":"array",
    "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 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.

{
    "type":"object",
    "properties":{
        "PrimaryRecipientFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies the primary recipient document.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusDate":{
            "type":"string",
            "description":"Date when the application partner document was created or updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentDescription":{
            "type":"string",
            "description":"Value that identifies the collaboration document description.",
            "nullable":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplicationPartnerDocumentId":{
            "type":"integer",
            "description":"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.",
            "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
        },
        "SenderRole":{
            "type":"string",
            "description":"Value that identifies the sender role.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "Direction":{
            "type":"string",
            "description":"Value that identifies the direction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "DocumentName":{
            "type":"string",
            "description":"Value that identifies the collaboration document name.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : documents

Type: array

Show Source

• Array of: object b2bApplicationPartners-documents-item-response

{
    "type":"array",
    "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 : documents

Type: array

Show Source

• Array of: object b2bApplicationPartners-documents-item-response

{
    "type":"array",
    "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

The Application Partner Documents resource gets all the documents associated with the application partner that cross reference between fusion applications and trading partners for business-to-business message processing.

serviceProvidersLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders

List of values for the service providers of the application partner.

The following properties are defined on the LOV link relation:

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

tradingPartnerIdTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners

List of values for the trading partner types.

The following properties are defined on the LOV link relation:

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

tradingPartnersLOV

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners

Parameters:

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

List of values for the tarding partners of the application partner.

The following properties are defined on the LOV link relation:

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

Back to Top

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"
    }
  ]
}

Back to Top