一般情報
応答の形式
正常応答の場合はHTTPのレスポンスコード200を返し、データを返すメソッドの場合はレスポンスのbody部にUTF-8エンコードのJSON形式のテキストを含みます。エラーは、ユーザ認証に失敗した場合にはHTTPレスポンスコード401(Unauthorized)、認証されたユーザが指定した操作を実行する権限を持たない場合403(Forbidden)を返します。それ以外のエラーの場合 HTTP のレスポンスコード400を返し、body部にはエラーの内容をJSON形式のテキストで記述します。
応答オブジェクト
応答でデータを返す場合、応答のデータは以下の種類のオブジェクト、もしくはこれらのオブジェクトのリストです。
| オブジェクト種別 |
説明 |
| QuserEntry |
ユーザを表すオブジェクト |
| QgroupEntry |
組織を表すオブジェクト |
| MembershipEntry |
組織の所属メンバを表すオブジェクト |
これらのオブジェクトの詳細については「ユーザ管理API」のページを参照してください
エラー応答オブジェクト
エラー応答をJSON形式で返す場合、errorsという名前でErrorEntryの配列を返します。ErrorEntryの詳細およびエラー種別の一覧は「ユーザ管理API」のページを参照してください。
処理一覧
ユーザ検索 API で実行可能な処理は以下のとおりです。URL 中の<ContextRoot>は接続先のQuestetra BPM Suiteのコンテキストルートを代入してください。
| 操作 |
URL |
| 自身のユーザ情報の取得 |
<ContextRoot>/API/User/Quser/self |
| ユーザ一覧の取得 |
<ContextRoot>/API/User/Quser/list |
| 組織一覧の取得 |
<ContextRoot>/API/User/Qgroup/list |
| ユーザの検索 |
<ContextRoot>/API/User/Quser/find |
| 組織の検索 |
<ContextRoot>/API/User/Qgroup/find |
自身のユーザ情報の取得
API アクセスで認証されたユーザ自身の情報を返します。
導入バージョン
7.4.0
URL
<ContextRoot>/API/User/Quser/self
パラメータ
なし
応答
| オブジェクト名 |
説明 |
| quser |
自身のユーザのQuserEntry |
発生する可能性のあるエラー
なし
ユーザ一覧の取得
システム内の全ユーザのリストを返します。ユーザ名やメールアドレスで検索も可能です。応答はユーザ名の昇順でソートされています。
導入バージョン
7.4.0
URL
<ContextRoot>/API/User/Quser/list
パラメータ
| パラメータ名 |
説明 |
| limit |
取得するユーザの最大件数を指定します。 指定しなかった場合は、1が指定されたものとみなされます。 |
| start |
取得するユーザの開始位置を指定します。最小値は0です。指定しなかった場合は、0が指定されたものとみなされます。
検索結果の全件が100で、startに10、limitに50を指定した場合、100件目のうち11件目から60件を取得することになります。 |
| query |
検索文字列を指定します。値が指定された場合、その値がメールアドレスまたは名前の一部に含まれているユーザを検索します。qgroupId と組み合わせて検索することができます。
|
| qgroupId |
組織IDを指定します。値が指定された場合、その組織に直属するユーザを検索します。query と組み合わせて検索することができます。 |
応答
| ブジェクト名 |
説明 |
| qusers |
全ユーザのQuserEntryのリスト |
発生する可能性のあるエラー
- Validation
- InvalidQgroupId
組織一覧の取得
システム内の全組織のリストを返します。組織名やメールアドレスで検索も可能です。応答は組織名の昇順でソートされています。
導入バージョン
7.4.0
URL
<ContextRoot>/API/User/Qgroup/list
パラメータ
| パラメータ名 |
説明 |
| limit |
取得する組織の最大件数を指定します。 指定しなかった場合は、1が指定されたものとみなされます。 |
| start |
取得する組織の開始位置を指定します。最小値は0です。指定しなかった場合は、0が指定されたものとみなされます。
検索結果の全件が100で、startに10、limitに50を指定した場合、100件目のうち11件目から60件を取得することになります。 |
| query |
検索文字列を指定します。値が指定された場合、その値がメールアドレスまたは名前の一部に含まれている組織を検索します。
|
応答
| オブジェクト名 |
説明 |
| qgroups |
全組織のQgroupEntryのリスト |
発生する可能性のあるエラー
ユーザの検索
ユーザを検索します。該当のユーザが存在しない場合は QuserDoesNotExistエラーを返します。
導入バージョン
7.4.0
URL
><ContextRoot>/API/User/Quser/find
パラメータ
| パラメータ名 |
説明 |
| id |
値が指定された場合、その値をIDに持つユーザを検索します。 |
| email |
値が指定された場合、その値をメールアドレスに持つユーザを検索します。
両方とも指定された場合は、id のみが有効になります。 |
応答
| オブジェクト名 |
説明 |
| quser |
該当ユーザのQuserEntry |
発生する可能性のあるエラー
- InvalidId
- InvalidEmail
- QuserDoesNotExist
組織の検索
組織を検索します。該当のユーザが存在しない場合は、QgroupDoesNotExistエラーを返します。
導入バージョン
7.4.0
URL
<ContextRoot>/API/User/Qgroup/find
パラメータ
| パラメータ名 |
説明 |
| id |
値が指定された場合、その値をIDに持つ組織を検索します。 |
| name |
値が指定された場合、その値を名前に持つ組織を検索します。
両方とも指定された場合は、id のみが有効になります。 |
応答
| オブジェクト名 |
説明 |
| qgroup |
該当組織のQgroupEntry |
発生する可能性のあるエラー
- InvalidId
- InvalidName
- QgroupDoesNotExist
| 
