Methods

  • POST — Directory is created

Resource

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

Properties

Name Type Description Additional
directory object

Model of an directory

Optional
directory.__createdAt date-time

Created on

Optional
directory.__createdBy uuid

Creator ID

Optional
directory.__deletedAt date-time

Date of removal

Optional
directory.__id uuid

Directory ID

Optional
directory.__name string

Name of the directory in the system

Optional
directory.__updatedAt date-time

Last edited

Optional
directory.__updatedBy uuid

Editor ID

Optional
directory.directory uuid

ID of the parent directory

Optional
directory.parentsList[] array of uuid

List of parent directories up to the root directory

Optional
directory.system boolean

System directory flag
Shows that the directory is created
in the system by default

Optional
directory.uniqueNames boolean

Uniqueness of names of other folders and files within a directory
Shows whether the names of files and folders within the directory
have to be unique within the directory

Optional
error string

Error message if success == false

Optional
success boolean

Successful request flag

Optional