Публичный Web API: Модель ответа на запрос директории по ID (Получение информации о директории по идентификатору)

Методы

GET — Получение информации о директории по идентификатору

Ресурс

{
    "directory": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__id": "uuid",
        "__name": "string",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "directory": "uuid",
        "parentsList": [
            "uuid"
        ],
        "system": "boolean",
        "target": "string",
        "type": "string",
        "uniqueNames": "boolean"
    },
    "error": "string",
    "success": "boolean"
}

Свойства

Имя	Тип	Описание	Дополнительно
directory	object	Модель директории	Опциональное
directory.__createdAt	date-time	Дата создания	Опциональное
directory.__createdBy	uuid	Идентификатор создателя	Опциональное
directory.__deletedAt	date-time	Дата удаления	Опциональное
directory.__id	uuid	Идентификатор директории	Опциональное
directory.__name	string	Имя директории в системе	Опциональное
directory.__updatedAt	date-time	Дата последнего редактирования	Опциональное
directory.__updatedBy	uuid	Идентификатор редактора	Опциональное
directory.directory	uuid	Идентификатор родительской директории	Опциональное
directory.parentsList[]	array of uuid	Список родительских директорий до корневой директории	Опциональное
directory.system	boolean	Признак системности директории Указывает, что директория системная, то есть создана в системе по умолчанию	Опциональное
directory.target	string	Идентификатор родительской директории, если это ссылка	Опциональное
directory.type	string	Тип объекта, на который указывает ссылка. Поле имеет значение, только если директория является ссылкой (поле Target не пустое). Значения: "directory" — ссылка указывает на другую директорию "file" — ссылка указывает на файл "appitem" — ссылка указывает на элемент приложения Возможные значения: `directory` `file` `appitem`	Опциональное
directory.uniqueNames	boolean	Уникальность имен в директории (других директорий и файлов) Указывает, должны ли имена файлов и папок, добавляемых в директорию, быть уникальными в рамках этой директории	Опциональное
error	string	Текст ошибки, если `success == false`	Опциональное
success	boolean	Признак успешного запроса	Опциональное