Get file or folder information - DingTalk Help Center

Call this API to obtain information about a file or folder when adding it to a storage space.

API call description

When obtaining file or folder information, the file size and file extension are not returned for folder-type entries.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/query`
HTTP Method	POST
Supported app types	appType-Internal app　appType-Third-party enterprise app
Permission required	permission-Storage.File.Read-Read permission on organization storage files

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an enterprise authorized to a third-party app API.

Path parameters

Name	Type	Required	Description
spaceId	String	Yes	The space ID. Call the Add a space API to obtain the `id` parameter value.
dentryId	String	Yes	The file or folder ID. Call the Get a list of files or folders API or the Get spaceId and dentryId by dentryUuid API to obtain the `id` parameter value.

Query parameters

Name	Type	Required	Description
unionId	String	Yes	The unionId of the operator. Call the Query user details API to obtain the `unionid` parameter value.

Request body

Name	Type	Required	Description
option	Object	No	Optional parameters.
appIdsForAppProperties	Array of String	No	Returns the corresponding visible properties by specifying the space `ownerId` list. Maximum: 20. - When `ownerType` is `APP`, `ownerId` is the app identifier. - When `ownerType` is `USER`, `ownerId` is the creator’s unionId.
withThumbnail	Boolean	No	Whether to obtain a temporary link to the file thumbnail. Obtain on demand because it affects API latency. - true: Obtain. - false (default): Do not obtain.

Request example

HTTP

POST /v1.0/storage/spaces/854xxxxx/dentries/653xxxxx/query?unionId=cHtUYxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "option" : {
    "appIdsForAppProperties" : [ "123" ],
    "withThumbnail" : false
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkstorage_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkstorage_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.GetDentryHeaders getDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentryHeaders();
        getDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption()
                .setAppIdsForAppProperties(java.util.Arrays.asList(
                    "123"
                ))
                .setWithThumbnail(false);
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest getDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setOption(option);
        try {
            client.getDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help you locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help you locate the issue
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkstorage_1_0Client:
        """
        Initialize the account Client using a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            client.get_dentry_with_options('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            await client.get_dentry_with_options_async('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help you locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $getDentryHeaders = new GetDentryHeaders([]);
        $getDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "appIdsForAppProperties" => [
                "123"
            ],
            "withThumbnail" => false
        ]);
        $getDentryRequest = new GetDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "option" => $option
        ]);
        try {
            $client->getDentryWithOptions("854xxxxx", "653xxxxx", $getDentryRequest, $getDentryHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message properties to help you locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client using a Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkstorage_1_0.Client{}
  _result, _err = dingtalkstorage_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  getDentryHeaders := &dingtalkstorage_1_0.GetDentryHeaders{}
  getDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.GetDentryRequestOption{
    AppIdsForAppProperties: []*string{tea.String("123")},
    WithThumbnail: tea.Bool(false),
  }
  getDentryRequest := &dingtalkstorage_1_0.GetDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetDentryWithOptions(tea.String("854xxxxx"), tea.String("653xxxxx"), getDentryRequest, getDentryHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message properties to help you locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using a Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkstorage_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let getDentryHeaders = new dingtalkstorage_1_0.GetDentryHeaders({ });
    getDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.GetDentryRequestOption({
      appIdsForAppProperties: [
        '123'
      ],
      withThumbnail: false,
    });
    let getDentryRequest = new dingtalkstorage_1_0.GetDentryRequest({
      unionId: 'cHtUYxxxxx',
      option: option,
    });
    try {
      await client.getDentryWithOptions('854xxxxx', '653xxxxx', getDentryRequest, getDentryHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties to help you locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryHeaders getDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryHeaders();
            getDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption
            {
                AppIdsForAppProperties = new List<string>
                {
                    "123"
                },
                WithThumbnail = false,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest getDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                Option = option,
            };
            try
            {
                client.GetDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help you locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help you locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
dentry	Object	File or folder information.
id	String	The file or folder ID.
spaceId	String	The ID of the space where the file or folder resides.
parentId	String	The parent folder ID. For the root folder, this parameter is `0`.
type	String	The type: - FILE: File. - FOLDER: Folder.
name	String	The file or folder name. If it is a file, this field value includes the file extension.
size	Long	The file size, in bytes. This field is not returned for folders.
path	String	The path of the file or folder within the space.
version	Long	The version.
status	String	The status: - NORMAL: Normal. - DELETED: Trash. - EXPIRED: Expired.
extension	String	The file extension. This field is not returned for folders.
creatorId	String	The unionId of the creator.
modifierId	String	The unionId of the modifier.
createTime	String	The creation time in ISO 8601 format. Example: 2022-07-29T14:55Z.
modifiedTime	String	The modification time in ISO 8601 format. Example: 2022-07-29T14:55Z.
properties	Object	The file or folder attributes.
readOnly	Boolean	Whether the file or folder is read-only: - true: Yes. - false: No.
appProperties	`Map<String, Array>`	Attributes on a specific app. The key is the space identifier, and the value is the attribute list.
	Array	The attribute list.
name	String	The attribute name.
value	String	The attribute value.
visibility	String	The attribute visibility: - PUBLIC: Visible to all apps. - PRIVATE: Visible only to the current app.
uuid	String	The business identifier.
partitionType	String	The storage partition: - PUBLIC_OSS_PARTITION: Public cloud OSS storage partition. - MINI_OSS_PARTITION: Dedicated MiniOSS storage partition.
storageDriver	String	The driver type: - DINGTALK: DingTalk unified storage driver. - ALIDOC: DingTalk Docs storage driver. - UNKNOWN: Unknown driver.
thumbnail	Object	Thumbnail information.
width	Integer	The thumbnail width, in pixels.
height	Integer	The thumbnail height, in pixels.
url	String	The thumbnail URL.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "dentry" : {
    "id" : "653xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "parent_id",
    "type" : "FILE",
    "name" : "TestFile.xsl",
    "size" : 512,
    "path" : "/TestFile.xsl",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "xsl",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "property_name",
      "value" : "property_value",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  }
}

Error codes

If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	paramError	%s	Parameter error.
403	permissionDenied	%s	The user does not have permission to obtain the file or folder information.
404	spaceNotExist	%s	The space does not exist.
404	dentryNotExist	%s	The file does not exist.
500	systemError	%s	System error.
500	unknownError	Unknown Error	Unknown error.
503	operationTimeout	%s	Request timed out.

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes