目录
此内容是否有帮助?

# カンバンレポート管理 API

呼び出し方法Open APIドキュメントの呼び出し方法の説明を参照してください。

関連する機能を理解するために、TA 使用マニュアルのデータカンバンセクションを読むことをお勧めします:データカンバン

# I.レポート管理

# クエリレポート一覧

インターフェイス URL

/open/manage-reports?token=xxx&projectId=0

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 Integer
 はい
 プロジェクトID

成功応答の例

{
  "data": {
    "reports": [
      {
        "createType": "MANUAL_CREATE",
        "dashboardIds": [],
        "reportDesc": "",
        "reportId": 34214,
        "reportModel": 0,
        "reportName": "event_3的总次数(4)",
        "updateTime": "2021-02-04 16:44:03"
      },
      {
        "createType": "IMPORTED",
        "dashboardIds": [
          3015
        ],
        "reportDesc": "",
        "reportId": 25565,
        "reportModel": 0,
        "reportName": "登陆次数-上月(1)",
        "updateTime": "2020-12-18 14:03:32"
      }
    ],
    "dashboards": [
      {
        "dashbord_id": 3015,
        "dashbord_name": "性能测试"
      }
    ]
  },
  "return_code": 0,
  "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 データを返す
∟ dashboards -
 List
 かんばん情報
∟ dashbord_id 1440
 Integer
 カンバンID
∟ dashbord_name 条件付き共通フィルタカンバン
 String
 カンバン名
∟ reports -
 List
 レポート情報
∟ createType MANUAL_CREATE
 String
 レポート作成方法:
MANUAL_CREATE:手動で作成
IMPORTED:カンバンインポート作成
COPIED:カンバンコピー作成
∟ dashboardIds 2378
 Integer
 カンバンIDコレクション(レポートに関連するカンバンIDのリスト。空は、レポートがカンバンにないことを示します)
∟ reportDesc -
 Object
 レポートコメント
∟ reportId 4049
 Integer
 レポートID
∟ reportModel 0
 Integer
 分析モデル
0:イベント分析
1:リテンション分析
2:漏斗分析
3:ユーザー属性分析
4:パス分析
5:分布分析
∟ reportName まっすぐに
 String
 レポート名
∟ updateTime 2019-12-20 15:59:44
 Date
 更新時間
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

# レポートの一括削除

インターフェイス URL

/open/report-batch-del?token=xxx&projectId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 String
 はい
 プロジェクトID

要求 Body パラメーター

{
    "reportIds": [
        34214
    ]
}
パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
reportIds
 [34214]
 List
 いいえ
 レポートIDリスト

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 String
 リターンコード
return_message
 success
 String
 戻る情報

# II。カンバン管理

# かんばんレポート管理/かんばんインポート

インターフェイス URL

/open/import-dashboards?token=xxx&projectId=0&dashboardNameConflictPolicy=RENAME_CREATE&spaceDashboardPolicy=IN_EXISTED_SPACE_OR_CREATE_SPACE

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 Integer
 はい
 プロジェクトID
dashboardNameConflictPolicy
 RENAME_CREATE
 String
 はい
 カンバン名競合ポリシー、既定値RENAME_CREATE、
RENAME_CREATE:自動改名
SKIP
:スキップ
REPLACE:置換
spaceDashboardPolicy
 IN_EXISTED_SPACE_OR_CREATE_SPACE
 String
 はい
 共有スペースのカンバン配置ポリシー、デフォルト値IN_EXISTED_SPACE_OR_CREATE_SPACE
CREATE_SPACE:新しく作成したスペースにカンバンを置く
IN_EXISTED_SPACE_OR_CREATE_SPACE:
既存のスペースまたは作成済みのスペースにカンバンを置く
IN_PRIVATE:私のカンバンの下に置く

成功応答の例

{
    "data": {
        "boardCreateFailed": 1,
        "boardCreated": 1,
        "boardTotal": 2,
        "folderCreated": 1,
        "reportCreateFailed": 1,
        "reportCreated": 1,
        "reportTotal": 2
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 データを返す
∟ boardCreateFailed 1
 Integer
 カンバン作成失敗数
∟ boardCreated 1
 Integer
 カンバン作成成功数
∟ boardTotal 2
 Integer
 カンバン総数
∟ folderCreated 1
 Integer
 ブッククリップ作成数
∟ reportCreateFailed 1
 Integer
 レポート作成失敗の数
∟ reportCreated 1
 Integer
 レポート作成数
∟ reportTotal 2
 Integer
 レポートの総数
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -3004
 String
 リターンコード
return_message
 無効なプロジェクト
 String
 戻る情報

# スペースカンバンを削除

注意

かんばんの API 呼び出し元が作成した場合は、かんばんを削除します。そうでなければ、かんばんをスペースから作成者のプライベートディレクトリに移動します。

インターフェイス URL

/open/delete-dashboard-from-space?token=xxx&projectId=0&dashboardId=1&spaceId=1

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 Integer
 はい
 プロジェクトID
dashboardId
 1
 Integer
 はい
 カンバンID
spaceId
 1
 Integer
 はい
 スペースID

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数错误，dashboard not in space"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータエラー、dashboard not in space
 String
 戻る情報

# 三、空間管理

# クエリ空間 ID とカンバンリスト

インターフェイス URL

/open/get-space-dashboards-by-space-name?token=xxx&projectId=377&spaceName=b

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 377
 Integer
 はい
 プロジェクトID
spaceName
 b
 String
 はい
 スペース名

成功応答の例

{
    "data": {
        "dashboards": [
            {
                "dashbordId": 3590,
                "dashbordName": "lzm"
            }
        ],
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 データを返す
∟ dashboards -
 List
 かんばん情報
∟ dashbordId 3590
 Integer
 カンバンID
∟ dashbordName lzm
 String
 カンバン名
∟ spaceId 31
 Integer
 スペースID
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1006,
    "return_message": "您无权限操作(view space dashboards)"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1006
 Integer
 リターンコード
return_message
 権限がない操作(ビュースペースダッシュボード)
 String
 戻る情報

# クエリ空間 ID とメンバーの権限一覧

インターフェイス URL

/open/get-space-members-by-space-name?token=xxx&projectId=377&spaceName=b

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 377
 Integer
 はい
 プロジェクトID
spaceName
 b
 String
 はい
 スペース名

成功応答の例

{
    "data": {
        "allAuthUserAuthority": "MEMBER",
        "authUserGroups": [
            {
                "authority": "ADMIN",
                "id": 1301,
                "name": "test1"
            }
        ],
        "authUsers": [
            {
                "authority": "ADMIN",
                "id": 1149,
                "name": "test2"
            }
        ],
        "creator": {
            "id": 928,
            "name": "test3"
        },
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 データを返す
∟ allAuthUserAuthority MEMBER
 String
 全員の権限
∟ authUserGroups -
 List
 権限グループ一覧
∟ authority ADMIN
 String
 権限
∟ id 1301
 Integer
 ユーザID
∟ name test1
 String
 ユーザー名
∟ authUsers -
 List
 ユーザーリスト
∟ authority ADMIN
 String
 権限
∟ id 1149
 Integer
 ユーザID
∟ name test2
 String
 ユーザー名
∟ creator -
 Object
 人の情報を作成
∟ id 928
 Integer
 ユーザーIDの作成
∟ name test3
 String
 作成者の名前
∟ spaceId 31
 Integer
 スペースID
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1006,
    "return_message": "您无权限操作(view space members)"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1006
 Integer
 リターンコード
return_message
 権限のない操作(空間メンバーを見る)
 String
 戻る情報

# スペースメンバーのアクセスリストを更新

スペース名の更新、スペースのデフォルト権限、スペースパーミッションの追加または変更、スペースメンバーグループ権限の追加または変更

注意

送信されたメンバー権限リストは、全体を元のメンバーリストに置き換え

インターフェイス URL

/open/update-space?token=xxx&projectId=0&spaceId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 Integer
 はい
 プロジェクトID
spaceId
 0
 Integer
 はい
 スペースID

要求 Body パラメーター

{
  "allAuthUserAuthority": "MEMBER",
  "authUserGroups": [
    {
      "id": 99,
      "authority": "MEMBER",
      "name": "member99"
    }
  ],
  "authUsers": [
    {
      "id": 88,
      "authority": "ADMIN",
      "name": "admin88"
    }
  ],
  "spaceName": "spaceTest"
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
allAuthUserAuthority
 string
 String
 いいえ
 すべてのメンバー権限
MEMBER:一般メンバー
ADMIN:管理者
authUserGroups
 -
 List
 いいえ
 フィールド表示名
∟ id 99
 Integer
 いいえ
 ユーザグループID
∟ name MEMBER
 String
 いいえ
 ユーザグループ名
∟ authority member99
 String
 いいえ
 ユーザーグループの権限
MEMBER:一般メンバー
ADMIN:管理者
authUsers
 -
 List
 いいえ
 フィールドの説明
∟ id 88
 Integer
 いいえ
 ユーザID
∟ name ADMIN
 String
 いいえ
 ユーザー名
∟ authority admin88
 String
 いいえ
 ユーザー権限
MEMBER:一般メンバー
ADMIN:管理者
spaceName
 spaceTest
 String
 いいえ
 プロパティタイプ、event: eventプロパティ、user: userプロパティ

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1023,
    "return_message": "看板空间不存在"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1023
 Integer
 リターンコード
return_message
 カンバンスペースは存在しない
 String
 戻る情報

# スペースを削除

インターフェイス URL

/open/delete-space?token=xxx&projectId=0&spaceId=1

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
projectId
 0
 Integer
 はい
 プロジェクトID
spaceId
 1
 Integer
 はい
 スペースID

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1023,
    "return_message": "看板空间不存在"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1023
 Integer
 リターンコード
return_message
 カンバンスペースは存在しない
 String
 戻る情報

#

#

#

#

#

#

#

#

#

← ディメンションテーブル API →