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

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

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

Запрос (Request):

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

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

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

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

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

{
  "boCode": "Код бизнес-объекта",
  "boiIds": "Идентификаторы инстанций бизнес-объекта",
  "multiLanguage": true
  /
  false
}

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

Пример:

{
  "boCode": "Customer_Orders",
  "boiIds": [
    "WjzCXs~fkIam6QDI",
    "c7g~8pimNyQD2Nj@"
  ],
  "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 - Запись используется для тестирования процессов

Пример:

{
  "records": [
    {
      "boiId": "WjzCXs~fkIam6QDI",
      "boCode": "Customer_Orders",
      "state": "ALL",
      "isTouched": false,
      "fieldValues": {
        "ORDER_ID": {
          "apiValue": "3114448",
          "displayValue": "3114448",
          "type": "INPUT_NUMBER"
        },
        "ORDER_DATE": {
          "apiValue": "2024-01-25T13:29:40.143+06",
          "displayValue": "2024-01-25 13:29",
          "type": "FULL_DATE"
        },
        "CUSTOMER_NAME": {
          "apiValue": "Orazkhan",
          "displayValue": "Orazkhan",
          "type": "INPUT_TEXT_LANG"
        },
        "ORDER_STATUS": {
          "apiValue": "qs2Qdp~3vVVSQIPc",
          "displayValue": "Delivered",
          "type": "RADIO_BUTTON_GROUP"
        },
        "ORDER_TOTAL": {
          "apiValue": "100231.0123",
          "displayValue": "100231.0123",
          "type": "INPUT_NUMBER"
        }
      },
      "fieldValuesLang": {
        "CUSTOMER_NAME": {
          "type": "INPUT_TEXT_LANG",
          "langApiValue": {
            // Значения по всем языкам которые есть в системе
            "ENG": "Orazkhan",
            "RUS": "Оразхан",
            "KAZ": "Оразхан",
            "QAZ": "Orazhan"
          }
        }
      }
    },
    {
      "boiId": "c7g~8pimNyQD2Nj@",
      "boCode": "Customer_Orders",
      "state": "ALL",
      "isTouched": true,
      "fieldValues": {
        "ORDER_ID": {
          "apiValue": "3129891",
          "displayValue": "3129891",
          "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": "Delivered",
          "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"
          }
        }
      }
    }
  ]
}