目录
此内容是否有帮助?

# ユーザー管理 API

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

# 一、ユーザー管理

# ユーザー ID の問い合わせ

注意

会社レベルのトークンのみサポート

インターフェイス URL

/open/list-auth-users-by-login-names?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "loginNames": [
        "test_user1",
        "test_user2"
    ]
}
パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
loginNames
["test_user1"]
List
はい
ログインユーザ名リスト

成功応答の例

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "authUsers": [
            {
                "userId": 88,
                "loginName": "test_user1"
            },
            {
                "userId": 89,
                "loginName": "test_user2"
            }
        ]
    }
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報
data
-
Object
チェック結果クエリkey
authUsers -
List
ユーザーリスト
userId 88
Integer
ユーザID
loginName test_user1
String
ユーザー名

# ロールを含む個々のユーザー情報のクエリ

注意

  • ユーザーがオーバーチューブの場合は companyRole、オーバーチューブでない場合は projectRoles を返します
  • 会社レベルのトークンのみサポート

インターフェイス URL

/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
test_user1
String
はい
ログイン名

成功応答の例

ユーザーがオーバーチューブの場合 companyRole:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "测试用户A",
    "roleInfo": {
      "companyRole": {
        "roleName": "root",
        "roleDesc": "公司超管"
      }
    }
  }
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
loginName test_user1
String
ログイン名
roleInfo -
Object
キャラクター情報
companyRole -
List
企業の役割一覧
roleName root
String
キャラクター説明
roleDesc 会社ハイパーチューブ
String
キャラクター名
userId 88
Integer
ユーザID
userName テストユーザーA
String
ユーザー名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

ユーザーがオーバーチューブでない場合は projectRoles を返します:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "测试用户A",
    "roleInfo": {
      "projectRoles": [
        {
          "projectId": 3,
          "roleName": "admin",
          "roleDesc": "管理员"
        },
        {
          "projectId": 4,
          "roleName": "analyst",
          "roleDesc": "分析师"
        }
      ]
    }
  }
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
loginName test_user1
String
ログイン名
roleInfo -
Object
キャラクター情報
projectRoles -
List
プロジェクトの役割一覧
projectId 3
Integer
プロジェクトID
roleDesc 管理者
String
キャラクター説明
roleName admin
String
キャラクター名
userId 88
Integer
ユーザID
userName テストユーザーA
String
ユーザー名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "Find no user with loginName: test007"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
Find no user with loginName: test007
String
戻る情報

# ユーザーアカウントのステータス

注意

  • ユーザーログインに基づいてユーザーアカウントの状態を照会

インターフェイス URL

/open/get-auth-user-status?token=xxx&loginName=user007

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
user007
String
はい
ログイン名

成功応答の例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "user007"
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
accountStatus NORMAL
String
アカウントステータス
INVALID:無効です
NORMAL:正常な状態
LOCK:ロック状態
loginName user007
String
ログイン名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ユーザーアカウントのステータス

インターフェイス URL

/open/get-auth-user-status?token=xxx&loginName=test007

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
test007
String
はい
ログイン名

成功応答の例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "Test"
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
accountStatus NORMAL
String
アカウントステータス
INVALID:無効です
NORMAL:正常な状態
LOCK:ロック状態
loginName Test
String
ログイン名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ユーザーフリーズ

注意

  • ユーザーのログイン名に基づいてユーザーをフリーズ

インターフェイス URL

/open/member-lock?token=xxx&loginName=user007

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
user007
String
はい
ログイン名

成功応答の例

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

エラー応答の例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1006
Integer
リターンコード
return_message
権限がない場合は、token値が正しいか確認してください
String
戻る情報

# ユーザー解凍

注意

  • ユーザログイン名に基づいてユーザを解凍

インターフェイス URL

/open/member-unlock?token=xxx&loginName=user007

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
user007
String
はい
ログイン名

成功応答の例

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

エラー応答の例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1006
Integer
リターンコード
return_message
権限がない場合は、token値が正しいか確認してください
String
戻る情報

# ユーザーの MFA バインディング

注意

会社レベルのトークンのみサポート

インターフェイス URL

/open/unbind-auth-user-mfa?token=xxx&loginName=root

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
root
String
はい
ログイン名

成功応答の例

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

エラー応答の例

