Jump to

• Request
• Response

Patch the details of an external data provider for suppliers

patch

/fscmRestApi/resources/11.13.18.05/externalDataProviderForSuppliers/{ExternalDataProviderId}

Request

Path Parameters

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CompanyIconProviderAttr: string
  Title: Path for Company Logo

  Maximum Length: 4000

  Path in the external data provider response payload for the icon of the company returned as a match.
• CompanyNameProviderAttr: string
  Title: Path for Company Name

  Maximum Length: 4000

  Path in the external data provider response payload for the company name that's returned as a match.
• CompanyURLProviderAttr: string
  Title: Path for Company URL

  Maximum Length: 4000

  Path in the external data provider response payload for the website of the company returned as a match.
• CountryCode: string
  Title: Validate for Supplier Country

  Maximum Length: 4000

  Country code supported by the external data provider. The attribute can be left blank if all countries are supported.
• DetailsAPISessionMaximumCount: integer (int64)
  Title: Company Selection Limit per Session

  The maximum number of company selections a user can make in a session of the self-service supplier registration.
• EnabledFlag: boolean
  Title: Provider Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.
• ExternalDataProviderName: string
  Title: Provider Name

  Maximum Length: 4000

  Company name of the external data provider for suppliers.
• FirstAdditionalContext: string
  Title: Path for First Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.
• PrimaryFlag: boolean
  Title: Primary Provider

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.
• ProviderBackendName: string
  Title: Provider Back End Name

  Maximum Length: 64

  Name of the token relay and proxy back-end where the external data provider credentials are stored.
• ProviderIdentifier: string
  Title: Path for Company Identifier

  Maximum Length: 4000

  Path in the external data provider response payload that uniquely identifies the matched company. This value is required for enrichment integration.
• RestMethod: string
  Title: Validation Provider API Method

  Maximum Length: 255

  HTTP method supported by the external data provider. Valid values are POST, PATCH, and GET. This attribute is required for validation integrations.
• SearchAPISessionMaximumCount: integer (int64)
  Title: Company Search Limit per Session

  The maximum number of searches a user can make in a session of the self-service supplier registration.
• SearchCandidates: string
  Title: Path for List of Companies

  Maximum Length: 4000

  Path in the external data provider response payload for the search candidates returned as matches.
• SearchURL: string
  Title: Provider Search URL

  Maximum Length: 4000

  URL path segment for the external data provider supplier request, excluding the domain and protocol.
• SecondAdditionalContext: string
  Title: Path for Second Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.
• SummaryLookupType: string
  Title: Validation Status Lookup

  Maximum Length: 255

  Lookup type that defines the final validation statuses. This attribute is required for validation integrations.
• ThirdAdditionalContext: string
  Title: Path for Third Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.
• ValidatedAttribute: string
  Title: Attribute to Validate

  Maximum Length: 30

  Supplier attribute validated by the external data provider. For example, Taxpayer ID. This attribute is required for validation integrations.

