Создание инстанции бизнес-объекта (БО) по идентификатору

Предусловие: Для загрузки у вас должно иметься БО (Что это такое и как создать?)

Запрос (Request):

POST /api/v1/boi/create-with-id
Content-Type: application/json
API-TOKEN/TOKEN: your_token

Метод: POST
URL: http://your-domain.kz/api/v1/boi/create-with-id

Headers:

Content-Type: application/json
API-TOKEN/TOKEN: your_token

Как получить API_TOKEN или TOKEN?

Входные данные:

{
  "boId": "идентификатор БО",
  "initialFieldValues": {
    "Идентификатор поля 1": "Значение поля 1",
    "Идентификатор поля 2": "Значение поля 2",
    "Идентификатор поля 3": "Значение поля 3"
  },
  "fieldRefAdd": [
    {
      "fieldCode": "код поля 4",
      "boCode": "код БО который содержит в себе поле с кодом поля 4",
      "fieldRefUniqCode": "код уникального поля 1",
      "apiValues": [
        "значение 1 уникального поля 1",
        "значение 2 уникального поля 1"
      ]
    },
    ...
  ],
  "multiLanguage": true / false
}

Атрибут входного JSON	Описание
boId	(String): Идентификатор бизнес-объекта. Как получить идентификаторы БО?
initialFieldValues.key	(String): Код определенного поля внутри БО. Как получить идентификаторы полей?
initialFieldValues.value	(String): Значение определенного поля внутри БО. Какие значения для каких полей надо вводить?
fieldRefAdd	(Массив объектов): Для добавления ссылок в поле БО по значениям уникальных полей вложенного БО
fieldRefAdd.fieldCode	(String): Код поля БО. Смотрите выше как получить код поля?
fieldRefAdd.boCode	(String): Если поле с fieldCode находится внутри СО, то данное поле обязательное к заполнению, так как она будет показывать к какому БО относится ваше поле.
fieldRefAdd.fieldRefUniqCode	(String): Код уникального поля БО на которое ссылается ваше поле. Смотрите выше как получить код поля?
fieldRefAdd.apiValues	(Массив String): Значения уникальных полей которы надо добавить. Если в fieldRefRemove, то удалить.
multiLanguage	(Boolean): Только для отображения мультиязычных полей созданной инстанции. Значение по умолчанию `false` - значит у вас будет отображаться значение на выбранном языке текущего пользователя. При `true`, вам будет отправляться массив объектов fieldValuesLang, содержащая текст по всем языкам которые есть в системе для всех мультиязычных полей.

Примечание: Вы можете указывать несколько уникальных полей одного и того же БО.

Пример:

{
  "boId": "gWmNg9ec3yI0wv4V", // Должно состоять только из 16 символов
  "initialFieldValues": {
    "UweuNeV8aG3~Tuvf": "545454",
    "CV~4boDWzp2SpQ@U": "Alimzhan",
    "84uP6Ml@gq87Fs2u": "1231231.0123",
    "eK3Owd6xaY7YCODc": "2023-12-23T14:30:45.123Z",
    "DybDzyYFS9csQLoJ": "mm6mHOUvo3w3w~Ud" // идентификатор значения из выборки 
  },
  "multiLanguage": true
}

Ответ (Response):

Созданная инстанция БО:

{
  "boiId": "Идентификатор инстанции БО",
  "boCode": "Kод БО",
  "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
  "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
  "fieldValues": {
    "идентификатор поля 1": {
      "apiValue": "значение поля 1",
      "displayValue": "значение поля для отображения 1",
      "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
    },
    "идентификатор поля 2": {
      "apiValue": "значение поля 2",
      "displayValue": "значение поля для отображения 2",
      "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
    },
    "идентификатор поля 3": {
      "apiValue": "значение поля 3",
      "displayValue": "значение поля для отображения 3",
      "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
    }
  },
  "fieldValuesLang": {
    "код поля 4 ": {
      "type": "тип мультиязычного поля 4",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "Код языка": "Значение мультиязычного поля на этом языке",
      }
    },
    "код поля 5": {
      "type": "тип мультиязычного поля 5",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "Код языка": "Значение мультиязычного поля на этом языке"
      }
    }
  }
}

Какие есть типы полей и какие значения они хранят?

Значения поля state:

1) ALL - Рабочее состояние записи

2) REMOVED - Запись удалена

3) ARCHIVED - Запись в архиве

4) DEV - Запись используется для тестирования процессов

Значение поля boiId можно позже использовать для получения инстанции бизнес объекта.

Пример:

{
  "boiId": "nnxn39PqFAmHv4ik",
  "boId": "gWmNg9ec3yI0wv4V",
  "state": "ALL",
  "isTouched": true,
  "fieldValues": {
    "UweuNeV8aG3~Tuvf": {
      "apiValue": "545454",
      "displayValue": "545454",
      "type": "INPUT_NUMBER"
    },
    "DybDzyYFS9csQLoJ": {
      "apiValue": "mm6mHOUvo3w3w~Ud", // идентификатор значения из выборки
      "displayValue": "Pending",
      "type": "RADIO_BUTTON_GROUP"
    },
    "eK3Owd6xaY7YCODc": {
      "apiValue": "2023-12-23T20:30:45.123+06",
      "displayValue": "2023-12-23 20:30",
      "type": "FULL_DATE"
    },
    "84uP6Ml@gq87Fs2u": {
      "apiValue": "1231231.0123",
      "displayValue": "1231231.0123",
      "type": "INPUT_NUMBER"
    },
    "CV~4boDWzp2SpQ@U": {
      "apiValue": "Temirlan",
      "displayValue": "Temirlan",
      "type": "INPUT_TEXT_LANG"
    }
  },
  "fieldValuesLang": {
    "CV~4boDWzp2SpQ@U": {
      "type": "INPUT_TEXT_LANG",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "ENG": "Temirlan",
        "RUS": "Темирлан",
        "KAZ": "Темірлан",
        "QAZ": "Temirlan"
      }
    }
  }
}