Resource Definition

    Resource Information (Resource)

    Field Type Required Description writable
    resourceLocation Integer Y Location code of the file or folder.
    It is used as the {resourceLocation} value in the URI path when you make an API call.
    resourceKey String Y Unique key of the file or folder
    resourcePath String Y Full path of the file or folder
    resourceSize Long Y File size (bytes). It is 0 if the resource is a folder.
    resourceType String Y Resource type.
    ● file: File
    ● folder: Folder
    fileType String Y File type.
    ● folder: Folder
    ● doc: Doc file
    ● image: Image file
    ● video: Video file
    ● audio: Audio file
    ● zip: Zip file
    ● exe: Executable file
    ● etc: Etc. file
    folderType String Y Type of the folder where the file or folder is located.
    ● my: My folder (including folders you shared)
    ● shared: Shared folder
    ● group: Group folder
    createDate Long Y Created date and time (timestamp)
    updateDate Long Y Updated date and time (timestamp)
    accessDate Long Y Last access date and time (timestamp)
    updateUser String Y Last updated by. It could be a unique user ID or the user name who uploaded the resource.
    hasExif Boolean Y Indicates whether exif exists.
    hasThumbnail Boolean Y Indicates whether a thumbnail exists (true/false).
    protected Boolean Y Indicates whether the file is marked as important. writable
    uploaded Boolean Y Indicates whether the file is successfully uploaded.
    locked Boolean Y Indicates whether the file is locked.
    virus String Y Malicious code infection status.
    ● none: No malicious code
    ● detected: Malicious code detected
    ● checking: Checking for malicious code
    memberShare Map N It exists only if the resource is shared to members. It is null if not.
    (It is null if the resource is a file under the shared folder.)
    memberShare.shareNo Long N Share number
    memberShare.ownerId String N User ID of the shared folder owner
    memberShare.ownerAccountId String N Email address of the shared folder owner
    memberShare.ownerName String N Name of the shared folder owner
    memberShare.ownership String N Shared folder access permission.
    ● W: Write permission
    ● R: Read permission
    linkShare Map N It exists only if the file or folder is shared through a URL link. It is null if not.
    linkShare.shareNo Long N Shared link number.
    It is 0 if the link type is Regular.
    linkShare.linkType String N Link type.
    Regular
    ● A: All users
    ● P: Only users who know the password
    ● O: Employees only
    Secure
    ● S: Secure
    group Map N It exists only if the resource belongs to a group folder. It is null if not.
    group.groupId String N Group folder ID
    group.permissionId String N Permission ID if the folder is assigned permissions.
    group.type String N Group folder type.
    ● O: Company folder
    ● G: Organization (team) folder
    ● D: Group folder
    ● E: External group folder

    Drive Size Information (DriveQuota)

    Field Type Required Description writable
    total Long Y Total size (bytes)
    used Long Y Used size (bytes)
    unused Long Y Unused size (bytes)
    fileMaxSize Long Y Maximum size per file (bytes)
    recycle RecycleBin Y Recycle bin information

    Recycle Bin Information (RecycleBin)

    Field Type Required Description writable
    emptyCycle Integer Y Deletion frequency (days)
    size Long Y Total size of files in the recycle bin (bytes)

    Recycle File information (RecycleFile)

    Field Type Required Description writable
    resourceLocation Integer Y Location code of the file or folder.
    It is used as the {resourceLocation} value in the URI path when you make an API call.
    resourceName String Y File or folder name
    resourceSize Long Y File size (bytes). It is 0 if the resource is a folder.
    resourceKey String Y Unique key of the file or folder
    resourceType String Y Resource type.
    ● file: File
    ● folder: Folder
    originalPath String Y Original path
    updateDate Long_timeMillis Y Updated date and time
    deleteDate Long_timeMillis Y Deleted date and time
    hasThumbnail Boolean Y Indicates whether a thumbnail exists (true/false).
    deleteAccountId String Y User ID who delete the resources

    File Version Information (Version)

    Field Type Required Description writable
    resourceLocation Integer Y Location code of the file or folder.
    It is used as the {resourceLocation} value in the URI path when you make an API call.
    resourceName String Y File or folder name
    resourceSize Long Y File size (bytes). It is 0 if the resource is a folder.
    resourceKey String Y Unique key of the file or folder
    createDate Long_timeMillis Y Created date and time (timestamp)
    updateDate Long_timeMillis Y Updated date and time (timestamp)
    updateUser String Y User ID or name who updated the resource
    fileType String Y File type.
    ● folder: Folder
    ● doc: Doc file
    ● image: Image file
    ● video: Video file
    ● audio: Audio file
    ● zip: Zip file
    ● exe: Executable file
    ● etc: Etc. file
    current Boolean Y Indicates whether it is the current version.