機械翻訳について

移動先

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

取引先プロファイルのリストの取得

get

/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/accountProfiles

ページ区切りをサポートしている、特定のオーケストレーション・システムに関連付けられた使用可能なすべてのアカウント・プロファイルの詳細を返します。

リクエスト

パス・パラメータ

• orchestratedSystemId(required): string
  オーケストレーション・システムの一意のID。 使用可能な値は、ListOrchestratedSystems操作を使用して確認できます。

問合せパラメータ

• isDefaultOnly: boolean
  最小長: 1

  最大長: 255

  デフォルトのAccountProfileのみを返すようにリクエストするパラメータ。

  デフォルト値: false
• keywordContains: array[string]
  コレクション形式: multi

  最大アイテム数: 5

  次のフィールドからフィルタするキーワードのリスト: displayName, description.
• limit: integer
  最小値: 1

  最大値: 1000

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

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

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

  デフォルト値: timeCreated

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

  許容値: [ "ASC", "DESC" ]

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

取引先プロファイル概要のリスト

ヘッダー

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

本文()

ルート・スキーマ : AccountProfileCollection

型: object

AccountProfile検索の結果。 AccountProfileSummaryアイテムのリストが含まれます。

ソースを表示

• items(必須): array items
  AccountProfileSummaryアイテムのリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of AccountProfileSummary items.",
            "items":{
                "$ref":"#/definitions/AccountProfileSummary"
            }
        }
    },
    "description":"Results of an AccountProfile search. Contains a list of AccountProfileSummary items."
}

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

型: array

AccountProfileSummaryアイテムのリスト。

ソースを表示

• Array of: object AccountProfileSummary
  リストを戻すときに使用されるAccountProfileのサマリー。

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

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

型: object

リストを戻すときに使用されるAccountProfileのサマリー。

ソースを表示

• displayName(必須): string
  AccountProfile識別子。名前を変更できます
• id(必須): string
  作成時に変更できない一意の識別子
• isDefault(必須): boolean
  このAccountProfileがこのサービス・インスタンスのデフォルトかどうかを示します。
• lastModifiedBy(required): object IdentityReference
  ユーザーの詳細
• timeLastModified(required): string(date-time)
  AccountProfileが最後に更新された時間。 「An RFC3339」書式設定日時文字列

{
    "type":"object",
    "required":[
        "displayName",
        "id",
        "isDefault",
        "lastModifiedBy",
        "timeLastModified"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "displayName":{
            "type":"string",
            "description":"AccountProfile Identifier, can be renamed"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if this AccountProfile is the default for this service instance."
        },
        "timeLastModified":{
            "type":"string",
            "format":"date-time",
            "description":"The time the AccountProfile was last updated. An RFC3339 formatted datetime string"
        },
        "lastModifiedBy":{
            "$ref":"#/definitions/IdentityReference"
        }
    },
    "description":"Summary of the AccountProfile, used when returning lists."
}

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

型: object

ユーザーの詳細

ソースを表示

• id(必須): string
  AGアイデンティティのID
• name(required): string
  表示名AGアイデンティティ

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for AG Identity"
        },
        "name":{
            "type":"string",
            "description":"The Display name AG Identity"
        }
    },
    "description":"User details."
}

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 GETの例

curl -i -X \
 GET \
   -H \
 "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/service-administration/${version}/orchestratedSystems/${orchestratedSystemId}/accountProfiles'

RESTクライアント・ツールを使用したGETコマンドの例

${service-instance-url}/access-governance/service-administration/${version}/orchestratedSystems/${orchestratedSystemId}/accountProfiles

レスポンス・コードの例

次のレスポンス本文を含む200 OKレスポンス・コードを受け取ります:

{
  "items" : [ {
    "id" : "84321700-1a93-4cf2-9226-1xxxxxxxxxxx8",
    "displayName" : "dbum API",
    "isDefault" : true,
    "timeLastModified" : "2025-03-25T06:19:01.234Z",
    "lastModifiedBy" : {
      "id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.0xxxxxxxxxx4aa046b3ceb16a",
      "name" : "Amel Maclead"
    }
  } ]
}
    

ノート:

アイテムのない200 OKレスポンスを取得した場合は、指定されたオーケストレーション・システムに関連付けられているアカウント・プロファイルがないことを示します。

先頭に戻る