> ## 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.

# ナレッジベースをピン留め

> ナレッジベースをピン留めして、よく使う文書をトップに表示し探しやすくします

本インターフェースを呼び出し、ナレッジベース ID と操作者の UnionID に基づいて、対応するナレッジベースをピン留めします。

## リクエスト

### 基本情報

| フィールド         | 値                                                       |
| ------------- | ------------------------------------------------------- |
| HTTP URL      | `https://api.dingtalk.io/v2.0/doc/spaces/{spaceId}/pin` |
| HTTP Method   | POST                                                    |
| サポートされるアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ                      |
| 権限要件          | permission-Document.Workspace.Write-ナレッジベース書き込み権限       |

### リクエストヘッダー

| 名前                          | タイプ    | 必須 | 説明                                                                                                                                                                                                                                                                                                                                                  |
| --------------------------- | ------ | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | はい | このインターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します：   - 社内アプリの場合は、[社内アプリのアクセストークンを取得](/ja/open/development/obtain-the-access-token-of-an-internal-app#) インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、[サードパーティアプリが権限付与された企業のアクセストークンを取得](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) インターフェースを呼び出して取得します。 |

### パスパラメータ

| 名前      | タイプ    | 必須 | 説明       |
| ------- | ------ | -- | -------- |
| spaceId | String | はい | ナレッジベース。 |

### クエリパラメータ

| 名前         | タイプ    | 必須 | 説明            |
| ---------- | ------ | -- | ------------- |
| operatorId | String | はい | 操作者の UnionID。 |

### リクエスト例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v2.0/doc/spaces/space_id/pin?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:222222xcdsdsda
Content-Type:application/json
```

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>Token を使用してアカウント Client を初期化します</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 {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_2_0.models.PinSpaceHeaders pinSpaceHeaders = new com.aliyun.dingtalkdoc_2_0.models.PinSpaceHeaders();
        pinSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_2_0.models.PinSpaceRequest pinSpaceRequest = new com.aliyun.dingtalkdoc_2_0.models.PinSpaceRequest()
                .setOperatorId("union_id");
        try {
            client.pinSpaceWithOptions("space_id", pinSpaceRequest, pinSpaceHeaders, 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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }

        } 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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }

        }        
    }
}
```

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:
        """
        Token を使用してアカウント Client を初期化します
        @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()
        pin_space_headers = dingtalkdoc__2__0_models.PinSpaceHeaders()
        pin_space_headers.x_acs_dingtalk_access_token = '<your access token>'
        pin_space_request = dingtalkdoc__2__0_models.PinSpaceRequest(
            operator_id='union_id'
        )
        try:
            client.pin_space_with_options('space_id', pin_space_request, pin_space_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        pin_space_headers = dingtalkdoc__2__0_models.PinSpaceHeaders()
        pin_space_headers.x_acs_dingtalk_access_token = '<your access token>'
        pin_space_request = dingtalkdoc__2__0_models.PinSpaceRequest(
            operator_id='union_id'
        )
        try:
            await client.pin_space_with_options_async('space_id', pin_space_request, pin_space_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                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\PinSpaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\PinSpaceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント Client を初期化します
     * @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();
        $pinSpaceHeaders = new PinSpaceHeaders([]);
        $pinSpaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $pinSpaceRequest = new PinSpaceRequest([
            "operatorId" => "union_id"
        ]);
        try {
            $client->pinSpaceWithOptions("space_id", $pinSpaceRequest, $pinSpaceHeaders, 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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
            }
        }
    }
}
$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:
// 
// Token を使用してアカウント Client を初期化します
// 
// @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
  }

  pinSpaceHeaders := &dingtalkdoc_2_0.PinSpaceHeaders{}
  pinSpaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  pinSpaceRequest := &dingtalkdoc_2_0.PinSpaceRequest{
    OperatorId: tea.String("union_id"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.PinSpaceWithOptions(tea.String("space_id"), pinSpaceRequest, pinSpaceHeaders, &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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
    }

  }
  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 {

  /**
   * Token を使用してアカウント Client を初期化します
   * @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 pinSpaceHeaders = new dingtalkdoc_2_0.PinSpaceHeaders({ });
    pinSpaceHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let pinSpaceRequest = new dingtalkdoc_2_0.PinSpaceRequest({
      operatorId: 'union_id',
    });
    try {
      await client.pinSpaceWithOptions('space_id', pinSpaceRequest, pinSpaceHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

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>Token を使用してアカウント Client を初期化します</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.PinSpaceHeaders pinSpaceHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceHeaders();
            pinSpaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceRequest pinSpaceRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceRequest
            {
                OperatorId = "union_id",
            };
            try
            {
                client.PinSpaceWithOptions("space_id", pinSpaceRequest, pinSpaceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
            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 には code と message 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}
```

## レスポンス

### レスポンスボディ

| 名前      | タイプ     | 説明            |
| ------- | ------- | ------------- |
| success | Boolean | 本操作が成功したかどうか。 |

### レスポンスボディ例

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

{
  "success" : true
}
```

### エラーコード

このインターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントから解決策を検索できます。

| HttpCode | エラーコード             | エラーメッセージ                        | 説明                       |
| -------- | ------------------ | ------------------------------- | ------------------------ |
| 400      | paramError         | %s                              | パラメータエラー                 |
| 400      | paramError.spaceId | %s                              | パラメータエラー - spaceId       |
| 403      | permissionDenied   | The operator has no permission. | 現在のユーザーには本操作の権限がありません    |
| 404      | spaceNotExist      | %s                              | ナレッジベースが存在しません           |
| 500      | systemError        | %s                              | サービスが混雑しています。後で再試行してください |
| 500      | unknownError       | Unknown Error                   | 不明なエラー                   |