Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/workspaces/{workspaceId}/docs |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Internal app appType-Third-party enterprise app |
| Izin | permission-Document.WorkspaceDocument.Write-Knowledge Base document write permission |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token perusahaan yang mengotorisasi aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| workspaceId | String | Ya | ID Knowledge Base. Dapatkan nilai bidang workspaceId dengan memanggil API Membuat Knowledge Base atau API Mendapatkan daftar Knowledge Base. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| name | String | Ya | Nama dokumen. |
| docType | String | Ya | Tipe dokumen. Nilai yang valid: - DOC: Dokumen - WORKBOOK: Spreadsheet - MIND: Peta Pikiran - FOLDER: Folder |
| operatorId | String | Ya | unionId dari pengguna. Dapatkan dengan memanggil API Kueri detail pengguna. |
| parentNodeId | String | Tidak | ID node induk. Dapatkan nilai parameter DentryModel dengan memanggil API Mendapatkan daftar node. Jika tidak ditentukan, dokumen dibuat di direktori root secara default. Node induk dapat berupa folder atau dokumen biasa. |
| templateId | String | Tidak | ID templat dokumen. |
| templateType | String | Tidak | Tipe templat dokumen. Nilai yang valid: - public_template: Rekomendasi - team_template: Templat tim - user_template: Templat pribadi |
Contoh permintaan
HTTPPOST /v1.0/doc/workspaces/YRBGvyxxx/docs HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ecxxx
Content-Type:application/json
{
"name" : "Dokumen",
"docType" : "DOC",
"operatorId" : "Q2xwPOxxx",
"parentNodeId" : "YRBGv0Ye",
"templateId" : "123243",
"templateType" : "team_template"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account client using a token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkdoc_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.dingtalkdoc_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocHeaders createWorkspaceDocHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocHeaders();
createWorkspaceDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocRequest createWorkspaceDocRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateWorkspaceDocRequest()
.setName("Dokumen")
.setDocType("DOC")
.setOperatorId("Q2xwPOxxx")
.setParentNodeId("YRBGv0Ye")
.setTemplateId("123243")
.setTemplateType("team_template");
try {
client.createWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains the code and message attributes, which 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)) {
// The err contains the code and message attributes, which help you locate the issue
}
}
}
}
# -*- 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_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__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() -> dingtalkdoc_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 dingtalkdoc_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
create_workspace_doc_headers = dingtalkdoc__1__0_models.CreateWorkspaceDocHeaders()
create_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
create_workspace_doc_request = dingtalkdoc__1__0_models.CreateWorkspaceDocRequest(
name='Dokumen',
doc_type='DOC',
operator_id='Q2xwPOxxx',
parent_node_id='YRBGv0Ye',
template_id='123243',
template_type='team_template'
)
try:
client.create_workspace_doc_with_options('YRBGvyxxx', create_workspace_doc_request, create_workspace_doc_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which help you locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
create_workspace_doc_headers = dingtalkdoc__1__0_models.CreateWorkspaceDocHeaders()
create_workspace_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
create_workspace_doc_request = dingtalkdoc__1__0_models.CreateWorkspaceDocRequest(
name='Dokumen',
doc_type='DOC',
operator_id='Q2xwPOxxx',
parent_node_id='YRBGv0Ye',
template_id='123243',
template_type='team_template'
)
try:
await client.create_workspace_doc_with_options_async('YRBGvyxxx', create_workspace_doc_request, create_workspace_doc_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which help you locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateWorkspaceDocHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateWorkspaceDocRequest;
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();
$createWorkspaceDocHeaders = new CreateWorkspaceDocHeaders([]);
$createWorkspaceDocHeaders->xAcsDingtalkAccessToken = "<your access token>";
$createWorkspaceDocRequest = new CreateWorkspaceDocRequest([
"name" => "Dokumen",
"docType" => "DOC",
"operatorId" => "Q2xwPOxxx",
"parentNodeId" => "YRBGv0Ye",
"templateId" => "123243",
"templateType" => "team_template"
]);
try {
$client->createWorkspaceDocWithOptions("YRBGvyxxx", $createWorkspaceDocRequest, $createWorkspaceDocHeaders, 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)) {
// The err contains the code and message attributes, which 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));
// 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_1_0 "github.com/alibabacloud-go/dingtalk/doc_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account client using a token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkdoc_1_0.Client{}
_result, _err = dingtalkdoc_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
createWorkspaceDocHeaders := &dingtalkdoc_1_0.CreateWorkspaceDocHeaders{}
createWorkspaceDocHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
createWorkspaceDocRequest := &dingtalkdoc_1_0.CreateWorkspaceDocRequest{
Name: tea.String("Dokumen"),
DocType: tea.String("DOC"),
OperatorId: tea.String("Q2xwPOxxx"),
ParentNodeId: tea.String("YRBGv0Ye"),
TemplateId: tea.String("123243"),
TemplateType: tea.String("team_template"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.CreateWorkspaceDocWithOptions(tea.String("YRBGvyxxx"), createWorkspaceDocRequest, createWorkspaceDocHeaders, &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)) {
// The err contains the code and message attributes, which help you locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account client using a token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkdoc_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkdoc_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let createWorkspaceDocHeaders = new $dingtalkdoc_1_0.CreateWorkspaceDocHeaders({ });
createWorkspaceDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
let createWorkspaceDocRequest = new $dingtalkdoc_1_0.CreateWorkspaceDocRequest({
name: "Dokumen",
docType: "DOC",
operatorId: "Q2xwPOxxx",
parentNodeId: "YRBGv0Ye",
templateId: "123243",
templateType: "team_template",
});
try {
await client.createWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err contains the code and message attributes, which help you locate the issue
}
}
}
}
Client.main(process.argv.slice(2));
// 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
{
/**
* Initialize the account client using a token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocHeaders createWorkspaceDocHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocHeaders();
createWorkspaceDocHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocRequest createWorkspaceDocRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateWorkspaceDocRequest
{
Name = "Dokumen",
DocType = "DOC",
OperatorId = "Q2xwPOxxx",
ParentNodeId = "YRBGv0Ye",
TemplateId = "123243",
TemplateType = "team_template",
};
try
{
client.CreateWorkspaceDocWithOptions("YRBGvyxxx", createWorkspaceDocRequest, createWorkspaceDocHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains the code and message attributes, which 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))
{
// The err contains the code and message attributes, which help you locate the issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| workspaceId | String | ID Knowledge Base. |
| nodeId | String | ID dokumen Knowledge Base. |
| docKey | String | docKey dokumen. |
| url | String | URL dokumen. |
| dentryUuid | String | UUID dari file yang dikembalikan. |
Contoh respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"workspaceId" : "YRBGvy",
"nodeId" : "YRBGv0Ye",
"docKey" : "QoJGq7xxx",
"url" : "https://xxx/workspaceId/docs/nodeId",
"dentryUuid" : "ydxXB52LJqqK7xxNTX*****697"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global untuk mendapatkan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidRequest.workspaceNode.nameConflict | Knowledge Base document name conflict | Konflik nama dokumen Knowledge Base. |
| 400 | invalidRequest.inputArgs.invalid | Method parameter validation failed | Validasi parameter metode gagal. Periksa apakah ada parameter wajib yang hilang atau apakah unionId valid. |
| 400 | invalidRequest.workspaceNode.parentNotFound | Parent node does not exist | Node induk tidak ada. |
| 400 | invalidRequest.template.notFound | Document template does not exist | Templat dokumen tidak ada. |
| 403 | forbidden.user.notInOrg | The operator is not in the organization | Operator tidak berada dalam organisasi. |
| 403 | forbidden.accessDenied | The user does not have operation permissions | Pengguna tidak memiliki izin operasi. |
| 404 | invalidRequest.resource.notFound | Resource not found | Sumber daya tidak ditemukan. |
| 404 | invalidRequest.workspace.deleted | The Knowledge Base has been deleted | Knowledge Base telah dihapus. |
| 500 | internalError | Internal system error | Error sistem internal. |