查询项目

调用本接口查询项目。

接口功能介绍

调用本接口,根据用户ID,实现查询企业下的所有项目,支持项目名模糊搜索。

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用

支持

项目应用项目读权限

API Explorer

第三方企业应用

支持

项目应用项目读权限

API Explorer

第三方个人应用

暂不支持

项目应用项目读权限

暂不支持

请求方法

POST /v1.0/project/users/{userId}/projects/query?projectIds=String&name=String&maxResults=Integer&nextToken=String&sourceId=String HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:String
Content-Type:application/json

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证,通过以下获取:

Path参数

名称

类型

是否必填

描述

userId

String

操作者userId。

Query参数

名称

类型

是否必填

描述

projectIds

String

项目ID集合,多个 ID 使用英文逗号分隔。

name

String

项目名字(模糊匹配)。

maxResults

Integer

分页大小。每页返回最大数量,默认10,最大300。

nextToken

String

分页标。供分页使用,下一页token,从当前页结果中获取。

sourceId

String

原始项目ID。

返回参数

名称

类型

描述

result

Array

项目列表。

projectId

String

项目ID。

name

String

项目名称。

logo

String

项目LOGO。

description

String

项目描述。

organizationId

String

企业ID。

visibility

String

可见性。

isTemplate

Boolean

是否为模板项目。

creatorId

String

创建人ID。

isArchived

Boolean

是否放入回收站。

isSuspended

Boolean

是否归档。

uniqueIdPrefix

String

任务ID前缀。

created

String

创建时间,格式:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。

说明

转换成北京时间,需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z,表示的北京时间为2022-06-20 08:00:00。

updated

String

更新时间,格式:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。

说明

转换成北京时间,需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z,表示的北京时间为2022-06-20 08:00:00。

startDate

String

项目开始时间,格式:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。

说明

转换成北京时间,需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z,表示的北京时间为2022-06-20 08:00:00。

endDate

String

项目结束时间,格式:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。

说明

转换成北京时间,需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z,表示的北京时间为2022-06-20 08:00:00。

customFields

Array

自定义字段值集合。

customFieldId

String

自定义字段ID。

type

String

自定义字段类型。

value

Array

自定义字段值列表。

customFieldValueId

String

自定义字段值ID。

title

String

自定义字段值内容。

metaString

String

自定义字段值元属性。

示例

请求示例

