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

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

Запрос (Request):

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

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

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

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

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

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

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

Пример:

{
  "boCode": "Customer_Orders",
  "initialFieldValues": {
    "ORDER_ID": "239",
    "CUSTOMER_NAME": "Temirlan",
    "ORDER_TOTAL": "12311.0123",
    "ORDER_DATE": "2023-12-23T14:30:45.123Z",
    "ORDER_STATUS": "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": "значение поля для отображения 1",
      "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
    },
    "код поля 3": {
      "apiValue": "значение поля 3",
      "displayValue": "значение поля для отображения 1",
      "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
    }
  },
  "fieldValuesLang": {
    "код поля 4 ": {
      "type": "тип мультиязычного поля 4",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "Код языка": "Значение мультиязычного поля на этом языке",
      }
    },
    "код поля 5": {
      "type": "тип мультиязычного поля 5",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "Код языка": "Значение мультиязычного поля на этом языке"
      }
    }
  }
}

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

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

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

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

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

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

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

Пример:

{
  "boiId": "xkhQtwa9E8qrxQnQ",
  "boCode": "Customer_Orders",
  "state": "ALL",
  "isTouched" : true,
  "fieldValues": {
    "ORDER_ID": {
      "apiValue": "239",
      "displayValue": "239",
      "type": "INPUT_NUMBER"
    },
    "ORDER_DATE": {
      "apiValue": "2023-12-23T20:30:45.123+06",
      "displayValue": "2023-12-23 20:30",
      "type": "FULL_DATE"
    },
    "CUSTOMER_NAME": {
      "apiValue": "Temirlan",
      "displayValue": "Temirlan",
      "type": "INPUT_TEXT_LANG"
    },
    "ORDER_STATUS": {
      "apiValue": "mm6mHOUvo3w3w~Ud",
      "displayValue": "Pending",
      "type": "RADIO_BUTTON_GROUP"
    },
    "ORDER_TOTAL": {
      "apiValue": "12311.0123",
      "displayValue": "12311.0123",
      "type": "INPUT_NUMBER"
    }
  },
  "fieldValuesLang": {
    "CUSTOMER_NAME": {
      "type": "INPUT_TEXT_LANG",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "ENG": "Temirlan",
        "RUS": "Темирлан",
        "KAZ": "Темірлан",
        "QAZ": "Temirlan"
      }
    }
  }
}