RPA企業アカウント一覧の取得

この記事の内容
  1. 事前操作
  2. リクエスト
  3. リクエストヘッダー
  4. リクエストパラメータ
  5. レスポンス
  6. レスポンスデータ構造
  7. レスポンスデータの例
  8. 使用例
  9. curlの例
  10. Javaの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このインターフェースは、企業内で条件に一致するすべてのRPA企業アカウントデータを取得するために使用します。説明:インターフェースの呼び出しに使用する認証アカウントには、スケジュール管理者権限が必要です。

1回の呼び出しで最大100件のアカウントを返します。ページを指定して複数回呼び出すことで、すべてのアカウントを取得できます。

事前操作

  1. 認証インターフェースを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/rpa/user/v1/list 専用クラウドを利用する企業は、専用クラウドのアドレスを使用してください
HTTP Method GET

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証インターフェースが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

名称 タイプ 必須かどうか 説明
phone String いいえ 完全な携帯電話番号
accountKeyword String いいえ アカウントのキーワード
latestLoginTimeBegin Long いいえ 最終ログイン日時の範囲の下限、秒単位のタイムスタンプ
latestLoginTimeEnd Long いいえ 最近のログイン日時の範囲の上限、秒単位のタイムスタンプ
expiredTimeBegin Long いいえ 有効期限の範囲の下限、秒単位のタイムスタンプ
expiredTimeEnd Long いいえ 有効期限の範囲の上限、秒単位のタイムスタンプ
accountTypes List<String> いいえ アカウントタイプのリスト。基本アカウント:basic、高度アカウント:senior
page int いいえ ページ番号
size int いいえ 1ページあたりの件数はデフォルトで20件、最大100件です

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data array 結果データ
|─ object
|─userUuid string ユーザーのuuid
|─loginAccount string ログインアカウント
|─name string アカウント名
|─phone string 携帯電話番号
|─role string ロール
|─roleName string ロール名
|─accountType string アカウントタイプ
|─accountTypeName string アカウントタイプ名
|─latestLoginTime string 最近のログイン日時
|─expiredTime string 有効期限
page object ページ分割データ
|─total integer 総件数
|─size integer 1ページあたりの件数
|─page integer 現在のページ
|─pages integer 総ページ数
|─offset integer オフセット
|─sortColumn string 並べ替えに使用するcolumnの名称
|─order string 並べ替え方法 desc/asc
code integer 戻り値の結果コード
200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうか。このフィールドでインターフェースの呼び出しが成功したかどうかを判断できます
requestId string リクエストid。問題の調査に使用します
serverIp string 処理を行うサービスのIP
serverInstName string 処理を行うサービスのインスタンス名
msg string ステータスコードの説明

レスポンスデータの例

{
    "data": [
        {
            "userUuid": "xxxuuid",
            "loginAccount": "xxxacc@abbr",
            "name": "xxxname",
            "phone": "13312345678",
            "role": "e_user",
            "roleName": "员工",
            "accountType": "basic",
            "accountTypeName": "基础账号",
            "latestLoginTime": "2024-02-28 15:21:51",
            "expiredTime": "2025-01-19 23:59:59"
        }
    ],
    "page": {
        "total": 1,
        "size": 20,
        "page": 1,
        "pages": 1,
        "offset": 0,
        "order": "desc"
    },
    "code": 200,
    "success": true,
    "requestId": "44265d53-842b-4a7f-9174-6bd900ebaa91"
}

使用例

curlの例

curl --location --request GET 'https://api.example.com/oapi/rpa/user/v1/list?latestLoginTimeBegin=1680192000&latestLoginTimeEnd=1706630400&expiredTimeBegin=1678550400&expiredTimeEnd=1741708800&accountTypes=basic,senior&page=1&size=20' \
--header 'Authorization: 替换为鉴权接口返回的accessToken'

Javaの例

この例ではUnirestライブラリを使用します。

String accessToken="替换为鉴权接口返回的access Token";
HttpResponse<String> response = Unirest.get("https://api.example.com/oapi/rpa/user/v1/list?latestLoginTimeBegin=1680192000&latestLoginTimeEnd=1706630400&expiredTimeBegin=1678550400&expiredTimeEnd=1741708800&accountTypes=basic,senior&page=1&size=20")
.header("Authorization",String.format("Bearer %s", accessToken)).asString();
System.out.println(response.getBody());
OpenAPIの記事一覧ページの先頭へ ↑