Skip to content

Instances

Получить список экземпляров сущностей ( GET /isntances )

Уровень доступа read
Request Body -
Response Body %instance_summary

Возвращает список экземпляров сущностей, которые удовлетворяют фильтрам:

  • instance_rk: list[int]
  • name: mask
  • desc: mask
  • unique: bool
  • dataset_rk: list[int]
  • dataset_name: mask
  • entity_rk: list[int]
  • entity_name: mask
  • author: mask
  • limit: int
  • offset: int

Параметры limit и offset отвечают за размер и сдвиг выборки соответственно. При значении limit: null возвращается дефолтное количество объектов, которое определяется параметром APP__DEFAULT_ITEMS_LIMIT. Максимальное значение limit определяется параметром APP__MAX_ITEMS_LIMIT.

При этом часть атрибутов берется со связанных объектов (dataset_name, entity_name)

Получить детальную информацию по экземляру сущности (GET /instances/{instance_rk})

Уровень доступа read
Request Body -
Response Body %instance

Возвращает детальную информацию об экземпляре сущности.

Если передан параметр expand=true, то в схеме заполняются +"expand" поля:

  • entity_info - детальная информация по %entity

Изменить экземпляр сущности (PATCH /instances/{instance_rk})

Уровень доступа load
Request Body %instance_patch
Response Body %instance

Изменяет информацию об экземпляре сущности, при этом изменяются только переданные поля. Обновление происходит тривиальным образом - новые значения заменяют старые.