Базовые объекты

Перечислить переменные

GET /(company_code)/v2/fnd/variable

Получить список доступных базовых переменных

Для авторизованного пользователя перечисляет переменные, разрешенные ролью пользователя. Без авторизации перечисляет публичные переменные.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты доступных базовых переменных (поля: name, comment, read_only)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

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

Подробнее см. Коды ошибок.

Получить переменные

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

Получить значения базовых переменных

Для авторизованного пользователя все имена переменных должны быть разрешены ролью пользователя. Без авторизации все имена переменных должны быть из списка публичных переменных.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • variable_name – Имя запрашиваемой базовой переменной, либо список имен, разделенных запятыми (VAR_NAME_1,VAR_NAME_2,…)
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Значения запрошенных переменных (имена полей объекта это имена переменных)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Обновить переменную

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

Обновить значение базовой переменной

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • variable_name – Имя базовой переменной для обновления (должно быть разрешено ролью пользователя)
JSON-объект запроса:
 
  • value (string) – Новое значение переменной
JSON-объект ответа:
 
  • status (string) – success или error
  • data (string) – Значение обновленной переменной
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Перечислить наборы значений

GET /(company_code)/v2/fnd/valueset

Получить список доступных базовых наборов значений

Для авторизованного пользователя перечисляет наборы значений, разрешенные ролью пользователя. Без авторизации перечисляет публичные наборы значений.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты доступных базовых наборов значений (поля: name, comment, read_only)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

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

Подробнее см. Коды ошибок.

Получить наборы значений

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

Получить значения базовых наборов значений

Для авторизованного пользователя все имена наборов значений должны быть разрешены ролью пользователя. Без авторизации все имена наборов значений должны быть из списка публичных наборов значений.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • valueset_name – Имя запрашиваемого базового набора значений, либо список имен, разделенных запятыми (VALUESET_NAME_1,VALUESET_NAME_2,…)
URL-параметры запроса:
 
  • enabled (boolean) – (Необязательно) Флаг «включено» запрашиваемых значений. Если не указан, возвращаются значения с любым состоянием флага.
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Массивы объектов значений из запрошенных наборов значений (имена полей объекта это имена наборов значений)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных значения

Каждое поле в объекте ответа data содержит сортированный массив объектов значений, принадлежащих одному набору значений. У каждого объекта значения есть следующие поля:

Имя поля Тип Допускает null Описание
code string Нет Код значения, уникальный в рамках набора значений
meaning string Нет Текстовое описание значения

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Обновить значения набора значений

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

Обновить значения базового набора значений

Существующие включенные значения набора значений, не переданные в этот вызов, останутся в наборе значений неизмененными.

Для удаления (отключения) значений из набора значений используйте вызов valueset/remove.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • valueset_name – Имя базового набора значений для обновления (должно быть разрешено ролью пользователя)
JSON-объект запроса:
 
  • values (array) – Объекты данных обновленных значений
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Включенные значения обновленного набора значений
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных значения в запросе

У каждого объекта в массиве запроса values есть следующие поля:

Имя поля Тип Описание
code string Код значения, уникальный в рамках набора значений
meaning string Текстовое описание значения

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Удалить значения набора значений

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

Удалить значения базового набора значений

Удаленные значения будут возвращаться, когда набор значений запрашивается с полем enabled_flag установленным в false.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • valueset_name – Имя базового набора значений для обновления (должно быть разрешено ролью пользователя)
JSON-объект запроса:
 
  • codes (array) – Коды значений для удаления из набора значений
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Включенные значения обновленного набора значений
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Перечислить сообщения

GET /(company_code)/v2/fnd/message

Получить список доступных базовых сообщений

Для авторизованного пользователя перечисляет сообщения, разрешенные ролью пользователя. Без авторизации перечисляет публичные сообщения.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты доступных базовых сообщений (поля: name, comment, read_only)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

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

Подробнее см. Коды ошибок.

Получить сообщения

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

Получить значения базовых сообщений

Для авторизованного пользователя все имена сообщений должны быть разрешены ролью пользователя. Без авторизации все имена сообщений должны быть из списка публичных сообщений.