{
    "return_code": -1009,
    "return_message": "用户名不存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1009
Integer
リターンコード
return_message
ユーザー名は存在しません
String
戻る情報

# ユーザーロールの一括作成

注意

  • この API は、次の機能を実行します。
    1. ユーザーアカウントを作成します。初期パスワードは「ta2020」です。ユーザーアカウントがすでに存在する場合は、ユーザーアカウントの作成をスキップします
    2. ユーザーアカウントの各プロジェクトでの役割を設定するには、役割がプロジェクトで定義されている必要があります。
  • 会社レベルのトークンのみサポート

インターフェイス URL

/open/batch-create-auth-user-and-set-roles?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "authUsers": [{
        "loginName": "test_user1",
        "roles": [{
            "projectId": 57,
            "roleDesc": "数据分析师A"
        }, {
            "projectId": 0,
            "roleDesc": "角色测试A"
        }]
    }, {
        "loginName": "test_user2",
        "roles": [{
            "projectId": 390,
            "roleDesc": "测试2"
        }, {
            "projectId": 377,
            "roleDesc": "普通成员"
                }]
        }]
}
パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
authUsers
-
List
はい
ユーザー情報エンティティ
loginName test_user1
String
はい
ユーザログインアカウント名
roles -
List
はい
キャラクターリスト
projectId 390
Integer
いいえ
プロジェクトID
roleDesc テスト2
String
はい
ロール表示名

成功応答の例

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

エラー応答の例

