Jump to

• Request
• Response
• Examples

Create

post

/fscmRestApi/resources/11.13.18.05/b2bApplicationPartners

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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-post-request",
            "SoldToParty":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-post-request",
            "Supplier Site":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-post-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-post-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-post-request"
        }
    ]
}

Match One Schema

Show Source

• CustomerAccount - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-post-request
• SoldToParty - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-post-request
• Supplier Site - object oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-post-request

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

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToCustomerAccountVO-item-post-request

Type: object

Show Source

• ApplicationPartnerId: integer (int64)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• CustomerAccountNumber: string
  Maximum Length: 256
• CustomerName: string
  Maximum Length: 512
• CustomerNumber: string
  Maximum Length: 256
• DvmGroup: string
  Maximum Length: 256
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType(required): string
  Maximum Length: 100

  Default Value: CustomerAccount
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId(required): integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• TradingPartner(required): string
• TradingPartnerId: integer (int64)
• TradingPartnerIdType(required): string

{
    "required":[
        "PartnerKeyType",
        "ServiceProviderId",
        "TradingPartner",
        "TradingPartnerIdType"
    ],
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "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",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"CustomerAccount"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSoldToPartyVO-item-post-request

Type: object

Show Source

• ApplicationPartnerId: integer (int64)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• BusinessUnit: string
• CustomerId: string
  Maximum Length: 256
• CustomerName: string
  Maximum Length: 512
• CustomerNumber: string
  Maximum Length: 256
• DvmGroup: string
  Maximum Length: 256
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType(required): string
  Maximum Length: 100

  Default Value: SoldToParty
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId(required): integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• TradingPartner(required): string
• TradingPartnerId: integer (int64)
• TradingPartnerIdType(required): string

{
    "required":[
        "PartnerKeyType",
        "ServiceProviderId",
        "TradingPartner",
        "TradingPartnerIdType"
    ],
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "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",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"SoldToParty"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : oracle_apps_scm_cmk_collaborationMessagingSetup_restModel_view_ApplicationPartnersToSupplierSiteVO-item-post-request

Type: object

Show Source

• ApplicationPartnerId: integer (int64)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• documents: array documents
• DvmGroup: string
  Maximum Length: 256
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType(required): string
  Maximum Length: 100

  Default Value: Supplier Site
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId(required): integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• 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(required): string
• TradingPartnerId: integer (int64)
• TradingPartnerIdType(required): string

{
    "required":[
        "PartnerKeyType",
        "ServiceProviderId",
        "TradingPartner",
        "TradingPartnerIdType"
    ],
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "default":"Matched",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"Supplier Site"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "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",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bApplicationPartners-documents-item-post-request"
            }
        }
    }
}

Nested Schema : documents

Type: array

Show Source

• Array of: object b2bApplicationPartners-documents-item-post-request

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

Nested Schema : b2bApplicationPartners-documents-item-post-request

Type: object

Show Source

• ApplicationPartnerDocumentId: integer (int64)
• ApplicationPartnerDocumentStatus: string
  Maximum Length: 100
• Direction: string
• DocumentDescription: string
• DocumentId: integer (int64)
• DocumentName: string
• PrimaryRecipientFlag: boolean
  Maximum Length: 1
• SenderRole: string
• ServiceProviderId: integer
• StatusDate: string (date-time)

{
    "type":"object",
    "properties":{
        "ApplicationPartnerDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerDocumentStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Direction":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "DocumentDescription":{
            "type":"string",
            "nullable":true
        },
        "DocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DocumentName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryRecipientFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "SenderRole":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false
        }
    }
}

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)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• CustomerAccountNumber: string
  Maximum Length: 256
• CustomerName: string
  Maximum Length: 512
• CustomerNumber: string
  Maximum Length: 256
• documents: array documents
• DvmGroup: string
  Maximum Length: 256
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType: string
  Maximum Length: 100

  Default Value: CustomerAccount
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId: integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• TradingPartner: string
• TradingPartnerId: integer (int64)
• TradingPartnerIdType: string

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "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",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"CustomerAccount"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "type":"array",
            "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)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• BusinessUnit: string
• CustomerId: string
  Maximum Length: 256
• CustomerName: string
  Maximum Length: 512
• CustomerNumber: string
  Maximum Length: 256