POST /v1.0/project/users/0517xxx/projects/query?projectIds=60a2187eb72xxxxxxx&name=测试项目&maxResults=10&nextToken=f279e812xxxxxx&sourceId=60a2187eb72xxxxxxx HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:xxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkproject_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.dingtalkproject_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkproject_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkproject_1_0.models.QueryProjectHeaders queryProjectHeaders = new com.aliyun.dingtalkproject_1_0.models.QueryProjectHeaders();
        queryProjectHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkproject_1_0.models.QueryProjectRequest queryProjectRequest = new com.aliyun.dingtalkproject_1_0.models.QueryProjectRequest()
                .setProjectIds("60a2187eb72xxxxxxx")
                .setName("测试项目")
                .setMaxResults(10)
                .setNextToken("f279e812xxxxxx")
                .setSourceId("60a2187eb72xxxxxxx");
        try {
            client.queryProjectWithOptions("0517xxx", queryProjectRequest, queryProjectHeaders, 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 属性,可帮助开发定位问题
            }

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

from typing import List

from alibabacloud_dingtalk.project_1_0.client import Client as dingtalkproject_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.project_1_0 import models as dingtalkproject__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() -> dingtalkproject_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkproject_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_project_headers = dingtalkproject__1__0_models.QueryProjectHeaders()
        query_project_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_project_request = dingtalkproject__1__0_models.QueryProjectRequest(
            project_ids='60a2187eb72xxxxxxx',
            name='测试项目',
            max_results=10,
            next_token='f279e812xxxxxx',
            source_id='60a2187eb72xxxxxxx'
        )
        try:
            client.query_project_with_options('0517xxx', query_project_request, query_project_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()
        query_project_headers = dingtalkproject__1__0_models.QueryProjectHeaders()
        query_project_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_project_request = dingtalkproject__1__0_models.QueryProjectRequest(
            project_ids='60a2187eb72xxxxxxx',
            name='测试项目',
            max_results=10,
            next_token='f279e812xxxxxx',
            source_id='60a2187eb72xxxxxxx'
        )
        try:
            await client.query_project_with_options_async('0517xxx', query_project_request, query_project_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

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

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

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vproject_1_0\Models\QueryProjectHeaders;
use AlibabaCloud\SDK\Dingtalk\Vproject_1_0\Models\QueryProjectRequest;
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();
        $queryProjectHeaders = new QueryProjectHeaders([]);
        $queryProjectHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryProjectRequest = new QueryProjectRequest([
            "projectIds" => "60a2187eb72xxxxxxx",
            "name" => "测试项目",
            "maxResults" => 10,
            "nextToken" => "f279e812xxxxxx",
            "sourceId" => "60a2187eb72xxxxxxx"
        ]);
        try {
            $client->queryProjectWithOptions("0517xxx", $queryProjectRequest, $queryProjectHeaders, 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));
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkproject_1_0  "github.com/alibabacloud-go/dingtalk/project_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)


/**
 * 使用 Token 初始化账号Client
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkproject_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkproject_1_0.Client{}
  _result, _err = dingtalkproject_1_0.NewClient(config)
  return _result, _err
}

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

  queryProjectHeaders := &dingtalkproject_1_0.QueryProjectHeaders{}
  queryProjectHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryProjectRequest := &dingtalkproject_1_0.QueryProjectRequest{
    ProjectIds: tea.String("60a2187eb72xxxxxxx"),
    Name: tea.String("测试项目"),
    MaxResults: tea.Int32(10),
    NextToken: tea.String("f279e812xxxxxx"),
    SourceId: tea.String("60a2187eb72xxxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryProjectWithOptions(tea.String("0517xxx"), queryProjectRequest, queryProjectHeaders, &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)
  }
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkproject_1_0, * as $dingtalkproject_1_0 from '@alicloud/dingtalk/project_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkproject_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkproject_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let queryProjectHeaders = new $dingtalkproject_1_0.QueryProjectHeaders({ });
    queryProjectHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryProjectRequest = new $dingtalkproject_1_0.QueryProjectRequest({
      projectIds: "60a2187eb72xxxxxxx",
      name: "测试项目",
      maxResults: 10,
      nextToken: "f279e812xxxxxx",
      sourceId: "60a2187eb72xxxxxxx",
    });
    try {
      await client.queryProjectWithOptions("0517xxx", queryProjectRequest, queryProjectHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性,可帮助开发定位问题
      }

    }    
  }

}

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 
    {

        /**
         * 使用 Token 初始化账号Client
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkproject_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkproject_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkproject_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkproject_1_0.Models.QueryProjectHeaders queryProjectHeaders = new AlibabaCloud.SDK.Dingtalkproject_1_0.Models.QueryProjectHeaders();
            queryProjectHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkproject_1_0.Models.QueryProjectRequest queryProjectRequest = new AlibabaCloud.SDK.Dingtalkproject_1_0.Models.QueryProjectRequest
            {
                ProjectIds = "60a2187eb72xxxxxxx",
                Name = "测试项目",
                MaxResults = 10,
                NextToken = "f279e812xxxxxx",
                SourceId = "60a2187eb72xxxxxxx",
            };
            try
            {
                client.QueryProjectWithOptions("0517xxx", queryProjectRequest, queryProjectHeaders, 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 属性,可帮助开发定位问题
                }
            }
        }


    }
}

返回示例

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

{
  "result" : [ {
    "projectId" : "64ba333e4206372f3f5cxxxx",
    "name" : "测试项目",
    "logo" : "http://xxxxx",
    "description" : "描述内容",
    "organizationId" : "dingc23b7b9682b4xxxx",
    "visibility" : "organization",
    "isTemplate" : false,
    "creatorId" : "0715153011125xxxx",
    "isArchived" : false,
    "isSuspended" : false,
    "uniqueIdPrefix" : "UNI",
    "created" : "2022-07-04T03:29:34.770Z",
    "updated" : "2022-07-04T03:29:34.770Z",
    "startDate" : "2022-07-04T03:29:34.770Z",
    "endDate" : "2022-07-04T03:29:34.770Z",
    "customFields" : [ {
      "customFieldId" : "64ba333e4206372f3f5cxxxx",
      "type" : "number",
      "value" : [ {
        "customFieldValueId" : "64ba333e4206372f3f5cxxxx",
        "title" : "自定义字段1",
        "metaString" : "3"
      } ]
    } ]
  } ]
}

错误码

HttpCode

错误码

错误信息

说明

400

user.not.exist

user not exist

用户在当前企业中不存在

400

org.not.exist

org not exist

当前企业在Teambition中不存在

500

server.error

system error

系统内部服务错误