Jump to

• Request
• Response

Update one association between the supplier attribute and the external data provider attribute

patch

/fscmRestApi/resources/11.13.18.05/externalDataProviderAndSupplierAttributeMappings/{MappingId}

Request

Path Parameters

• MappingId(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

• APIFieldName: string
  Title: Provider Attribute Path

  Maximum Length: 4000

  Path to the desired attribute in the external data provider's response payload. Dot notation is used for nested fields.
• APIURL: string
  Title: Provider Attribute Details URL

  Maximum Length: 4000

  REST API endpoint URL of the external data provider for supplier information.
• ExternalDataProviderCode: string
  Title: Provider Code

  Maximum Length: 255

  Abbreviation that identifies the external data provider for suppliers. For example, Vision Corporation is called VC.
• InternalRegAttribute: string
  Title: Supplier Registration Attribute Path

  Maximum Length: 255

  Name of the supplier registration attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.
• InternalValidationAttribute: string
  Title: Validation Response Attribute

  Maximum Length: 255

  Name of the Cloud application attribute mapped to the external data provider's validation response attribute. This is required for validation integrations.
• PayloadType: string
  Title: Provider Type

  Maximum Length: 30

  Indicates whether it's a request payload or a response payload. Valid values are Request and Response. This attribute is required for validation integrations.
• SuppProfileAttribute: string
  Title: Supplier Profile Attribute Path

  Maximum Length: 255

  Name of the supplier profile attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.

{
    "type":"object",
    "properties":{
        "APIFieldName":{
            "title":"Provider Attribute Path",
            "maxLength":4000,
            "type":"string",
            "description":"Path to the desired attribute in the external data provider's response payload. Dot notation is used for nested fields.",
            "nullable":false,
            "x-queryable":false
        },
        "APIURL":{
            "title":"Provider Attribute Details URL",
            "maxLength":4000,
            "type":"string",
            "description":"REST API endpoint URL of the external data provider for supplier information.",
            "nullable":false
        },
        "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
        },
        "InternalRegAttribute":{
            "title":"Supplier Registration Attribute Path",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier registration attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalValidationAttribute":{
            "title":"Validation Response Attribute",
            "maxLength":255,
            "type":"string",
            "description":"Name of the Cloud application attribute mapped to the external data provider's validation response attribute. This is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "PayloadType":{
            "title":"Provider Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether it's a request payload or a response payload. Valid values are Request and Response. This attribute is required for validation integrations.",
            "nullable":true
        },
        "SuppProfileAttribute":{
            "title":"Supplier Profile Attribute Path",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier profile attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.",
            "nullable":true,
            "x-queryable":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 : externalDataProviderAndSupplierAttributeMappings-item-response

Type: object

Show Source

• APIFieldName: string
  Title: Provider Attribute Path

  Maximum Length: 4000

  Path to the desired attribute in the external data provider's response payload. Dot notation is used for nested fields.
• APIURL: string
  Title: Provider Attribute Details URL

  Maximum Length: 4000

  REST API endpoint URL of the external data provider for supplier information.
• ExternalDataProviderCode: string
  Title: Provider Code

  Maximum Length: 255

  Abbreviation that identifies the external data provider for suppliers. For example, Vision Corporation is called VC.
• InternalRegAttribute: string
  Title: Supplier Registration Attribute Path

  Maximum Length: 255

  Name of the supplier registration attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.
• InternalValidationAttribute: string
  Title: Validation Response Attribute

  Maximum Length: 255

  Name of the Cloud application attribute mapped to the external data provider's validation response attribute. This is required for validation integrations.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingId: integer (int64)
  Title: Mapping ID

  Mapping between the external data provider and the Cloud application attributes.
• PayloadType: string
  Title: Provider Type

  Maximum Length: 30

  Indicates whether it's a request payload or a response payload. Valid values are Request and Response. This attribute is required for validation integrations.
• SuppProfileAttribute: string
  Title: Supplier Profile Attribute Path

  Maximum Length: 255

  Name of the supplier profile attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.

{
    "type":"object",
    "properties":{
        "APIFieldName":{
            "title":"Provider Attribute Path",
            "maxLength":4000,
            "type":"string",
            "description":"Path to the desired attribute in the external data provider's response payload. Dot notation is used for nested fields.",
            "nullable":false,
            "x-queryable":false
        },
        "APIURL":{
            "title":"Provider Attribute Details URL",
            "maxLength":4000,
            "type":"string",
            "description":"REST API endpoint URL of the external data provider for supplier information.",
            "nullable":false,
            "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
        },
        "InternalRegAttribute":{
            "title":"Supplier Registration Attribute Path",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier registration attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalValidationAttribute":{
            "title":"Validation Response Attribute",
            "maxLength":255,
            "type":"string",
            "description":"Name of the Cloud application attribute mapped to the external data provider's validation response attribute. This is required for validation integrations.",
            "nullable":true,
            "x-queryable":false
        },
        "MappingId":{
            "title":"Mapping ID",
            "type":"integer",
            "description":"Mapping between the external data provider and the Cloud application attributes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PayloadType":{
            "title":"Provider Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether it's a request payload or a response payload. Valid values are Request and Response. This attribute is required for validation integrations.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppProfileAttribute":{
            "title":"Supplier Profile Attribute Path",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier profile attribute in the Cloud application mapped to an external data provider attribute. For validation integrations, this value is included in the request payload. For enrichment integrations, it's updated with enriched data.",
            "nullable":true,
            "x-queryable":false
        },
        "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