Jump to

• Request
• Response
• Examples

Update one supplier configuration option

patch

/fscmRestApi/resources/11.13.18.05/supplierOptions/{SupplierOptionsConfigId}

Request

Path Parameters

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

• AutoCreateSiteAssignmentFlag: boolean
  Title: Autocreate site assignments for spend authorized suppliers

  Maximum Length: 1

  Contains one of the following values: true or false. If true, site assignments for spend-authorized suppliers are automatically created. If false, site assignments are no longer automatically created. The default value is true.
• ExternalRegBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, it enforces the upload of bank account-related attachments when bank accounts are created for external supplier registration. If false, it's not enforced. The default value is false.
• ExternalRegCompanyDetailsAttachmentsRequiredCode: string
  Title: External Supplier Request

  Maximum Length: 30

  Abbreviation that identifies if attachments are required for external supplier registrations.
• ExternalRegSuccessMessage: string
  Maximum Length: 4000

  Text of the message when external supplier registration is successfully submitted.
• ExternalRegSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for external supplier registration. If false, it isn't required. The default value is true.
• ExternalRegWelcomeMessage: string
  Maximum Length: 4000

  Text of the welcome message for external supplier registration.
• InternalChangeBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are created for internal profile change requests. If false, it's not enforced. The default value is false.
• InternalRegSupplierBusRelationDefaultCode: string
  Title: Internal Supplier Request

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for internal supplier registration.
• InternalRegSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for internal supplier registration. If false, it isn't required. The default value is true.
• SourcingSupplierBusRelationDefaultCode: string
  Title: Sourcing Invitation

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for sourcing supplier registration.
• SourcingSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for sourcing supplier registration. If false, it isn't required. The default value is true.
• SSPSupplierBusRelationDefaultCode: string
  Title: Self Service Procurement

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for self-service supplier registration.
• SSPSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for self-service supplier registration. If false, it isn't required. The default value is false.
• SupplierPortalChangeBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are updated or created for supplier-initiated profile change requests. If false, it's not enforced. The default value is false.

