Jump to

• Request
• Response
• Examples

Update an entity configuration

patch

/fscmRestApi/resources/11.13.18.05/supplierEntityConfigurations/{SupplierProfileEntityId}

Request

Path Parameters

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

• InternalChangeMgmtCode: string
  Maximum Length: 30

  Abbreviation identifying whether an entity requires approval for internally initiated profile change requests.
• RegistrationProspectiveCode: string
  Title: Prospective

  Maximum Length: 30

  Abbreviation identifying if an entity is enabled, hidden, or required for prospective supplier registration.
• RegistrationSpendAuthorizedCode: string
  Title: Spend Authorized

  Maximum Length: 30

  Abbreviation identifying if an entity is enabled, hidden, or required for spend-authorized supplier registration.
• SupplierInitiatedChangeMgmtProspectiveCode: string
  Maximum Length: 30

  Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.
• SupplierInitiatedChangeMgmtSpendAuthorizedCode: string
  Maximum Length: 30

  Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.

{
    "type":"object",
    "properties":{
        "InternalChangeMgmtCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying whether an entity requires approval for internally initiated profile change requests.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationProspectiveCode":{
            "title":"Prospective",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity is enabled, hidden, or required for prospective supplier registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationSpendAuthorizedCode":{
            "title":"Spend Authorized",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity is enabled, hidden, or required for spend-authorized supplier registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtProspectiveCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtSpendAuthorizedCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":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 : supplierEntityConfigurations-item-response

Type: object

Show Source

• InternalChangeMgmt: string
  Read Only: true

  Maximum Length: 80

  Identifies whether an entity requires approval for internally initiated profile change requests.
• InternalChangeMgmtCode: string
  Maximum Length: 30

  Abbreviation identifying whether an entity requires approval for internally initiated profile change requests.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the supplier profile entity configuration was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who most recently updated the supplier profile entity configuration.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Identifies if an entity is enabled, hidden, or required for prospective supplier registration.
• RegistrationProspectiveCode: string
  Title: Prospective

  Maximum Length: 30

  Abbreviation identifying if an entity is enabled, hidden, or required for prospective supplier registration.
• RegistrationSpendAuthorized: string
  Read Only: true

  Maximum Length: 80

  Identifies if an entity is enabled, hidden, or required for spend-authorized supplier registration.
• RegistrationSpendAuthorizedCode: string
  Title: Spend Authorized

  Maximum Length: 30

  Abbreviation identifying if an entity is enabled, hidden, or required for spend-authorized supplier registration.
• SupplierInitiatedChangeMgmtProspective: string
  Read Only: true

  Maximum Length: 80

  Identifies if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.
• SupplierInitiatedChangeMgmtProspectiveCode: string
  Maximum Length: 30

  Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.
• SupplierInitiatedChangeMgmtSpendAuthorized: string
  Read Only: true

  Maximum Length: 80

  Identifies if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.
• SupplierInitiatedChangeMgmtSpendAuthorizedCode: string
  Maximum Length: 30

  Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.
• SupplierProfileEntity: string
  Read Only: true

  Maximum Length: 80

  Predefined supplier profile entity.
• SupplierProfileEntityCode: string
  Title: Supplier Profile

  Read Only: true

  Maximum Length: 30

  Abbreviation identifying the predefined supplier profile entity.
• SupplierProfileEntityId: integer (int64)
  Read Only: true

  The unique identifier of the supplier profile entity configuration.

{
    "type":"object",
    "properties":{
        "InternalChangeMgmt":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies whether an entity requires approval for internally initiated profile change requests.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InternalChangeMgmtCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying whether an entity requires approval for internally initiated profile change requests.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier profile entity configuration was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who most recently updated the supplier profile entity configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationProspective":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies if an entity is enabled, hidden, or required for prospective supplier registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationProspectiveCode":{
            "title":"Prospective",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity is enabled, hidden, or required for prospective supplier registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationSpendAuthorized":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies if an entity is enabled, hidden, or required for spend-authorized supplier registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationSpendAuthorizedCode":{
            "title":"Spend Authorized",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity is enabled, hidden, or required for spend-authorized supplier registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtProspective":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtProspectiveCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a prospective supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtSpendAuthorized":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierInitiatedChangeMgmtSpendAuthorizedCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying if an entity requires approval for supplier-initiated profile change requests for a spend-authorized supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierProfileEntity":{
            "maxLength":80,
            "type":"string",
            "description":"Predefined supplier profile entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierProfileEntityCode":{
            "title":"Supplier Profile",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the predefined supplier profile entity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "SupplierProfileEntityId":{
            "type":"integer",
            "description":"The unique identifier of the supplier profile entity configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"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

Examples

This example describes how to update an entity configuration.

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/supplierEntityConfigurations/SupplierProfileEntityId"

For example:

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

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.

{ 
    "RegistrationProspectiveCode": "HIDDEN",   
     "RegistrationSpendAuthorizedCode": "REQUIRED"  
} 

Example Response Body

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

{ 
    "SupplierProfileEntityId": 7, 
    "SupplierProfileEntityCode": "BANK_ACCOUNTS", 
    "SupplierProfileEntity": "Bank Accounts", 
    "RegistrationProspectiveCode": "HIDDEN", 
    "RegistrationProspective": "Hidden", 
    "RegistrationSpendAuthorizedCode": "REQUIRED", 
    "RegistrationSpendAuthorized": "Required", 
    "SupplierInitiatedChangeMgmtProspectiveCode": "ORA_POZ_NO_APPROVAL_REQUIRED", 
    "SupplierInitiatedChangeMgmtProspective": "No Approval Required", 
     "SupplierInitiatedChangeMgmtSpendAuthorizedCode": "ORA_POZ_NO_APPROVAL_REQUIRED", 
    "SupplierInitiatedChangeMgmtSpendAuthorized": "No Approval Required", 
    "InternalChangeMgmtCode": "ORA_POZ_NO_APPROVAL_REQUIRED", 
    "InternalChangeMgmt": "No Approval Required", 
    "LastUpdateDate": "2025-10-27T02:33:20+00:00", 
    "LastUpdatedBy": "CVBUYER01", 
    "links": [ 
        { 
            "rel": "self", 
            "href": "https://servername/fscmRestApi/resources/version/supplierEntityConfigurations/7", 
            "name": "supplierEntityConfigurations", 
            "kind": "item", 
            "properties": { 
             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001778" 
            } 
        }, 
        { 
            "rel": "canonical", 
            "href": "https://servername/fscmRestApi/resources/version/supplierEntityConfigurations/7", 
            "name": "supplierEntityConfigurations", 
            "kind": "item" 
        } 
    ] 
}

Back to Top