機械翻訳について

移動先

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

指定されたステージの保留中のレビューアのリストを取得

get

/access-governance/access-reviews/20250331/campaigns/{campaignId}/stages/{stageId}/reviewers

リクエスト

パス・パラメータ

• campaignId(required): string
  一意のキャンペーン識別子。
• stageId(required): string
  指定されたキャンペーンのステージ識別子。

問合せパラメータ

• keywordContains: array[string]
  コレクション形式: multi

  最大アイテム数: 5

  フィルタするキーワードのリスト
• limit: integer
  最小値: 1

  最大値: 1000

  返されるアイテムの最大数。

  デフォルト値: 10
• page: string
  最小長: 1

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• sortBy: string
  ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。

  デフォルト値: timeCreated

  許容値: [ "timeCreated", "displayName" ]
• sortOrder: string
  使用するソート順(ASCまたはDESC)。

  許容値: [ "ASC", "DESC" ]
• templateId: string
  キャンペーンの特定のステージのtemplateId。

ヘッダー・パラメータ

• opc-request-id: string
  トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

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

• application/json

200レスポンス

指定されたステージの保留中のレビューアのリスト。

ヘッダー

• opc-next-page: string
  アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
• opc-total-items: integer
  アイテムの総数。

本文()

ルート・スキーマ : StageReviewerSummaryCollection

型: object

StageReviewerSummaryのリスト。

ソースを表示

• items(必須): array items
  項目。

{
    "type":"object",
    "description":"The list of StageReviewerSummary.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"the items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/StageReviewerSummary"
            }
        }
    }
}

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

型: array

項目。

ソースを表示

• Array of: object StageReviewerSummary
  保留中のステージ・レビューア詳細。

{
    "description":"the items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/StageReviewerSummary"
    }
}

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

型: object

保留中のステージ・レビューア詳細。

ソースを表示

• displayName(必須): string
  レビューアの表示名。
• email: string
  レビュー担当者のEメール。
• pendingCount(required): integer
  レビュー・タスクの待ち状態の件数。

{
    "type":"object",
    "description":"The pending stage reviewer details.",
    "required":[
        "displayName",
        "pendingCount"
    ],
    "properties":{
        "displayName":{
            "description":"The display name of the reviewer.",
            "type":"string"
        },
        "email":{
            "description":"The email of the reviewer.",
            "type":"string"
        },
        "pendingCount":{
            "description":"The pending count of review tasks.",
            "type":"integer"
        }
    }
}

400レスポンス

不正なリクエスト

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、特定のステージの保留中のレビューアの詳細を取得する方法を示しています。 キャンペーンAPIの詳細の取得からステージIDをフェッチします。 サンプル・コマンドを実行する前に、プレースホルダー値を実際の値に置き換えます。

cURL例 - 問合せパラメータなし

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/campaigns/${campaignId}/stages/${stageId}/reviewers'

レスポンス本文の例

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

{
    "items": [
        {
            "displayName": "Arthur Jones",
            "email": "[e-mail]",
            "pendingCount": 1
        }
    ]
}

先頭に戻る