使用 Blue API 創建項目。


創建新項目

要創建新項目,您可以使用以下變更:

mutation {
  createProject(
    input: {
      name: "YOUR PROJECT NEW NAME"
      companyId: "YOUR COMPANY ID OR SLUG"
      description: "Project description"
      color: "#3B82F6"
      icon: "briefcase"
      category: GENERAL
    }
  ) {
    id
    name
    slug
    description
    color
    icon
    category
  }
}
icon: lightbulb

請記得在請求中包含所需的標頭:

- `X-Bloo-Token-ID`: 您的 API 令牌 ID
- `X-Bloo-Token-Secret`: 您的 API 令牌密鑰
- `X-Bloo-Company-ID`: 您的公司 ID
- `Content-Type: application/json`

回應範例

成功後,變更將返回新創建的項目詳細信息:

{
  "data": {
    "createProject": {
      "id": "newly-created-project-id",
      "name": "YOUR PROJECT NEW NAME",
      "slug": "your-project-new-name",
      "description": "Project description",
      "color": "#3B82F6",
      "icon": "briefcase",
      "category": "GENERAL"
    }
  }
}

從模板創建

要從現有模板創建項目,您可以將可選的 templateId 添加到變更中。

mutation {
  createProject(
    input: {
      templateId: "YOUR TEMPLATE ID OR SLUG"
      name: "YOUR PROJECT NEW NAME"
      companyId: "YOUR COMPANY ID OR SLUG"
    }
  ) {
    id
  }
}
從模板創建項目不會立即創建項目。相反,您的項目創建將被排隊。

使用模板的進階範例

這裡是一個完整的範例,顯示從模板創建時所有可用的選項:

mutation {
  createProject(
    input: {
      templateId: "marketing-template"
      name: "Q1 Marketing Campaign"
      companyId: "acme-corp"
      description: "Marketing initiatives for Q1 2024"
      color: "#10B981"
      icon: "megaphone"
      category: MARKETING
      coverConfig: {
        enabled: true
        fit: COVER
        imageSelectionType: FIRST
        source: DESCRIPTION
      }
    }
  ) {
    id
    name
    slug
    description
    color
    icon
    category
  }
}
icon: warning
`coverConfig` 參數目前僅在從模板創建項目時有效。對於從頭開始創建的項目,您需要在創建後使用 `editProject` 變更來配置待辦事項封面圖片。

檢查創建狀態

要檢查您的項目創建在隊列中的狀態,您可以使用以下查詢:

query {
  copyProjectStatus {
    newProjectName
    isTemplate
    isActive
    queuePosition
    totalQueues
  }
}

此查詢將返回您在隊列中創建項目的狀態。

輸入參數

CreateProjectInput

參數 類型 必需 描述
name String ✅ 是 項目名稱。名稱中的 URL 將被刪除。
companyId String ✅ 是 將創建項目的公司的 ID 或 slug。
description String 項目的描述。
color String 項目顏色的十六進制格式 (例如,"#3B82F6")。
icon String 項目的圖標標識符 (例如,"公文包"、"火箭")。
category ProjectCategory 項目類別。如果未指定,默認為 GENERAL
templateId String 用作模板的現有項目的 ID。
coverConfig TodoCoverConfigInput 待辦事項封面圖片的配置 (目前僅適用於基於模板的創建)。

ProjectCategory 值

描述
CRM 客戶關係管理項目
CROSS_FUNCTIONAL 跨功能團隊項目
CUSTOMER_SUCCESS 客戶成功倡議
DESIGN 設計和創意項目
ENGINEERING 工程和開發項目
GENERAL 一般項目 (默認)
HR 人力資源項目
IT 資訊技術項目
MARKETING 行銷活動和倡議
OPERATIONS 操作和物流項目
PRODUCT 產品管理項目
SALES 銷售和商業發展項目

TodoCoverConfigInput

如果您想配置待辦事項封面圖片在項目中的工作方式,您可以提供 coverConfig 參數:

參數 類型 必需 描述
enabled Boolean ✅ 是 是否啟用待辦事項的封面圖片
fit ImageFit ✅ 是 圖片應如何適應封面區域
imageSelectionType ImageSelectionType ✅ 是 從可用選項中選擇哪個圖片
source ImageSource ✅ 是 從哪裡提取圖片
sourceId String 特定來源標識符 (例如,自定義字段 ID)

ImageFit 值: COVER, CONTAIN, FILL, SCALE_DOWN

ImageSelectionType 值: FIRST (第一張圖片), LAST (最後一張圖片)

ImageSource 值: DESCRIPTION (來自待辦事項描述), COMMENTS (來自評論), CUSTOM_FIELD (來自自定義字段)

回應字段

createProject 變更返回一個 Project 對象,具有以下可用字段:

字段 類型 描述
id ID! 項目的唯一標識符
name String! 項目名稱
slug String! URL 友好的項目標識符
description String 項目描述
color String 項目顏色的十六進制格式
icon String 圖標標識符
category ProjectCategory 項目類別枚舉值
companyId String! 公司的 ID
createdAt DateTime! 創建時間戳
updatedAt DateTime! 最後更新時間戳
archived Boolean! 項目是否被歸檔
isTemplate Boolean! 這是否是模板項目

注意:您可以在回應中請求這些字段的任何組合。

重要說明

  • 您必須擁有 OWNERADMINMEMBER 級別的公司訪問權限才能創建項目
  • 從模板創建時,模板不能有超過 250,000 個待辦事項
  • 創建用戶會自動分配為項目的 OWNER
  • 項目名稱會自動去除空白
  • coverConfig 參數目前僅在從模板創建時有效

錯誤回應

找不到公司

{
  "errors": [{
    "message": "Company not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

找不到模板

{
  "errors": [{
    "message": "Template not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

模板過大

{
  "errors": [{
    "message": "Template cannot have more than 250000 todos",
    "extensions": {
      "code": "VALIDATION_ERROR"
    }
  }]
}

許可被拒絕

{
  "errors": [{
    "message": "You do not have permission to create projects in this company",
    "extensions": {
      "code": "FORBIDDEN"
    }
  }]
}

AI 助手

回應是使用人工智慧生成的,可能包含錯誤。

我能幫助您什麼?

隨時詢問我有關 Blue 或此文件的任何問題。

輸入發送 • Shift+Enter 進行換行 • ⌘I 打開