• documents: array documents
• DvmGroup: string
  Maximum Length: 256
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType: string
  Maximum Length: 100

  Default Value: SoldToParty
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId: integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• TradingPartner: string
• TradingPartnerId: integer (int64)
• TradingPartnerIdType: string

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "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",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"SoldToParty"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartner":{
            "type":"string",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "type":"array",
            "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)
• ApplicationPartnerStatus: string
  Maximum Length: 100

  Default Value: Matched
• documents: array documents
• DvmGroup: string
  Maximum Length: 256
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Maximum Length: 256
• PartnerIdType: string
  Maximum Length: 100
• PartnerKeyType: string
  Maximum Length: 100

  Default Value: Supplier Site
• ProcessingActionCode: string
  Title: Application Partner Code

  Maximum Length: 256
• ServiceProviderId: integer (int64)
  Title: Service Provider
• ServiceProviderName: string
• SPUserDefined: string
• 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
• TradingPartnerId: integer (int64)
• TradingPartnerIdType: string

{
    "type":"object",
    "properties":{
        "ApplicationPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApplicationPartnerStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "default":"Matched",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DvmGroup":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerKeyType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "default":"Supplier Site"
        },
        "ProcessingActionCode":{
            "title":"Application Partner Code",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "title":"Service Provider",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ServiceProviderName":{
            "type":"string",
            "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",
            "nullable":false,
            "x-queryable":false
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "TradingPartnerIdType":{
            "type":"string",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "type":"array",
            "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 : 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)
• ApplicationPartnerDocumentStatus: string
  Maximum Length: 100
• Direction: string
• DocumentDescription: string
• DocumentId: integer (int64)
• DocumentName: string
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryRecipientFlag: boolean
  Maximum Length: 1
• SenderRole: string
• ServiceProviderId: integer
• StatusDate: string (date-time)

{
    "type":"object",
    "properties":{
        "ApplicationPartnerDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplicationPartnerDocumentStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Direction":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "DocumentDescription":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryRecipientFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "SenderRole":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StatusDate":{
            "type":"string",
            "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 : 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

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

Back to Top

Examples

This example describes how to create one application partner.

Example cURL Command

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

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

Example 1 Request Body

The following example includes the contents of the request body in JSON format to create an application partner using customer collaboration configuration. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"CustomerNumber": "1001",
	"PartnerKeyType": "SoldToParty",
	"ServiceProviderName": "TEST_SP",
	"TradingPartner": "TEST_SP_TP",
	"TradingPartnerIdType": "ORA_Generic",
	"PartnerId": "Partner ID 1",
	"BusinessUnit": "10_CRM_MultiBU",
	"ProcessingActionCode": "1234",
	"DvmGroup": "ABCDEFG"
}

Example 1 Response Body

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

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

Example 2 Request Body

The following example includes the contents of the request body in JSON format to create an application partner using supplier collaboration configuration. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"SupplierNumber": "515571",
	"SupplierSite": "Sacramento",
	"PartnerKeyType": "Supplier Site",
	"ServiceProviderName": "TEST_SP",
	"TradingPartner": "TEST_SP_TP",
	"TradingPartnerIdType": "ORA_Generic",
	"PartnerId": "Partner ID 1",
	"ProcessingActionCode": " 515571-Sacramento",
	"DvmGroup": "ABCDEFG"
}

Example 2 Response Body

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

{
	"ApplicationPartnerStatus": "Matched",
	"TradingPartnerId": 300100186134973,
	"DvmGroup": "ABCDEFG",
	"PartnerKeyType": "Supplier Site",
	"ProcessingActionCode": " 515571-Sacramento",
	"ServiceProviderId": 300100186134957,
	"ApplicationPartnerId": 300100186140512,
	"ServiceProviderName": "TEST_SP",
	"TradingPartner": "TEST_SP_TP",
	"TradingPartnerIdType": "ORA_Generic",
	"PartnerId": "Partner ID 1",
	"PartnerIdType": null,
	"SupplierId": "300100016486225",
	"SupplierSiteId": "300100129803123",
	"Supplier": "Advanced Devices",
	"SupplierNumber": "515571",
	"SupplierSite": "Sacramento",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512",
		"name": "b2bApplicationPartners",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512",
		"name": "b2bApplicationPartners",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186140512/child/documents",
		"name": "documents",
		"kind": "collection"
	}
	]
}

Back to Top