機械翻訳について

移動先

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

キャンペーンのリストを取得

get

/access-governance/access-reviews/20250331/campaigns

すべてのキャンペーンのリストを返します。

リクエスト

問合せパラメータ

• 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" ]
• status: string
  キャンペーンでのステータス。

  許容値: [ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

campaignSummaryオブジェクトのページ。

ヘッダー

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

本文()

ルート・スキーマ : CampaignCollection

型: object

キャンペーン検索の結果。

ソースを表示

• items(必須): array items
  キャンペーン要約のリスト。

{
    "type":"object",
    "description":"Results of a campaign search.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of campaign summaries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CampaignSummary"
            }
        }
    }
}

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

型: array

キャンペーン要約のリスト。

ソースを表示

• Array of: object CampaignSummary
  AgcsCampaignのサマリー。

{
    "description":"List of campaign summaries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CampaignSummary"
    }
}

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

型: object

AgcsCampaignのサマリー。

ソースを表示

• creatorId: string
  作成者のID。
• displayName(必須): string
  キャンペーン表示名。
• frequency: string
  許容値: [ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ]

  繰返しキャンペーンの頻度。
• id(必須): string
  作成時に変更できない一意の識別子
• isApprovalWfCampaign: boolean
  現在のキャンペーンに承認ワークフローがある場合。
• isRecurring: boolean
  キャンペーンが繰り返されるかどうか - 繰返しの場合は、頻度およびseriesRecurrencesも指定されます。
• ownerId: string
  キャンペーンの所有者ID。
• ownerName: string
  キャンペーンの所有者名。
• reviewProgress: number(float)
  レビューの進捗。
• scope: string
  許容値: [ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]

  キャンペーンの範囲。
• status(必須): string
  許容値: [ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]

  キャンペーンでのステータス。
• timeDue: string(date-time)
  キャンペーンが終了する時間。
• timeStarted: string(date-time)
  キャンペーンが開始される時間。
• type(必須): string
  許容値: [ "ACCESS", "OWNERSHIP" ]

  キャンペーンのタイプ(アクセスまたは所有権)。

{
    "description":"Summary of the AgcsCampaign.",
    "type":"object",
    "required":[
        "id",
        "displayName",
        "status",
        "type"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation.",
            "type":"string"
        },
        "displayName":{
            "description":"The campaign display name.",
            "type":"string"
        },
        "type":{
            "description":"The type of the campaign (access or ownership).",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignType",
            "enum":[
                "ACCESS",
                "OWNERSHIP"
            ]
        },
        "ownerName":{
            "description":"The owner name of the campaign.",
            "type":"string"
        },
        "ownerId":{
            "description":"The owner ID of the campaign.",
            "type":"string"
        },
        "creatorId":{
            "description":"The ID of the creator.",
            "type":"string"
        },
        "status":{
            "description":"The status of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignState",
            "enum":[
                "DRAFT",
                "SCHEDULED",
                "IN_PROGRESS",
                "READY_FOR_APPROVAL",
                "APPROVED",
                "TERMINATED",
                "SYSTEM_ABORTED"
            ]
        },
        "timeStarted":{
            "description":"The time that the campaign will start.",
            "type":"string",
            "format":"date-time"
        },
        "timeDue":{
            "description":"The time that the campaign will end.",
            "type":"string",
            "format":"date-time"
        },
        "reviewProgress":{
            "description":"The progress of the review.",
            "type":"number",
            "format":"float"
        },
        "frequency":{
            "description":"The frequency of a recurring campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/Frequency",
            "enum":[
                "ONE_TIME",
                "MONTHLY",
                "QUARTERLY",
                "HALF_YEARLY",
                "YEARLY"
            ]
        },
        "isRecurring":{
            "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.",
            "type":"boolean"
        },
        "scope":{
            "description":"The scope of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignScope",
            "enum":[
                "GOVERNANCE_SYSTEM",
                "CLOUD_PROVIDER",
                "AG"
            ]
        },
        "isApprovalWfCampaign":{
            "description":"If the current campaign is having approval workflow.",
            "type":"boolean"
        }
    }
}

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."
}

トップに戻る

例

次の例は、すべてのキャンペーンのリストを取得する方法を示しています。

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

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns'

cURL例 - 問合せパラメータあり

データを制限し、IN_PROGRESSキャンペーンのみを含めるcURLコマンド。

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns?status=IN_PROGRESS'

レスポンス本文の例

次の例は、進行中のキャンペーンのリストを含む、JSON形式のレスポンス本文の内容を示しています:

{
    "items": [
        {
            "id": "ocid1.agcscampaign.oc1.iad.amaaaaaapzw5rdxxxxxxxe3f6obzlpjoze7tito4cpm6nwe2hpga5vtm56yq",
            "displayName": "Quarterly Access Audit - Q2 2025",
            "type": "ACCESS",
            "ownerName": "Bill Clark",
            "ownerId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.55045.02xxxxbb4b201421b44aa046b3ceb16a",
            "creatorId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02xxxxbb4b201421b44aa046b3ceb16a",
            "status": "IN_PROGRESS",
            "timeStarted": "2025-06-02T06:52:25.684Z",
            "timeDue": "2025-06-07T06:52:25.684Z",
            "reviewProgress": 0.0,
            "frequency": "ONE_TIME",
            "isRecurring": false,
            "scope": "AG",
            "isApprovalWfCampaign": true
        }
    ]
}

先頭に戻る