1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Registration Requests

Get one supplier registration request

get

/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests

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

    • FindByRegKey Finds a supplier registration request according to the registration key.
      Finder Variables
      • SupplierRegistrationKey; string; Value that uniquely identifies the supplier registration request using the registration key.
    • PrimaryKey Finds a supplier registration request according to the primary key.
      Finder Variables
      • SupplierRegistrationKey; string; Value that uniquely identifies the supplier registration request using the registration key.
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BusinessClassificationNotApplicableFlag; boolean; Contains one of the following values: true or false. If true, then no current business classification applies for the supplier. If false, then business classifications do apply. The default value is false.
    • DataFoxAddressId; integer; Supplier Registration Requests
    • DataFoxCompanyId; string; Value that uniquely identifies the Oracle Fusion Cloud DataFox company selected in the supplier registration request.
    • SupplierRegistrationKey; string; Key that uniquely identifies the supplier registration request.
  • 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 : supplierRegistrationRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierRegistrationRequests-item-response
Type: object
Show Source
  • Addresses
    Title: Addresses
    The Addresses resource manages addresses for the Suppliers Registration Requests resource.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Bank Accounts
    Title: Bank Accounts
    The Bank Accounts resource manages bank accounts for the Supplier Registration Requests resources.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then no current business classification applies for the supplier. If false, then business classifications do apply. The default value is false.
  • Business Classifications
    Title: Business Classifications
    The Business Classifications resource manages supplier business classifications for the Supplier Registration Requests resource.
  • Maximum Length: 80
    Business relationship between the enterprise and the supplier.
  • Title: Business Relationship
    Maximum Length: 30
    Abbreviation that identifies the business relationship between the enterprise and the supplier. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Company
    Maximum Length: 360
    Name of the company.
  • Contacts
    Title: Contacts
    The Contacts resource manages supplier contacts for supplier registration.
  • Title: Website
    Maximum Length: 150
    Corporate website of the supplier.
  • Supplier Registration Requests
  • Maximum Length: 30
    Value that uniquely identifies the Oracle Fusion Cloud DataFox company selected in the supplier registration request.
  • DFF
  • Title: D-U-N-S Number
    Maximum Length: 30
    Data Universal Numbering System (D-U-N-S) that identifies the supplier business.
  • Links
  • Title: Note to Approver
    Maximum Length: 1000
    Note from the supplier to the approver of the supplier registration request.
  • Title: Inviting Procurement BU
    Procurement business unit assigned to the supplier registration request.
  • Products and Services
    Title: Products and Services
    The Products and Services resource manages products and services for the Suppliers Registration Requests resource.
  • Maximum Length: 30
    Language in which the registration request is submitted.
  • Title: Registration Request
    Read Only: true
    Request number stamped on the supplier registration.
  • Read Only: true
    Maximum Length: 240
    Key that uniquely identifies the supplier registration request.
  • Title: Supplier Type
    Maximum Length: 80
    Type of supplier.
  • Title: Supplier Type
    Maximum Length: 30
    Abbreviation that identifies the type of supplier. A list of accepted values is defined in the lookup type POZ_VENDOR_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Supplier Type Lookup task.
  • Title: Country
    Maximum Length: 80
    Country where the supplier organization that's responsible for taxation resides.
  • Title: Organization Type
    Maximum Length: 80
    Type of tax organization for the supplier.
  • Title: Organization Type
    Maximum Length: 30
    Abbreviation that identifies the type of tax organization for the supplier. A list of accepted values is defined in the lookup type POZ_ORGANIZATION_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Tax Organization Type Lookup task.
  • Title: Country
    Maximum Length: 2
    Abbreviation that identifies the country where the supplier organization that's responsible for taxation is located.
