> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a shortcut

> Call this API to create a shortcut to a Knowledge Base or file at a specified location, with request parameters and response fields.

Call this API to create a shortcut to a Knowledge Base or file at a specified location.

## Request

### Basic information

| Field                | Value                                                                                                                  |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| HTTP URL             | [https://api.dingtalk.io/v2.0/doc/resource/shortcut/create](https://api.dingtalk.io/v2.0/doc/resource/shortcut/create) |
| HTTP Method          | POST                                                                                                                   |
| Supported app type   | appType-Internal app                                                                                                   |
| Permissions required | permission-snsapi\_base-Basic permissions required to call SNS API                                                     |

### Request header

| Name                        | Type   | Required | Description                                                                                                                     |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. Obtain it by calling the [Get user token](/open/development/obtain-user-token) API. |

### Request body

| Name               | Type   | Required | Description                                                                                                                                                                     |
| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| param              | Object | Yes      | Required parameter.                                                                                                                                                             |
| sourceResourceId   | String | Yes      | The ID of the source resource location. It can be a dentryUUid or rootNodeUUid. Use the dentryUUid value returned by the [File Search](/open/development/search-for-files) API. |
| sourceResourceType | String | Yes      | The type of the source resource:   - **DENTRY**: File - **WORKSPACE**: Knowledge Base                                                                                           |
| targetResourceId   | String | Yes      | The ID of the target location. It can be a dentryUUid or rootNodeUUid. Use the dentryUUid value returned by the [File Search](/open/development/search-for-files) API.          |
| targetResourceType | String | Yes      | The type of the target resource:   - **DENTRY**: File - **WORKSPACE**: Knowledge Base                                                                                           |
| targetResourceName | String | No       | The name of the shortcut. Optional. If not specified, the name of the source resource is used by default.                                                                       |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v2.0/doc/resource/shortcut/create HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:example
Content-Type:application/json

{
  "param" : {
    "sourceResourceId" : "dentryUuid",
    "sourceResourceType" : "DENTRY",
    "targetResourceId" : "dentryUuid",
    "targetResourceType" : "DENTRY",
    "targetResourceName" : "Shortcut to the test file"
  }
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_2_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.dingtalkdoc_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_2_0.models.CreateShortcutHeaders createShortcutHeaders = new com.aliyun.dingtalkdoc_2_0.models.CreateShortcutHeaders();
        createShortcutHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_2_0.models.CreateShortcutRequest.CreateShortcutRequestParam param = new com.aliyun.dingtalkdoc_2_0.models.CreateShortcutRequest.CreateShortcutRequestParam()
                .setSourceResourceId("dentryUuid")
                .setSourceResourceType("DENTRY")
                .setTargetResourceId("dentryUuid")
                .setTargetResourceType("DENTRY")
                .setTargetResourceName("Shortcut to the test file");
        com.aliyun.dingtalkdoc_2_0.models.CreateShortcutRequest createShortcutRequest = new com.aliyun.dingtalkdoc_2_0.models.CreateShortcutRequest()
                .setParam(param);
        try {
            client.createShortcutWithOptions(createShortcutRequest, createShortcutHeaders, 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 attributes that help 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 attributes that help locate the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.doc_2_0.client import Client as dingtalkdoc_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_2_0 import models as dingtalkdoc__2__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() -> dingtalkdoc_2_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_shortcut_headers = dingtalkdoc__2__0_models.CreateShortcutHeaders()
        create_shortcut_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.CreateShortcutRequestParam(
            source_resource_id='dentryUuid',
            source_resource_type='DENTRY',
            target_resource_id='dentryUuid',
            target_resource_type='DENTRY',
            target_resource_name='Shortcut to the test file'
        )
        create_shortcut_request = dingtalkdoc__2__0_models.CreateShortcutRequest(
            param=param
        )
        try:
            client.create_shortcut_with_options(create_shortcut_request, create_shortcut_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 attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_shortcut_headers = dingtalkdoc__2__0_models.CreateShortcutHeaders()
        create_shortcut_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.CreateShortcutRequestParam(
            source_resource_id='dentryUuid',
            source_resource_type='DENTRY',
            target_resource_id='dentryUuid',
            target_resource_type='DENTRY',
            target_resource_name='Shortcut to the test file'
        )
        create_shortcut_request = dingtalkdoc__2__0_models.CreateShortcutRequest(
            param=param
        )
        try:
            await client.create_shortcut_with_options_async(create_shortcut_request, create_shortcut_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 attributes that help locate the issue
                pass

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

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

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

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

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CreateShortcutHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CreateShortcutRequest\param;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CreateShortcutRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $createShortcutHeaders = new CreateShortcutHeaders([]);
        $createShortcutHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $param = new param([
            "sourceResourceId" => "dentryUuid",
            "sourceResourceType" => "DENTRY",
            "targetResourceId" => "dentryUuid",
            "targetResourceType" => "DENTRY",
            "targetResourceName" => "Shortcut to the test file"
        ]);
        $createShortcutRequest = new CreateShortcutRequest([
            "param" => $param
        ]);
        try {
            $client->createShortcutWithOptions($createShortcutRequest, $createShortcutHeaders, 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 attributes that help 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));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

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

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

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

  createShortcutHeaders := &dingtalkdoc_2_0.CreateShortcutHeaders{}
  createShortcutHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  param := &dingtalkdoc_2_0.CreateShortcutRequestParam{
    SourceResourceId: tea.String("dentryUuid"),
    SourceResourceType: tea.String("DENTRY"),
    TargetResourceId: tea.String("dentryUuid"),
    TargetResourceType: tea.String("DENTRY"),
    TargetResourceName: tea.String("Shortcut to the test file"),
  }
  createShortcutRequest := &dingtalkdoc_2_0.CreateShortcutRequest{
    Param: param,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateShortcutWithOptions(createShortcutRequest, createShortcutHeaders, &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 attributes that help locate the issue
    }

  }
  return _err
}

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

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_2_0 = require('@alicloud/dingtalk/doc_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

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

  static async main(args) {
    let client = Client.createClient();
    let createShortcutHeaders = new dingtalkdoc_2_0.CreateShortcutHeaders({ });
    createShortcutHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let param = new dingtalkdoc_2_0.CreateShortcutRequestParam({
      sourceResourceId: 'dentryUuid',
      sourceResourceType: 'DENTRY',
      targetResourceId: 'dentryUuid',
      targetResourceType: 'DENTRY',
      targetResourceName: 'Shortcut to the test file',
    });
    let createShortcutRequest = new dingtalkdoc_2_0.CreateShortcutRequest({
      param: param,
    });
    try {
      await client.createShortcutWithOptions(createShortcutRequest, createShortcutHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help locate the issue
      }

    }    
  }

}

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

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.

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 with a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutHeaders createShortcutHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutHeaders();
            createShortcutHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutRequest.CreateShortcutRequestParam param = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutRequest.CreateShortcutRequestParam
            {
                SourceResourceId = "dentryUuid",
                SourceResourceType = "DENTRY",
                TargetResourceId = "dentryUuid",
                TargetResourceType = "DENTRY",
                TargetResourceName = "Shortcut to the test file",
            };
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutRequest createShortcutRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CreateShortcutRequest
            {
                Param = param,
            };
            try
            {
                client.CreateShortcutWithOptions(createShortcutRequest, createShortcutHeaders, 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 attributes that help 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 attributes that help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name           | Type   | Description                                     |
| -------------- | ------ | ----------------------------------------------- |
| openDentryInfo | Object | The information of the shortcut.                |
| dentryUuid     | String | The unique ID of the file.                      |
| driveSpaceId   | String | The ID of the storage-layer Space.              |
| driveDentryId  | String | The ID of the storage-layer file.               |
| extension      | String | The file extension.                             |
| name           | String | The name of the node.                           |
| url            | String | The access link of the node.                    |
| spaceInfo      | Object | The Space information that the node belongs to. |
| sceneType      | String | The scenario that the resource belongs to.      |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "openDentryInfo" : {
    "dentryUuid" : "dentryUuid",
    "driveSpaceId" : "driveSpaceId",
    "driveDentryId" : "driveDentryId",
    "extension" : "docx",
    "name" : "name",
    "url" : "https://example.com",
    "spaceInfo" : {
      "sceneType" : "im"
    }
  }
}
```

### Error codes

If an error occurs when calling this API, look up the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message.

| HttpCode | Error code       | Error message | Description                       |
| -------- | ---------------- | ------------- | --------------------------------- |
| 400      | paramError       | %s            | Parameter error                   |
| 500      | systemError      | %s            | Service is busy. Try again later. |
| 500      | unknownError     | Unknown Error | Unknown error                     |
| 503      | operationTimeout | %s            | Request timeout                   |