Jump to

• Request
• Response

Update one B2B supplier partner

patch

/fscmRestApi/resources/11.13.18.05/b2bSupplierPartnerProperties/{PartnerPropertyId}

Request

Path Parameters

• PartnerPropertyId(required): integer(int64)
  Value that uniquely identifies the B2B supplier partner. This serves as the primary key.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicationPartnerCode: string
  Maximum Length: 240

  Value that uniquely identifies the application partner code. This code identifies the supplier site, customer, or customer account in inbound message processing.
• DvmGroup: string
  Title: Domain Value Map

  Maximum Length: 256

  Value that identifies the domain-value map associated with the supplier partner.
• PartnerId: string
  Title: Trading Partner ID

  Maximum Length: 100

  Value that identifies the trading partner.
• PartnerIdTypeCode: string
  Maximum Length: 30

  Code that identifies the type of trading partner ID. This code is one of the lookup values in the lookup type ORA_CMK_EXT_PTNR_ID_TYPE. For example, ORA_Name.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider.

{
    "type":"object",
    "properties":{
        "PartnerId":{
            "title":"Trading Partner ID",
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the trading partner.",
            "nullable":true
        },
        "DvmGroup":{
            "title":"Domain Value Map",
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the domain-value map associated with the supplier partner.",
            "nullable":true
        },
        "PartnerIdTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the type of trading partner ID. This code is one of the lookup values in the lookup type ORA_CMK_EXT_PTNR_ID_TYPE. For example, ORA_Name.",
            "nullable":true
        },
        "ApplicationPartnerCode":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site, customer, or customer account in inbound message processing.",
            "nullable":true
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : b2bSupplierPartnerProperties-item-response

Type: object

Show Source

• ApplicationPartnerCode: string
  Maximum Length: 240

  Value that uniquely identifies the application partner code. This code identifies the supplier site, customer, or customer account in inbound message processing.
• DvmGroup: string
  Title: Domain Value Map

  Maximum Length: 256

  Value that identifies the domain-value map associated with the supplier partner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Title: Trading Partner ID

  Maximum Length: 100

  Value that identifies the trading partner.
• PartnerIdType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that identifies the type of trading partner identifier. This value represents the meaning of the lookup code specified for PartnerIdTypeCode. For example, Name.
• PartnerIdTypeCode: string
  Maximum Length: 30

  Code that identifies the type of trading partner ID. This code is one of the lookup values in the lookup type ORA_CMK_EXT_PTNR_ID_TYPE. For example, ORA_Name.
• PartnerPropertyId: integer (int64)
  Value that uniquely identifies the B2B supplier partner. This serves as the primary key.
• PartnerSetupRequired: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that indicates whether partner setup is required for B2B messaging.
• PartnerTypeCode: string
  Maximum Length: 30

  Code that identifies the type of partner. This code is one of the lookup values for the lookup type ORA_CMK_PARTNER_ROLE.
• ProcurementBU: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Procurement business unit.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider.
• ServiceProviderName: string
  Read Only: true

  Maximum Length: 256

  Name of the service provider.
• Supplier: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Value that identifies the supplier by name.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Title: Supplier Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the supplier.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Value that identifies the supplier site by name.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "ProcurementBU":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProviderName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the service provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the type of partner. This code is one of the lookup values for the lookup type ORA_CMK_PARTNER_ROLE.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerSetupRequired":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether partner setup is required for B2B messaging.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Trading Partner ID",
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "DvmGroup":{
            "title":"Domain Value Map",
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the domain-value map associated with the supplier partner.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerPropertyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the B2B supplier partner. This serves as the primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. ",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerIdTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the type of trading partner ID. This code is one of the lookup values in the lookup type ORA_CMK_EXT_PTNR_ID_TYPE. For example, ORA_Name.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site. ",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the supplier site by name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Value that identifies the supplier by name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationPartnerCode":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the application partner code. This code identifies the supplier site, customer, or customer account in inbound message processing.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerIdType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the type of trading partner identifier. This value represents the meaning of the lookup code specified for PartnerIdTypeCode. For example, Name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Back to Top