Nested Schema : Addresses
Type: array
Title: Addresses
The Addresses resource manages addresses for the Suppliers Registration Requests resource.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Bank Accounts
Type: array
Title: Bank Accounts
The Bank Accounts resource manages bank accounts for the Supplier Registration Requests resources.
Show Source
Nested Schema : Business Classifications
Type: array
Title: Business Classifications
The Business Classifications resource manages supplier business classifications for the Supplier Registration Requests resource.
Show Source
Nested Schema : Contacts
Type: array
Title: Contacts
The Contacts resource manages supplier contacts for supplier registration.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Products and Services
Type: array
Title: Products and Services
The Products and Services resource manages products and services for the Suppliers Registration Requests resource.
Show Source
Nested Schema : supplierRegistrationRequests-addresses-item-response
Type: object
Show Source
Nested Schema : Address Contacts
Type: array
Title: Address Contacts
The Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : supplierRegistrationRequests-addresses-addressContacts-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-addresses-DFF-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-attachments-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-bankAccounts-item-response
Type: object
Show Source
  • Title: Account Name
    Maximum Length: 80
    Name of the supplier registration bank account.
  • Title: Account Number
    Maximum Length: 100
    Number of the supplier registration bank account.
  • Title: Account Suffix
    Maximum Length: 30
    Account suffix of the supplier registration bank account.
  • Title: Account Type
    Maximum Length: 25
    Type of supplier registration bank account. A list of accepted values is defined in the lookup type IBY_BANKACCT_TYPES.
  • Title: Alternate Account Name
    Maximum Length: 320
    Alternate name of the supplier registration bank account.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Maximum Length: 360
    Name of the bank for the supplier registration bank account.
  • Title: Bank
    Unique identifier of the bank for the supplier registration bank account.
  • Title: BIC Code
    Read Only: true
    Maximum Length: 30
    Bank identifier code (BIC) for the bank branch associated with the supplier registration bank account.
  • Maximum Length: 360
    Name of the bank branch for the supplier registration bank account.
  • Title: Branch
    Unique identifier of the bank branch for the supplier registration bank account.
  • Title: Branch Number
    Read Only: true
    Maximum Length: 30
    Number of the bank branch associated with the supplier registration bank account.
  • Title: Check Digits
    Maximum Length: 30
    Check digit of the supplier registration bank account to be used during bank account number validation.
  • Title: Territory Name
    Maximum Length: 80
    Name of the country where the supplier registration bank account is located. Can't be updated once the bank account is created.
  • Title: Country
    Maximum Length: 2
    Country code for the country where the supplier registration bank account is located. Can't be updated after the bank account is created.
  • Maximum Length: 15
    Currency code of the supplier registration bank account.
  • Title: Description
    Maximum Length: 240
    Detailed description of the supplier registration bank account.
  • Title: IBAN
    Maximum Length: 50
    International bank account number (IBAN) of the supplier registration bank account.
  • Links
  • Maximum Length: 30
    Secondary account reference of the supplier registration bank account.
  • Value the uniquely identifies the supplier registration bank account.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : supplierRegistrationRequests-bankAccounts-attachments-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-businessClassifications-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Value that uniquely identifies the business classification of the supplier registration request.
  • Title: Certificate End Date
    Date on which the certificate, which the certifying agency issues for the business classification, expires.
  • Title: Certificate
    Maximum Length: 80
    Certificate that the certifying agency issues for the business classification.
  • Title: Certificate Start Date
    Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.
  • Title: Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier.
  • Title: Certifying Agency
    Value that uniquely identifies the agency that certifies the business classification for the supplier.
  • Title: Classification
    Maximum Length: 80
    Classification for the supplier business.
  • Title: Classification
    Maximum Length: 30
    Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.
  • Links
  • Title: Notes
    Maximum Length: 1000
    Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.
  • Title: Other Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
  • Title: Subclassification
    Maximum Length: 80
    Describes the subclassification when a minority owns a business classification.
  • Title: Subclassification
    Maximum Length: 240
    Abbreviation that identifies the subclassification when a minority owns a business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : supplierRegistrationRequests-businessClassifications-attachments-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-contacts-item-response
Type: object
Show Source
  • Title: Administrative contact
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier isn't an administrative contact.The default value is false.
  • Title: Request user account
    Maximum Length: 1
    Contains one of the following values: true or false. If true, create a user account for the supplier contact. If false, then don't create a user account for the supplier contact. The default value is false.
  • DFF
  • Title: Email
    Maximum Length: 320
    Email of the supplier contact in the registration.
  • Title: Fax Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the fax number of the supplier contact in the supplier registration.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax number of the supplier contact in the supplier registration.
  • Title: Fax
    Maximum Length: 40
    Fax number of the supplier contact in the supplier registration.
  • Title: First Name
    Maximum Length: 150
    First name of the supplier contact in the supplier registration.
  • Title: Job Title
    Maximum Length: 100
    Job title of the supplier contact in the supplier registration.
  • Title: Last Name
    Maximum Length: 150
    Last name of the supplier contact in the supplier registration.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the supplier contact in the supplier registration.
  • Title: Mobile Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the mobile phone number of the supplier contact in the supplier registration.
  • Title: Mobile Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the mobile phone number of the supplier contact in the supplier registration.
  • Title: Mobile
    Maximum Length: 40
    Mobile phone number of the supplier contact in the supplier registration.
  • Title: Phone Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the landline phone number of the supplier contact in the supplier registration.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the landline phone number of the supplier contact in the supplier registration.
  • Title: Phone Extension
    Maximum Length: 20
    Landline phone extension for the supplier contact in the supplier registration.
  • Title: Phone
    Maximum Length: 40
    Landline phone number for the supplier contact in the supplier registration.
  • Roles
    Title: Roles
    The Roles resource manages user account roles of the supplier contact for supplier registration.
  • Maximum Length: 80
    Honorific title of the supplier contact in the supplier registration.
  • Title: Salutation
    Maximum Length: 30
    Abbreviation that identifies the honorific title of the supplier contact in the supplier registration. A list of accepted values is defined in the lookup type CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Value that uniquely identifies a supplier contact in the supplier registration.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Roles
Type: array
Title: Roles
The Roles resource manages user account roles of the supplier contact for supplier registration.
Show Source
Nested Schema : supplierRegistrationRequests-contacts-DFF-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-contacts-roles-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-DFF-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-productsAndServices-item-response
Type: object
Show Source
Links
generateRegistrationAccessCode
Generates a registration access code by submitting a request to verify an email.
getLoqateAddressDetail
Get address details from the Loqate address verification service.
validateRegistrationAccessCode
Validates if the registration access code is valid.
validateRegistrationContext
Validate if the registration URL code is valid.
validateRegistrationURL
Validate if the registration URL code is valid.
Back to Top