機械翻訳について

移動先

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

承認プロセスのリストの取得

get

/access-governance/access-controls/20250331/approvalWorkflows

ページ区切りをサポートする、使用可能なすべての承認ワークフローの詳細を返します。

リクエスト

問合せパラメータ

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

  最大アイテム数: 5

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

  最大値: 1000

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

  デフォルト値: 10
• outOfBoxCategory: string
  フィルタを適用する即時利用可能なワークフローのカテゴリを示します。 指定した場合、'isOutOfBox'はtrueとみなされ、'isTransition'は無視されます。

  許容値: [ "UNMATCHED", "OWNERSHIP", "TRANSITION" ]
• ownerId: string
  フィルタ条件とする所有者ID
• page: string
  最小長: 1

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• processId: string
  フィルタを適用する承認プロセスID。 指定した場合、承認プロセスの既存のバージョンがすべて提供されます。
• sortBy: string
  ソートの基準となるフィールド。 デフォルトのソート基準はdisplayNameです。

  デフォルト値: displayName

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

  許容値: [ "ASC", "DESC" ]
• state: string
  指定された承認プロセス状態に一致するワークフローのみを返すフィルタ。

  許容値: [ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ]

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

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

ヘッダー

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

本文()

ルート・スキーマ : ApprovalProcessCollection

型: object

承認プロセス検索の結果。

ソースを表示

• items(必須): array items
  承認プロセス・サマリーのリスト。

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

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

型: array

承認プロセス・サマリーのリスト。

ソースを表示

• Array of: object ApprovalProcessSummary
  AgcsApprovalProcessのサマリー。

{
    "type":"array",
    "description":"List of approval process summaries.",
    "items":{
        "$ref":"#/definitions/ApprovalProcessSummary"
    }
}

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

型: object

AgcsApprovalProcessのサマリー。

ソースを表示

• creatorId(required): string
  作成者のID。
• displayName(必須): string
  最小長: 1

  最大長: 100

  承認プロセス名は一意である必要があります。
• guid(required): string
  承認プロセス定義のグローバル識別子。
• isDefault: boolean
  承認プロセスがデフォルトのプロセスである場合はtrueに設定します。
• isInDraftMode(required): boolean
  承認プロセスのドラフトが使用可能かどうかを示します。
• isRuntime: boolean
  実行時に承認プロセスに構成が指定されている場合はtrueに設定します。
• ownedEntityId: string
  所有権コレクション所有エンティティID
• owner: object ApprovalProcessOwner
  承認プロセス・オーナーの詳細。
• ownershipCollectionId: string
  所有権コレクションID
• state(required): string
  許容値: [ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ]

  承認プロセスのライフサイクル状態。
• timeCreated(required): string(日時)
  承認プロセスが作成された時間。
• timeUpdated(required): string(日時)
  プロセスの最終更新日。
• updaterId(required): string
  プロセスを最後に更新した個人のユーザーID。
• version: integer
  承認プロセス定義のバージョン。

{
    "type":"object",
    "required":[
        "creatorId",
        "displayName",
        "guid",
        "isInDraftMode",
        "state",
        "timeCreated",
        "timeUpdated",
        "updaterId"
    ],
    "properties":{
        "guid":{
            "type":"string",
            "description":"The global identifier for the approval process definition."
        },
        "version":{
            "type":"integer",
            "description":"The version of the approval process definition."
        },
        "displayName":{
            "type":"string",
            "description":"The approval process name, must be unique.",
            "minLength":1,
            "maxLength":100
        },
        "state":{
            "type":"string",
            "description":"The lifecycle state of the approval process.",
            "enum":[
                "DRAFT",
                "PUBLISHING",
                "ACTIVE",
                "DISABLED",
                "DELETING"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessState"
        },
        "isInDraftMode":{
            "type":"boolean",
            "description":"Indicates whether a draft for the approval process is available."
        },
        "creatorId":{
            "type":"string",
            "description":"The ID of the creator."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The time that the approval process was created."
        },
        "updaterId":{
            "type":"string",
            "description":"User ID of last person that updated the process."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update date of the process."
        },
        "isRuntime":{
            "type":"boolean",
            "description":"Set to true if the approval process has configuration provided at runtime."
        },
        "isDefault":{
            "type":"boolean",
            "description":"Set to true if the approval process is the default process."
        },
        "ownershipCollectionId":{
            "type":"string",
            "description":"The ownership collection ID"
        },
        "ownedEntityId":{
            "type":"string",
            "description":"The ownership collection owned entity ID"
        },
        "owner":{
            "$ref":"#/definitions/ApprovalProcessOwner"
        }
    },
    "description":"Summary of the AgcsApprovalProcess."
}

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

型: object

承認プロセス・オーナーの詳細。

ソースを表示

• displayName(必須): string
  アイデンティティの表示名。
• id(必須): string
  最小長: 1

  最大長: 255

  アイデンティティのユーザーID。
• isPrimary(required): boolean
  ユーザーがプライマリ所有者の場合はtrueに設定し、それ以外の場合はfalseに設定します。

{
    "type":"object",
    "required":[
        "displayName",
        "id",
        "isPrimary"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"User ID of the identity.",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the identity."
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Set to true if the user is the primary owner, set to false otherwise."
        }
    },
    "description":"Details of an approval process owner."
}

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

トップに戻る

例

次の例は、GETリクエストを発行して承認ワークフローのリストを取得する方法を示しています。

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

curl -i -X GET \
   -H "Authorization:Bearer <your access token >" \
 '${service-instance-url}/access-governance/access-controls/20250331/approvalWorkflows'

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

curl -i -X GET \
-H "Authorization:Bearer <your access token >" \ 
'${service-instance-url}/access-governance/access-controls/20250331/approvalWorkflows?limit=1'

レスポンス本文の例

次の例は、承認ワークフローのリストを含む、JSON形式のレスポンス本文のコンテンツを示しています:

{
"items":[
{
"guid": "Guid_fxxxxxxb-7031-xxad-844b-3b6e7dfff0e6",
"version": 1,
"displayName": "Bill Clark",
"state": "ACTIVE",
"isInDraftMode": false,
"creatorId": "Bill Clark",
"timeCreated": "2024-04-08T13:45:13.684Z",
"updaterId": null,
"timeUpdated": null,
"isRuntime": false,
"isDefault": false,
"ownershipCollectionId": "e03f2064-83d7-49e7-9487-32xxxxxxxxxx",
"ownedEntityId": "Guid_xxxxxxxx-7031-47ad-844b-3xxxxxxxxxxx",
"owner":{"id": "globalId.OCI.OCI-System.3ad438fxxxxxed9c45184xxxxxxxx", "displayName": "Bill Clark", "isPrimary": true…}
}
]
}

先頭に戻る