Foundation Objects

List Variables

GET /(company_code)/v2/fnd/variable

Get list of available Foundation variables

For authorized user, lists variables allowed by user role. Without authorization, lists public variables.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Objects of available FND variables (fields are name, comment, read_only)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid

See Error Codes for details.

Get Variables

GET /(company_code)/v2/fnd/variable/(variable_name)

Get values of Foundation variables

For authorized user, all variable names must be allowed by user role. Without authorization, all variable names must be from the list of public variables.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • variable_name – Name of FND variable to get, or comma-separated list of names (VAR_NAME_1,VAR_NAME_2,...)
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Values of requested variables (object field names are variable names)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted

See Error Codes for details.

Update Variable

PUT /(company_code)/v2/fnd/variable/(variable_name)

Update value of Foundation variable

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • variable_name – Name of FND variable to update (must be allowed by user role)
Request JSON Object:
 
  • value (string) – New variable value
Response JSON Object:
 
  • status (string) – success or error
  • data (string) – Value of updated variable
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

See Error Codes for details.

List ValueSets

GET /(company_code)/v2/fnd/valueset

Get list of available Foundation ValueSets

For authorized user, lists ValueSets allowed by user role. Without authorization, lists public ValueSets.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Objects of available FND ValueSets (fields are name, comment, read_only)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid

See Error Codes for details.

Get ValueSets

GET /(company_code)/v2/fnd/valueset/(valueset_name)

Get values from Foundation ValueSets

For authorized user, all ValueSet names must be allowed by user role. Without authorization, all ValueSet names must be from the list of public ValueSets.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • valueset_name – Name of FND ValueSet to query, or comma-separated list of names (VALUESET_NAME_1,VALUESET_NAME_2,...)
Query Parameters:
 
  • enabled (boolean) – (Optional) Enabled flag of requested values. If omitted, values with any enabled flag value will be returned.
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Value object arrays from requested ValueSets (object field names are ValueSet names)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Value data fields

Each field in the data response object holds a sorted array of value objects belonging to one ValueSet. Each value object has following fields:

Field name Type Nullable Description
code string No Value code, unique through ValueSet
meaning string No Textual description of the value

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • request.validation.failed
  • object.id.notfound
  • auth.restricted

See Error Codes for details.

Update ValueSet Values

PUT /(company_code)/v2/fnd/valueset/(valueset_name)

Update values of Foundation ValueSet

Existing enabled values of ValueSet not supplied to this endpoint will remain in ValueSet unmodified.

To remove (disable) values from ValueSet, use valueset/remove endpoint.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • valueset_name – Name of FND ValueSet to update (must be allowed by user role)
Request JSON Object:
 
  • values (array) – Data objects of updated values
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Enabled values of updated ValueSet
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Request value data fields

Each object in values request array has the following fields:

Field name Type Description
code string Value code, unique through ValueSet
meaning string Textual description of the value

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed

See Error Codes for details.

Remove ValueSet Values

POST /(company_code)/v2/fnd/valueset/(valueset_name)/remove

Remove values of Foundation ValueSet

Removed values will be returned when ValueSet is requested with enabled_flag set to false.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • valueset_name – Name of FND ValueSet to update (must be allowed by user role)
Request JSON Object:
 
  • codes (array) – Codes of values to remove from ValueSet
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Enabled values of updated ValueSet
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed

See Error Codes for details.

List Messages

GET /(company_code)/v2/fnd/message

Get list of available Foundation messages

For authorized user, lists messages allowed by user role. Without authorization, lists public messages.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Objects of available FND messages (fields are name, comment, read_only)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid

See Error Codes for details.

Get Messages

GET /(company_code)/v2/fnd/message/(message_name)

Get values of Foundation messages

For authorized user, all message names must be allowed by user role. Without authorization, all message names must be from the list of public messages.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • message_name – Name of FND message to get, or comma-separated list of names (MESSAGE_NAME_1,MESSAGE_NAME_2,...)
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Values of requested messages (object field names are message names)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted

See Error Codes for details.

Update Message

PUT /(company_code)/v2/fnd/message/(message_name)

Update value of Foundation message

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • message_name – Name of FND message to update (must be allowed by user role)
Request JSON Object:
 
  • value (string) – New message value
Response JSON Object:
 
  • status (string) – success or error
  • data (string) – Value of updated message
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

See Error Codes for details.

List Notification Templates

GET /(company_code)/v2/fnd/notificationtemplate

Get list of available Foundation notification templates

Lists notification templates allowed by user role.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Objects of available FND notification templates (fields are name, comment, read_only)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied

See Error Codes for details.

Get Notification Templates

GET /(company_code)/v2/fnd/notificationtemplate/(template_name)

Get data of Foundation notification templates

All notification template names must be allowed by user role.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • template_name – Name of FND notification template to get, or comma-separated list of names (TEMPLATE_NAME_1,TEMPLATE_NAME_2,...)
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Data objects of requested notification templates (object field names are template names)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Notification template data fields

Each object in the data response object has following fields:

Field name Type Nullable Description
subject string No Notification subject
text string No Notification text
text2 string No Alternative notification text, SMS notification text
content_type string No Notification content type code, according to lookup table
category string No Notification category code, according to lookup table

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted

See Error Codes for details.

Update Notification Template

PUT /(company_code)/v2/fnd/notificationtemplate/(template_name)

Update data of Foundation notification template

All data fields in request JSON are optional, any field can be omitted if its data has not changed.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • template_name – Name of FND notification template to update (must be allowed by user role)
Request JSON Object:
 
  • subject (string) – (Optional) New notification subject
  • text (string) – (Optional) New notification text
  • text2 (string) – (Optional) New notification alternative text
  • content_type (string) – (Optional) New notification content type code
  • category (string) – (Optional) New notification category code
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Data of updated notification template
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

List Executables

GET /(company_code)/v2/fnd/executable

Get list of available Foundation executables

Lists executables allowed by user role.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Objects of available FND executables (fields are name, comment, enabled_flag)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied

See Error Codes for details.

Get Executables

GET /(company_code)/v2/fnd/executable/(executable_name)

Get data of Foundation executables

All executable names must be allowed by user role.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • executable_name – Name of FND executable to get, or comma-separated list of names (EXECUTABLE_NAME_1,EXECUTABLE_NAME_2,...)
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Data objects of requested executables (object field names are executable names)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Executable data fields

Each object in the data response object has following fields:

Field name Type Description
name string Executable name
comment string Executable comment
enabled_flag boolean Flag indicating whether executable is enabled
params array Executable parameters specification

Parameter data fields

Each object in the params array has following fields:

Field name Type Description
seq integer Sequential number of parameter
name string Parameter name
type string Parameter type code (S, I, N, D, T)
required boolean Flag indicating whether parameter value is required
default_value string/null Default parameter value
description string Parameter description

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted

See Error Codes for details.