1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Configuration Options

Get all supplier configuration options

get

/fscmRestApi/resources/11.13.18.05/supplierOptions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the supplier configuration option according to the primary key.
      Finder Variables
      • SupplierOptionsConfigId; integer; The unique identifier of the supplier configuration option.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierOptions-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 80
    Identifies if attachments are required for external supplier registrations.
  • Title: External Supplier Request
    Maximum Length: 30
    Abbreviation that identifies if attachments are required for external supplier registrations.
  • Maximum Length: 4000
    Text of the message when external supplier registration is successfully submitted.
  • 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.
  • Maximum Length: 4000
    Text of the welcome message for external supplier registration.
  • 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.
  • Read Only: true
    Maximum Length: 80
    Identifies the default business relationship for internal supplier registration.
  • Title: Internal Supplier Request
    Maximum Length: 30
    Abbreviation that identifies the default business relationship for internal supplier registration.
  • 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.
  • Read Only: true
    Date and time when the user most recently updated the supplier configuration option.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier configuration option.
  • Links
  • Read Only: true
    Maximum Length: 80
    Identifies the default business relationship for sourcing supplier registration.
  • Title: Sourcing Invitation
    Maximum Length: 30
    Abbreviation that identifies the default business relationship for sourcing supplier registration.
  • 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.
  • Read Only: true
    Maximum Length: 80
    Identifies the default business relationship for self-service supplier registration.
  • Title: Self Service Procurement
    Maximum Length: 30
    Abbreviation that identifies the default business relationship for self-service supplier registration.
  • 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.
  • Read Only: true
    The unique identifier of the supplier configuration option.
  • 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.
Links
regenerateUrlEncryptionKey
Regenerates the URL encryption key in case the registration URLs have been tampered with.
Back to Top

Examples

This example describes how to get all supplier configuration options.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierOptions"

Example Response Body

The following example includes the contents of the response body in JSON format:
        {
            "SupplierOptionsConfigId": 1,
            "AutoCreateSiteAssignmentFlag": true,
            "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-28T09:32:43+00:00",
            "LastUpdatedBy": "FUSION",
            "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000A678"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierOptions/1",
                    "name": "supplierOptions",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierOptions",
            "name": "supplierOptions",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/supplierOptions/action/regenerateUrlEncryptionKey",
            "name": "regenerateUrlEncryptionKey",
            "kind": "other"
        }
    ]
Back to Top