Заголовки запроса:
 
  • Authorization – (Необязательно) Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • message_name – Имя запрашиваемого базового сообщения, либо список имен, разделенных запятыми (MESSAGE_NAME_1,MESSAGE_NAME_2,…)
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Значения запрошенных сообщений (имена полей объекта это имена сообщений)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Обновить сообщение

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

Обновить значение базового сообщения

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • message_name – Имя базового сообщения для обновления (должно быть разрешено ролью пользователя)
JSON-объект запроса:
 
  • value (string) – Новое значение сообщения
JSON-объект ответа:
 
  • status (string) – success или error
  • data (string) – Значение обновленного сообщения
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Перечислить шаблоны уведомлений

GET /(company_code)/v2/fnd/notificationtemplate

Получить список доступных базовых шаблонов уведомлений

Перечисляет шаблоны уведомлений, разрешенные ролью пользователя.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты доступных базовых шаблонов уведомлений (поля: name, comment, read_only)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Получить шаблоны уведомлений

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

Получить данные базовых шаблонов уведомлений

Все имена шаблонов уведомлений должны быть разрешены ролью пользователя.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • template_name – Имя запрашиваемого базового шаблона уведомлений, либо список имен, разделенных запятыми (TEMPLATE_NAME_1,TEMPLATE_NAME_2,...)
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Объекты данных запрошенных шаблонов уведомлений (имена полей объекта это имена шаблонов)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных шаблона уведомлений

У каждого объекта в объекте ответа data есть следующие поля:

Имя поля Тип Допускает null Описание
subject string Нет Тема уведомления
text string Нет Текст уведомления
text2 string Нет Альтернативный текст уведомления, текст SMS-уведомления
content_type string Нет Код типа содержимого уведомления согласно таблице подстановки
category string Нет Код категории уведомления согласно таблице подстановки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Обновить шаблон уведомлений

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

Обновить данные базового шаблона уведомлений

Все поля данных в JSON запроса необязательны, любое поле может быть опущено, если его значение не изменилось.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • template_name – Имя базового шаблона уведомлений для обновления (должно быть разрешено ролью пользователя)
JSON-объект запроса:
 
  • subject (string) – (Необязательно) Новая тема уведомления
  • text (string) – (Необязательно) Новый текст уведомления
  • text2 (string) – (Необязательно) Новый альтернативный текст уведомления
  • content_type (string) – (Необязательно) Новый код типа содержимого уведомления
  • category (string) – (Необязательно) Новый код категории уведомления
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Данные обновленного шаблона уведомлений
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Перечислить пакетные процедуры

GET /(company_code)/v2/fnd/executable

Получить список доступных базовых пакетных процедур

Перечисляет пакетные процедуры, разрешенные ролью пользователя.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты доступных базовых пакетных процедур (поля: name, comment, enabled_flag)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.

Получить пакетные процедуры

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

Получить данные базовых пакетных процедур

Все имена пакетных процедур должны быть разрешены ролью пользователя.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • executable_name – Имя запрашиваемой базовой пакетной процедуры, либо список имен, разделенных запятыми (EXECUTABLE_NAME_1,EXECUTABLE_NAME_2,...)
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Объекты данных запрошенных пакетных процедур (имена полей объекта это имена пакетных процедур)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных пакетной процедуры

У каждого объекта в объекте ответа data есть следующие поля:

Имя поля Тип Описание
name string Имя пакетной процедуры
comment string Комментарий пакетной процедуры
enabled_flag boolean Флаг, указывающий, включена ли пакетная процедура
params array Спецификация параметров пакетной процедуры

Поля данных параметра

У каждого объекта в массиве params есть следующие поля:

Имя поля Тип Описание
seq integer Последовательный номер параметра
name string Название параметра
type string Код типа параметра (S, I, N, D, T)
required boolean Флаг, указывающий, требуется ли значение параметра
default_value string/null Значение параметра по умолчанию
description string Описание параметра

Используемые коды ошибки

  • 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

Подробнее см. Коды ошибок.