{
    "return_code": -1006,
    "return_message": "This API is Forbidden in SAAS"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1006
Integer
リターンコード
return_message
This API is Forbidden in SAAS
String
戻る情報

# SSO ユーザーの作成

注意

  • sso ユーザ情報作成

インターフェイス URL

/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007

リクエスト方法

GET

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginType
dingtalk
String
はい
三者ログインタイプ
loginName
user007
String
はい
ログイン名
password
-
String
いいえ
ログインパスワード(システムに渡さないと自動的に生成される)

成功応答の例

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

エラー応答の例

{
    "return_code": -1006,
    "return_message": "您无权限操作,请检查token值是否正确"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1006
Integer
リターンコード
return_message
権限がない場合は、token値が正しいか確認してください
String
戻る情報

# プロジェクトからユーザーを削除し、作業を移管するオプション

インターフェイス URL

/open/delete-auth-user-from-project?token=xxx&projectId=0&loginName=user007&handoverToLoginName=user008

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
loginName
user007
String
はい
削除するユーザーログイン名
handoverToLoginName
user008
String
はい
渡すことができるユーザーのログイン名

成功応答の例

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

エラー応答の例

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

# システムからユーザーを削除し、ジョブを転送するオプション

注意

会社レベルのトークンのみサポート

インターフェイス URL

/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
user007
Integer
はい
ログイン名
handoverToLoginName
user008
String
はい
ハンドオーバーしたユーザーログイン名

成功応答の例

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

エラー応答の例

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

# 二、ユーザーグループ管理

# ユーザーグループ ID とメンバーリスト

インターフェイス URL

/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

{
    "data": {
        "groupName": "demo007",
        "id": 133,
        "isDefault": false,
        "members": [
            {
                "userId": 16426
            }
        ],
        "updateTime": "2021-11-22 19:22:15"
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
groupName demo007
String
グループ名
id 133
Integer
id
isDefault false
Boolean
デフォルトかどうか
members -
List
メンバーリスト
userId 16426
Integer
ユーザID
updateTime 2021-11-22 19:22:15
Date
更新時間
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1023,
    "return_message": "用户分组不存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1023
Integer
リターンコード
return_message
ユーザグループは存在しない
String
戻る情報

# ユーザーグループの作成

インターフェイス URL

/open/create-user-group?token=xxx&projectId=2

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "groupName": "demo007",
    "isDefault": false,
    "members": [
        {
            "userId": 16426,
            "userName": "user007"
        }
    ]
}
パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
groupName
demo007
String
はい
グループ名、最大64文字
isDefault
false
Boolean
いいえ
新規ユーザーがデフォルトでグループに参加
members
-
List
いいえ
メンバーリスト
userId 16426
Integer
いいえ
メンバーユーザーID
userName user007
String
いいえ
メンバーユーザー名

成功応答の例

{
    "data": {
        "id": 135
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
id 135
Integer
id
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1015,
    "return_message": "已存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1015
Integer
リターンコード
return_message
既に存在する
String
戻る情報

# ユーザグループメンバリストの更新

ユーザーグループグループ名の追加または更新、グループメンバー情報の追加または更新

注意

  1. 提出されたメンバーリストは、全体を元のメンバーリストに置き換え

インターフェイス URL

/open/update-user-group?token=xxx&projectId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
  "id": 99,
  "groupName": "testGroup",
  "isDefault": false,
  "members": [
    {
      "userId": 88,
      "userName": "test88"
    },
    {
      "userId": 100,
      "userName": "test100"
    }
  ]
}
パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
id
99
Integer
はい
ユーザグループID
groupName
testGroup
String
いいえ
ユーザグループ名、最大64文字まで
isDefault
false
Boolean
いいえ
プロジェクトの新規ユーザーはデフォルトでグループに参加します
members
-
List
いいえ
ユーザーグループメンバー
userId 88
String
いいえ
ユーザーメンバーユーザーID
userName test88
String
いいえ
ユーザーメンバーユーザー名

成功応答の例

{
    "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-user-group?token=xxx&projectId=0&groupId=1

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
groupId
1
String
はい
グループ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
戻る情報

# 三、プロジェクトの役割管理

# プロジェクトロールの詳細

インターフェイス URL

/open/get-project-role-by-role-desc?token=xxx&projectId=2&roleDesc=アナリスト 007

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
2
Integer
はい
プロジェクトID
roleDesc
アナリスト007
String
はい
キャラクター説明

成功応答の例

{
    "data": {
        "baseRole": "analyst",
        "funcList": [
            {
                "functionClass": "用户分群设置",
                "functionDesc": "查看条件分群、结果分群、上传ID分群的列表",
                "functionId": 14,
                "functionName": "viewCluster",
                "functionType": "查看"
            },
            {
                "functionClass": "用户标签管理",
                "functionDesc": "查看标签列表",
                "functionId": 53,
                "functionName": "viewTag",
                "functionType": "查看"
            },
            {
                "functionClass": "看板使用",
                "functionDesc": "查看看板及看板设置",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "查看"
            }
        ],
        "projectId": 2,
        "roleDesc": "分析师007",
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
baseRole analyst
String
ベースキャラクター
funcList -
List
機能リスト
functionClass ユーザーサブグループ設定
String
機能分類
functionDesc 条件グループ、結果グループ、アップロードIDグループの一覧を表示
String
機能説明
functionId 14
Integer
機能ID
functionName viewCluster
String
機能名
functionType 見る
String
機能の種類
projectId 2
Integer
プロジェクトID
roleDesc アナリスト007
String
キャラクター説明
roleName analyst_1462717171385241600
String
キャラクター名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

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

# 基本ロール機能列

注意

会社レベルのトークンのみサポート

インターフェイス URL

/open/get-base-role-functions?token=xxx&baseRoleName=analyst

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
baseRoleName
analyst
String
はい
基本キャラクター名
analyst:アナリスト
member:一般メンバー

成功応答の例

{
    "data": {
        "defaultHaveCouldRemove": [
            {
                "functionClass": "看板使用",
                "functionDesc": "临时调整看板的筛选条件、使用全局筛选",
                "functionId": 35,
                "functionName": "useDashbordFilter",
                "functionType": "查看"
            }
        ],
        "defaultNotHaveCouldAdd": [
            {
                "functionClass": "模型使用",
                "functionDesc": "使用模型、保存报表、进行报表管理",
                "functionId": 28,
                "functionName": "useModel",
                "functionType": "功能使用"
            }
        ],
        "mustHave": [
            {
                "functionClass": "看板使用",
                "functionDesc": "查看看板及看板设置",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "查看"
            }
        ],
        "mustNotHave": [
            {
                "functionClass": "系统管理",
                "functionDesc": "新增项目",
                "functionId": 1,
                "functionName": "addProject",
                "functionType": "接入管理"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
オブジェクト
データを返す
defaultHaveCouldRemove -
オブジェクト
デフォルト機能削除可能機能一覧
functionClass カンバン使用

機能分類
functionDesc かんばんの選別条件を一時的に調整し、グローバル選別を使用する

機能説明
functionId 35
整数
機能ID
functionName useDashbordFilter

機能名
functionType 見る

機能の種類
defaultNotHaveCouldAdd -
オブジェクト
デフォルトの非新規機能リスト
functionClass モデルの使用

機能分類
functionDesc モデルの使用、レポートの保存、レポート管理

機能説明
functionId 28
整数
機能ID
functionName useModel

機能名
functionType 機能の使用

機能の種類
mustHave -
オブジェクト
持っている必要がある機能の一覧
functionClass カンバン使用

機能分類
functionDesc かんばんとかんばん設定

機能説明
functionId 34
整数
機能ID
functionName viewDashbord

機能名
functionType 見る

機能の種類
mustNotHave -
オブジェクト
必要がない機能のリスト
functionClass システム管理

機能分類
functionDesc 新規プロジェクト

機能説明
functionId 1
整数
機能ID
functionName addProject

機能名
functionType アクセス管理

機能の種類
return_code
0
整数
リターンコード
return_message
success

戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "getBaseRoleFunctions.baseRoleName 需要匹配正则表达式\"analyst|member\""
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
getBaseRoleFunctions.baseRoleNameに一致する正規表現が必要"analyst
String
戻る情報

# 新規プロジェクトロール

注意

新しいプロジェクトロールと権限の割り当て、推奨とインターフェイス:基本ロール機能列インターフェイスの取得

インターフェイス URL

/open/create-project-role?token=xxx&projectId=2

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "baseRole": "analyst",
    "roleDesc": "分析师007",
    "roleFuncList": [
        14,34,53
    ]
}
パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
基本キャラクター名
analyst:アナリスト
member:一般メンバー)
projectId
2
Integer
はい
キャラクター説明、最大60文字
roleFuncList
[14]
List
はい
ロール機能IDリストは、有効なIDでなければなりません

成功応答の例

{
    "data": {
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
roleName analyst_1462717171385241600
String
キャラクター名
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

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

# プロジェクトロールの変更

インターフェイス URL

/open/update-project-role?token=xxx&projectId=2&roleName=admin

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "baseRole": "analyst",
    "roleDesc": "分析师009",
    "roleFuncList": [
        14,34,53
    ]
}
パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
baseRole
analyst
String
はい
基本キャラクター名
analyst:アナリスト
member:一般メンバー)
roleDesc
アナリスト009
String
いいえ
キャラクター説明
roleFuncList
[14]
List
いいえ
ロール機能IDリスト

成功応答の例

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

エラー応答の例

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

# プロジェクトロールの削除

インターフェイス URL

/open/delete-project-role?token=xxx&projectId=0&roleName=test

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

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

エラー応答の例

{
    "return_code": -1023,
    "return_message": "role 'test'不存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1023
Integer
リターンコード
return_message
role'test'は存在しない
String
戻る情報

# 四、看板共有ブラックリスト

使用シーン、かんばん共有を設定かんばん共有たとき、共有がすべてのメンバーに見えるとき、ブラックリストを使用して特定のユーザーを除外

# ブラックリストを追加

注意

  • 会社レベルのトークンのみサポート

インターフェイス URL

/open/share/add-black?token=xxx&loginName=root&blackProjectId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
root
String
はい
ログイン名
blackProjectId
0
Integer
はい
ブラックリストプロジェクトID
0:すべてのプロジェクトがブラックリストを共有
アイテムID:このアイテムのみブラックリスト

成功応答の例

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

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ブラックリストを一括追加(csv)

注意

  • 会社レベルのトークンのみサポート

インターフェイス URL

/open/share/add-black-list?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

テキストテンプレートのスクリーンショットは次のとおりです。

成功応答の例

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

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ブラックリストグループの設定

注意

  • 会社レベルのトークンのみサポート
  • グループをブラックリストグループに設定すると、グループ全体のメンバーがブラックリストに入ります

インターフェイス URL

/open/share/add-black-group-list?token=xxx&groupIdList=[1]&groupType=1

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
groupIdList
[1]
List
はい
グループIDリスト
groupType
1
Integer
はい
1:ブラックリストグループ化

成功応答の例

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

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ブラックリストを削除

注意

  • 会社レベルのトークンのみサポート
  • ブラックリストを削除するか、すべてのブラックリスト

インターフェイス URL

/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
loginName
root
String
はい
ログイン名
blackProjectId
0
Integer
いいえ
ブラックリストプロジェクトID

成功応答の例

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

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報

# ダウンロードブラックリスト

注意

  • 会社レベルのトークンのみサポート

インターフェイス URL

/open/share/download-share-black?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

csv テキスト、例のスクリーンショットは次のとおりです

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
パラメータ(token)は空です
String
戻る情報