{
    "type":"object",
    "properties":{
        "AutoCreateSiteAssignmentFlag":{
            "title":"Autocreate site assignments for spend authorized suppliers",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, site assignments for spend-authorized suppliers are automatically created. If false, site assignments are no longer automatically created. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, it enforces the upload of bank account-related attachments when bank accounts are created for external supplier registration. If false, it's not enforced. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegCompanyDetailsAttachmentsRequiredCode":{
            "title":"External Supplier Request",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies if attachments are required for external supplier registrations.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegSuccessMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Text of the message when external supplier registration is successfully submitted.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for external supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegWelcomeMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Text of the welcome message for external supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalChangeBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are created for internal profile change requests. If false, it's not enforced. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "InternalRegSupplierBusRelationDefaultCode":{
            "title":"Internal Supplier Request",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for internal supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalRegSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for internal supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "SSPSupplierBusRelationDefaultCode":{
            "title":"Self Service Procurement",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for self-service supplier registration.",
            "nullable":false,
            "x-queryable":false
        },
        "SSPSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for self-service supplier registration. If false, it isn't required. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "SourcingSupplierBusRelationDefaultCode":{
            "title":"Sourcing Invitation",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for sourcing supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "SourcingSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for sourcing supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierPortalChangeBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are updated or created for supplier-initiated profile change requests. If false, it's not enforced. The default value is false.",
            "nullable":false,
            "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 : supplierOptions-item-response

Type: object

Show Source

• AutoCreateSiteAssignmentFlag: boolean
  Title: Autocreate site assignments for spend authorized suppliers

  Maximum Length: 1

  Contains one of the following values: true or false. If true, site assignments for spend-authorized suppliers are automatically created. If false, site assignments are no longer automatically created. The default value is true.
• ExternalRegBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, it enforces the upload of bank account-related attachments when bank accounts are created for external supplier registration. If false, it's not enforced. The default value is false.
• ExternalRegCompanyDetailsAttachmentsRequired: string
  Read Only: true

  Maximum Length: 80

  Identifies if attachments are required for external supplier registrations.
• ExternalRegCompanyDetailsAttachmentsRequiredCode: string
  Title: External Supplier Request

  Maximum Length: 30

  Abbreviation that identifies if attachments are required for external supplier registrations.
• ExternalRegSuccessMessage: string
  Maximum Length: 4000

  Text of the message when external supplier registration is successfully submitted.
• ExternalRegSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for external supplier registration. If false, it isn't required. The default value is true.
• ExternalRegWelcomeMessage: string
  Maximum Length: 4000

  Text of the welcome message for external supplier registration.
• InternalChangeBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are created for internal profile change requests. If false, it's not enforced. The default value is false.
• InternalRegSupplierBusRelationDefault: string
  Read Only: true

  Maximum Length: 80

  Identifies the default business relationship for internal supplier registration.
• InternalRegSupplierBusRelationDefaultCode: string
  Title: Internal Supplier Request

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for internal supplier registration.
• InternalRegSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for internal supplier registration. If false, it isn't required. The default value is true.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the supplier configuration option.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the supplier configuration option.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourcingSupplierBusRelationDefault: string
  Read Only: true

  Maximum Length: 80

  Identifies the default business relationship for sourcing supplier registration.
• SourcingSupplierBusRelationDefaultCode: string
  Title: Sourcing Invitation

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for sourcing supplier registration.
• SourcingSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for sourcing supplier registration. If false, it isn't required. The default value is true.
• SSPSupplierBusRelationDefault: string
  Read Only: true

  Maximum Length: 80

  Identifies the default business relationship for self-service supplier registration.
• SSPSupplierBusRelationDefaultCode: string
  Title: Self Service Procurement

  Maximum Length: 30

  Abbreviation that identifies the default business relationship for self-service supplier registration.
• SSPSupplierIdRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for self-service supplier registration. If false, it isn't required. The default value is false.
• SupplierOptionsConfigId: integer (int64)
  Read Only: true

  The unique identifier of the supplier configuration option.
• SupplierPortalChangeBankAccAttachmentsRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are updated or created for supplier-initiated profile change requests. If false, it's not enforced. The default value is false.

{
    "type":"object",
    "properties":{
        "AutoCreateSiteAssignmentFlag":{
            "title":"Autocreate site assignments for spend authorized suppliers",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, site assignments for spend-authorized suppliers are automatically created. If false, site assignments are no longer automatically created. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, it enforces the upload of bank account-related attachments when bank accounts are created for external supplier registration. If false, it's not enforced. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegCompanyDetailsAttachmentsRequired":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies if attachments are required for external supplier registrations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalRegCompanyDetailsAttachmentsRequiredCode":{
            "title":"External Supplier Request",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies if attachments are required for external supplier registrations.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegSuccessMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Text of the message when external supplier registration is successfully submitted.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for external supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRegWelcomeMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Text of the welcome message for external supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalChangeBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are created for internal profile change requests. If false, it's not enforced. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "InternalRegSupplierBusRelationDefault":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the default business relationship for internal supplier registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalRegSupplierBusRelationDefaultCode":{
            "title":"Internal Supplier Request",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for internal supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalRegSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for internal supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier configuration option.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier configuration option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SSPSupplierBusRelationDefault":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the default business relationship for self-service supplier registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SSPSupplierBusRelationDefaultCode":{
            "title":"Self Service Procurement",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for self-service supplier registration.",
            "nullable":false,
            "x-queryable":false
        },
        "SSPSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for self-service supplier registration. If false, it isn't required. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "SourcingSupplierBusRelationDefault":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the default business relationship for sourcing supplier registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SourcingSupplierBusRelationDefaultCode":{
            "title":"Sourcing Invitation",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the default business relationship for sourcing supplier registration.",
            "nullable":true,
            "x-queryable":false
        },
        "SourcingSupplierIdRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, at least one of the following values: D-U-N-S Number, Taxpayer ID, or Tax Registration Number. The values must be provided for sourcing supplier registration. If false, it isn't required. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierOptionsConfigId":{
            "type":"integer",
            "description":"The unique identifier of the supplier configuration option.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SupplierPortalChangeBankAccAttachmentsRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, enforces the upload of bank account-related attachments when bank accounts are updated or created for supplier-initiated profile change requests. If false, it's not enforced. The default value is false.",
            "nullable":false,
            "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

Examples

This example describes how to update one supplier configuration option.

Example cURL Command

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

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

For example:

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
 "AutoCreateSiteAssignmentFlag": false
}

Example Response Body

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

{
    "SupplierOptionsConfigId": 1,
    "AutoCreateSiteAssignmentFlag": false,
    "SupplierPortalChangeBankAccAttachmentsRequiredFlag": true,
    "ExternalRegCompanyDetailsAttachmentsRequiredCode": null,
    "ExternalRegBankAccAttachmentsRequiredFlag": false,
    "ExternalRegSuccessMessage": "<p>Success Message</p>",
    "ExternalRegWelcomeMessage": "<p>Welcome Message</p>",
    "ExternalRegSupplierIdRequiredFlag": true,
    "InternalChangeBankAccAttachmentsRequiredFlag": true,
    "InternalRegSupplierBusRelationDefaultCode": "SPEND_AUTHORIZED",
    "InternalRegSupplierIdRequiredFlag": true,
    "LastUpdateDate": "2025-10-29T06:26:52+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "SourcingSupplierBusRelationDefaultCode": "PROSPECTIVE",
    "SourcingSupplierIdRequiredFlag": true,
    "SSPSupplierBusRelationDefaultCode": "SPEND_AUTHORIZED",
    "SSPSupplierIdRequiredFlag": false,
    "ExternalRegCompanyDetailsAttachmentsRequired": null,
    "InternalRegSupplierBusRelationDefault": "Spend Authorized",
    "SSPSupplierBusRelationDefault": "Spend Authorized",
    "SourcingSupplierBusRelationDefault": "Prospective",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierOptions/1",
            "name": "supplierOptions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000A778"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplierOptions/1",
            "name": "supplierOptions",
            "kind": "item"
        }
    ]
}

Back to Top