{
    "type":"object",
    "properties":{
        "CompanyIconProviderAttr":{
            "title":"Path for Company Logo",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the icon of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CompanyNameProviderAttr":{
            "title":"Path for Company Name",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the company name that's returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CompanyURLProviderAttr":{
            "title":"Path for Company URL",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the website of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryCode":{
            "title":"Validate for Supplier Country",
            "maxLength":4000,
            "type":"string",
            "description":"Country code supported by the external data provider. The attribute can be left blank if all countries are supported.",
            "nullable":true
        },
        "DetailsAPISessionMaximumCount":{
            "title":"Company Selection Limit per Session",
            "type":"integer",
            "description":"The maximum number of company selections a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Provider Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.",
            "nullable":false,
            "default":true
        },
        "ExternalDataProviderName":{
            "title":"Provider Name",
            "maxLength":4000,
            "type":"string",
            "description":"Company name of the external data provider for suppliers.",
            "nullable":false,
            "x-queryable":false
        },
        "FirstAdditionalContext":{
            "title":"Path for First Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary Provider",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.",
            "nullable":false,
            "default":true
        },
        "ProviderBackendName":{
            "title":"Provider Back End Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the token relay and proxy back-end where the external data provider credentials are stored.",
            "nullable":true,
            "x-queryable":false
        },
        "ProviderIdentifier":{
            "title":"Path for Company Identifier",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload that uniquely identifies the matched company. This value is required for enrichment integration.",
            "nullable":true,
            "x-queryable":false
        },
        "RestMethod":{
            "title":"Validation Provider API Method",
            "maxLength":255,
            "type":"string",
            "description":"HTTP method supported by the external data provider. Valid values are POST, PATCH, and GET. This attribute is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchAPISessionMaximumCount":{
            "title":"Company Search Limit per Session",
            "type":"integer",
            "description":"The maximum number of searches a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SearchCandidates":{
            "title":"Path for List of Companies",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the search candidates returned as matches.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchURL":{
            "title":"Provider Search URL",
            "maxLength":4000,
            "type":"string",
            "description":"URL path segment for the external data provider supplier request, excluding the domain and protocol.",
            "nullable":false,
            "x-queryable":false
        },
        "SecondAdditionalContext":{
            "title":"Path for Second Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "SummaryLookupType":{
            "title":"Validation Status Lookup",
            "maxLength":255,
            "type":"string",
            "description":"Lookup type that defines the final validation statuses. This attribute is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "ThirdAdditionalContext":{
            "title":"Path for Third Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidatedAttribute":{
            "title":"Attribute to Validate",
            "maxLength":30,
            "type":"string",
            "description":"Supplier attribute validated by the external data provider. For example, Taxpayer ID. This attribute is required for validation integrations.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• CompanyIconProviderAttr: string
  Title: Path for Company Logo

  Maximum Length: 4000

  Path in the external data provider response payload for the icon of the company returned as a match.
• CompanyNameProviderAttr: string
  Title: Path for Company Name

  Maximum Length: 4000

  Path in the external data provider response payload for the company name that's returned as a match.
• CompanyURLProviderAttr: string
  Title: Path for Company URL

  Maximum Length: 4000

  Path in the external data provider response payload for the website of the company returned as a match.
• CountryCode: string
  Title: Validate for Supplier Country

  Maximum Length: 4000

  Country code supported by the external data provider. The attribute can be left blank if all countries are supported.
• DetailsAPISessionMaximumCount: integer (int64)
  Title: Company Selection Limit per Session

  The maximum number of company selections a user can make in a session of the self-service supplier registration.
• EnabledFlag: boolean
  Title: Provider Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.
• ExternalDataProviderCode: string
  Title: Provider Code

  Maximum Length: 255

  Abbreviation that identifies the external data provider for suppliers. For example, Vision Corporation is called VC.
• ExternalDataProviderId: integer (int64)
  Title: Provider ID

  External data provider for suppliers.
• ExternalDataProviderName: string
  Title: Provider Name

  Maximum Length: 4000

  Company name of the external data provider for suppliers.
• FirstAdditionalContext: string
  Title: Path for First Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: boolean
  Title: Primary Provider

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.
• ProviderBackendName: string
  Title: Provider Back End Name

  Maximum Length: 64

  Name of the token relay and proxy back-end where the external data provider credentials are stored.
• ProviderIdentifier: string
  Title: Path for Company Identifier

  Maximum Length: 4000

  Path in the external data provider response payload that uniquely identifies the matched company. This value is required for enrichment integration.
• ProviderType: string
  Title: Provider Integration Type

  Maximum Length: 255

  Indicates whether the integration supported by the external data provider is for validating a supplier profile attribute or for enriching the supplier profile. Valid values are Validation and Enrichment.
• RestMethod: string
  Title: Validation Provider API Method

  Maximum Length: 255

  HTTP method supported by the external data provider. Valid values are POST, PATCH, and GET. This attribute is required for validation integrations.
• SearchAPISessionMaximumCount: integer (int64)
  Title: Company Search Limit per Session

  The maximum number of searches a user can make in a session of the self-service supplier registration.
• SearchCandidates: string
  Title: Path for List of Companies

  Maximum Length: 4000

  Path in the external data provider response payload for the search candidates returned as matches.
• SearchURL: string
  Title: Provider Search URL

  Maximum Length: 4000

  URL path segment for the external data provider supplier request, excluding the domain and protocol.
• SecondAdditionalContext: string
  Title: Path for Second Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.
• SummaryLookupType: string
  Title: Validation Status Lookup

  Maximum Length: 255

  Lookup type that defines the final validation statuses. This attribute is required for validation integrations.
• ThirdAdditionalContext: string
  Title: Path for Third Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.
• ValidatedAttribute: string
  Title: Attribute to Validate

  Maximum Length: 30

  Supplier attribute validated by the external data provider. For example, Taxpayer ID. This attribute is required for validation integrations.

{
    "type":"object",
    "properties":{
        "CompanyIconProviderAttr":{
            "title":"Path for Company Logo",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the icon of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CompanyNameProviderAttr":{
            "title":"Path for Company Name",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the company name that's returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CompanyURLProviderAttr":{
            "title":"Path for Company URL",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the website of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryCode":{
            "title":"Validate for Supplier Country",
            "maxLength":4000,
            "type":"string",
            "description":"Country code supported by the external data provider. The attribute can be left blank if all countries are supported.",
            "nullable":true,
            "x-queryable":true
        },
        "DetailsAPISessionMaximumCount":{
            "title":"Company Selection Limit per Session",
            "type":"integer",
            "description":"The maximum number of company selections a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Provider Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ExternalDataProviderCode":{
            "title":"Provider Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the external data provider for suppliers. For example, Vision Corporation is called VC.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalDataProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"External data provider for suppliers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExternalDataProviderName":{
            "title":"Provider Name",
            "maxLength":4000,
            "type":"string",
            "description":"Company name of the external data provider for suppliers.",
            "nullable":false,
            "x-queryable":false
        },
        "FirstAdditionalContext":{
            "title":"Path for First Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary Provider",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ProviderBackendName":{
            "title":"Provider Back End Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the token relay and proxy back-end where the external data provider credentials are stored.",
            "nullable":true,
            "x-queryable":false
        },
        "ProviderIdentifier":{
            "title":"Path for Company Identifier",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload that uniquely identifies the matched company. This value is required for enrichment integration.",
            "nullable":true,
            "x-queryable":false
        },
        "ProviderType":{
            "title":"Provider Integration Type",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the integration supported by the external data provider is for validating a supplier profile attribute or for enriching the supplier profile. Valid values are Validation and Enrichment.",
            "nullable":false,
            "x-queryable":true
        },
        "RestMethod":{
            "title":"Validation Provider API Method",
            "maxLength":255,
            "type":"string",
            "description":"HTTP method supported by the external data provider. Valid values are POST, PATCH, and GET. This attribute is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchAPISessionMaximumCount":{
            "title":"Company Search Limit per Session",
            "type":"integer",
            "description":"The maximum number of searches a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SearchCandidates":{
            "title":"Path for List of Companies",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the search candidates returned as matches.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchURL":{
            "title":"Provider Search URL",
            "maxLength":4000,
            "type":"string",
            "description":"URL path segment for the external data provider supplier request, excluding the domain and protocol.",
            "nullable":false,
            "x-queryable":false
        },
        "SecondAdditionalContext":{
            "title":"Path for Second Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "SummaryLookupType":{
            "title":"Validation Status Lookup",
            "maxLength":255,
            "type":"string",
            "description":"Lookup type that defines the final validation statuses. This attribute is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "ThirdAdditionalContext":{
            "title":"Path for Third Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "ValidatedAttribute":{
            "title":"Attribute to Validate",
            "maxLength":30,
            "type":"string",
            "description":"Supplier attribute validated by the external data provider. For example, Taxpayer ID. This attribute is required for validation integrations.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top