ジャンプ先

• リクエスト
• レスポンス
• 例

同様のロールを候補ロール・カバレッジとともにリスト

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles

リクエスト

パス・パラメータ

• candidateRoleId: string
• taskId: string

問合せパラメータ

• entitlementThreshold: integer(float)
• topCount: integer(int32)
• userThreshold: integer(float)

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

Body ()

ルート・スキーマ: SimilarRoleListResponse

型: object

ソースを表示

• recordCount(optional): integer
• similarRoles(optional): array similarRoles

{
    "properties":{
        "recordCount":{
            "type":"integer"
        },
        "similarRoles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SimilarRoleDTO"
            }
        }
    }
}

ネストされたスキーマ: similarRoles

型: array

ソースを表示

• 配列: object SimilarRoleDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SimilarRoleDTO"
    }
}

ネストされたスキーマ: SimilarRoleDTO

型: object

ソースを表示

• description(optional): string
• displayName(optional): string
• entitlementCount(optional): integer
• entitlementCoverage(optional): number
• id(optional): string
• name(optional): string
• userCount(optional): integer
• userCoverage(optional): number

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "entitlementCount":{
            "type":"integer"
        },
        "userCount":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"number"
        },
        "userCoverage":{
            "type":"number"
        }
    }
}

先頭に戻る

例

次の例は、同様のロールを候補ロール・カバレッジとともにリストする方法を示しています。

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/97d40d053dd74a45a6e944f45cbfae6a/similar-roles?topCount=5"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"recordCount": 1,
"similarRoles": [
{
"id": "G265",
"name": "apr12role2",
"displayName": "apr12role2",
"description": "apr12role2",
"entitlementCount": 5,
"userCount": 3,
"entitlementCoverage": 100,
"userCoverage": 50
}
]
}

先頭に戻る