機械翻訳について

ジャンプ先

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

コールバックURLを登録

post

ess/rest/scheduler/v1/requests/{requestId}/subscribe

リクエストの送信中にコールバックURLが実行されない場合に備えて登録します。

リクエスト

パス・パラメータ

• requestId(required): integer(int64)
  ジョブ・リクエストID

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

• application/json
• application/vnd.oracle.resource+json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

タイプ: object

コールバック停止エンドポイントの呼出しに必要なプロパティの典型的なセット。 これらのプロパティは、securitySchemeに従って指定する必要があります。

Show Source

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。 このプロパティは、通常、DIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。 ベース・リソースURLは、callbackUrlPrefixプロパティで指定されます。 このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  リソースの完全なURLを提供するためにcallbackResourcePathプロパティとともに使用できるRESTリソースのベースURLを指定するプロパティ。 このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。 Eg: "idcs.client.credentials". これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。 このプロパティは、通常、OWSM_LPAセキュリティ・スキームに必要です。
• securityScheme: string
  許可された値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]

  "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"の中から1つ。 指定しない場合、デフォルトはOWSM_GPAとみなされます。 OWSM_LPAの場合、クライアントからアタッチされたデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。 "OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ" oracle.wsm.security "の下のCSFで構成されていることを確認する必要があります。 "DIRECT_OAUTHセキュリティ"スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバはclientIdおよびシークレットがIDCSで構成されていることを確認する必要があります。

{
    "required":[
        "callbackUrlPrefix",
        "callbackResourcePath"
    ],
    "type":"object",
    "properties":{
        "securityScheme":{
            "type":"string",
            "description":"One among \"OWSM_GPA\", \"OWSM_LPA\", \"DIRECT_OAUTH\". \nIf unspecified, the default will be assumed as OWSM_GPA. For OWSM_LPA, the default policy attached from client will be \"oracle/http_oauth2_token_client_policy\".\nFor \"ouath2ClientCsfKey\" property of \"OWSM_LAP\" security scheme, the subscribers need to ensure the password credential is configured in CSF under the csf map \"oracle.wsm.security\".\nFor \"clientId\" and \"clientSecret\" properties of \"DIRECT_OAUTH security\" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS. \n",
            "enum":[
                "OWSM_GPA",
                "OWSM_LPA",
                "DIRECT_OAUTH"
            ]
        },
        "callbackUrlPrefix":{
            "type":"string",
            "description":"Property that specifies the base URL of a REST Resource that can be used in conjunction with callbackResourcePath property to provide a full URL for the resource. This property is required for all the security schemes.\n"
        },
        "callbackResourcePath":{
            "type":"string",
            "description":"Property that specifies the relative Path for REST Resource. The base Resource URL is given by callbackUrlPrefix property. This property is required for all the security schemes.\n"
        },
        "accessTokenUri":{
            "type":"string",
            "description":"URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.\n"
        },
        "ouath2ClientCsfKey":{
            "type":"string",
            "description":"Property to set the client's CSF key. Eg: \"idcs.client.credentials\". This will be specified in OWSM's ConfigOverride.CO_OAUTH2_CLIENT_CSF_KEY while creating PolicySetFeature. This property is usually required for OWSM_LPA security scheme.\n"
        },
        "clientId":{
            "type":"string",
            "description":"The clientId issued by OAuth server during client registration that should be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret issued by OAuth server during client registration that should be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        }
    },
    "description":"The typical set of properties that are required to invoke the callback rest endpoint. These properties need to be specified as per the securityScheme.\n"
}

リクエスト本文 - application/vnd.oracle.resource +json ()

ルート・スキーマ : schema

タイプ: object

コールバック停止エンドポイントの呼出しに必要なプロパティの典型的なセット。 これらのプロパティは、securitySchemeに従って指定する必要があります。

Show Source

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。 このプロパティは、通常、DIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。 ベース・リソースURLは、callbackUrlPrefixプロパティで指定されます。 このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  リソースの完全なURLを提供するためにcallbackResourcePathプロパティとともに使用できるRESTリソースのベースURLを指定するプロパティ。 このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットで、コールを行う前に資格証明ストアに追加してポリシー・パラメータとして指定する必要があります。 このプロパティは、通常、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。 Eg: "idcs.client.credentials". これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。 このプロパティは、通常、OWSM_LPAセキュリティ・スキームに必要です。
• securityScheme: string
  許可された値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]

  "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"の中から1つ。 指定しない場合、デフォルトはOWSM_GPAとみなされます。 OWSM_LPAの場合、クライアントからアタッチされたデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。 "OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ" oracle.wsm.security "の下のCSFで構成されていることを確認する必要があります。 "DIRECT_OAUTHセキュリティ"スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバはclientIdおよびシークレットがIDCSで構成されていることを確認する必要があります。

{
    "required":[
        "callbackUrlPrefix",
        "callbackResourcePath"
    ],
    "type":"object",
    "properties":{
        "securityScheme":{
            "type":"string",
            "description":"One among \"OWSM_GPA\", \"OWSM_LPA\", \"DIRECT_OAUTH\". \nIf unspecified, the default will be assumed as OWSM_GPA. For OWSM_LPA, the default policy attached from client will be \"oracle/http_oauth2_token_client_policy\".\nFor \"ouath2ClientCsfKey\" property of \"OWSM_LAP\" security scheme, the subscribers need to ensure the password credential is configured in CSF under the csf map \"oracle.wsm.security\".\nFor \"clientId\" and \"clientSecret\" properties of \"DIRECT_OAUTH security\" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS. \n",
            "enum":[
                "OWSM_GPA",
                "OWSM_LPA",
                "DIRECT_OAUTH"
            ]
        },
        "callbackUrlPrefix":{
            "type":"string",
            "description":"Property that specifies the base URL of a REST Resource that can be used in conjunction with callbackResourcePath property to provide a full URL for the resource. This property is required for all the security schemes.\n"
        },
        "callbackResourcePath":{
            "type":"string",
            "description":"Property that specifies the relative Path for REST Resource. The base Resource URL is given by callbackUrlPrefix property. This property is required for all the security schemes.\n"
        },
        "accessTokenUri":{
            "type":"string",
            "description":"URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.\n"
        },
        "ouath2ClientCsfKey":{
            "type":"string",
            "description":"Property to set the client's CSF key. Eg: \"idcs.client.credentials\". This will be specified in OWSM's ConfigOverride.CO_OAUTH2_CLIENT_CSF_KEY while creating PolicySetFeature. This property is usually required for OWSM_LPA security scheme.\n"
        },
        "clientId":{
            "type":"string",
            "description":"The clientId issued by OAuth server during client registration that should be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret issued by OAuth server during client registration that should be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        }
    },
    "description":"The typical set of properties that are required to invoke the callback rest endpoint. These properties need to be specified as per the securityScheme.\n"
}

トップに戻る

レスポンス

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

• application/json
• application/vnd.oracle.resource+json

200 レスポンス

操作が開始されました

本文 ()

ルート・スキーマ : リンク

タイプ: array

Show Source

• Array of: object Link

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

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(required): string
• rel(required): string
  許可された値: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 レスポンス

登録のリクエストはサポートされていません

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403 レスポンス

この操作には使用できません

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404 レスポンス

リクエストIDが見つかりません

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

409 レスポンス

競合

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500 レスポンス

スケジューリング・サブシステム・エラー

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

「トップに戻る」