Загрузка инстанции бизнес-объекта (БО) по уникальному полю

Предусловие:

• У вас должно иметься БО (Что это такое и как создать?)
• Также созданная инстанция данного БО (Как создать инстанцию через API-service?)

Запрос (Request):

POST /api/v1/boi/load-by-unique-field
Content-Type: application/json
API-TOKEN/TOKEN: your_token

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

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

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

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

{
  "boCode": "Код бизнес-объекта",
  "uniqueFieldCode": "Код уникального поля бизнес-объекта",
  "fieldValue": "Значение уникального поля",
  "multiLanguage": true / false
}

• Как получить boCode?
• Как сделать поле уникальным?
• Как получить Код Поля (uniqueFieldCode)?
• multiLanguage - нужен при работе с мультиязычными полями. Значение по умолчанию false - значит у этих полей будут отображаться значения на выбранном языке текущего пользователя. При true, вам будет отправляться массив объектов fieldValuesLang, содержащая текст по всем языкам которые есть в системе для всех мультиязычных полей.

Пример:

Хотим получить заказ данного клиента, копируем текст у поля "ID заказа" с кодом поля "ORDER_ID" (Потому что она является уникальным полем)

Делаем следующий запрос:

{
  "boCode": "Customer_Orders",
  "uniqueFieldCode": "ORDER_ID",
  "fieldValue": "120398",
  "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": "QTU3DCdLCssP7Byg",
  "boCode": "Customer_Orders",
  "state": "ALL",
  "isTouched": true,
  "fieldValues": {
    "ORDER_ID": {
      "apiValue": "120398",
      "displayValue": "3129891",
      "type": "INPUT_NUMBER"
    },
    "ORDER_DATE": {
      "apiValue": "2023-09-13T20: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": "1231231.0123",
      "displayValue": "1231231.0123",
      "type": "INPUT_NUMBER"
    }
  },
  "fieldValuesLang": {
    "CUSTOMER_NAME": {
      "type": "INPUT_TEXT_LANG",
      "langApiValue": { // Значения по всем языкам которые есть в системе
        "ENG": "Temirlan",
        "RUS": "Темирлан",
        "KAZ": "Темірлан",
        "QAZ": "Temirlan"
      }
    }
  }
}