移動

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

コールバック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

コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。

ソースの表示

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。通常、このプロパティはDIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。ベース・リソースURLは、callbackUrlPrefixプロパティによって指定されます。このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  callbackResourcePathプロパティとともに使用してリソースの完全なURLを提供できるRESTリソースのベースURLを指定するプロパティ。このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdであり、これは、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットであり、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。例: "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"のいずれか。指定しない場合、デフォルトはOWSM_GPAとみなされます。OWSM_LPAの場合、クライアントからアタッチされるデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。"OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ"oracle.wsm.security"の下のCSFで構成されていることを確認する必要があります。DIRECT_OAUTHセキュリティ・スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバは、IDCSでclientIdおよびシークレットが構成されていることを確認する必要があります。

{
    "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 shall 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 shall 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 needs to be specified as per the securityScheme specified.\n"
}

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

ルート・スキーマ: schema

型: object

コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。

ソースの表示

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。通常、このプロパティはDIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。ベース・リソースURLは、callbackUrlPrefixプロパティによって指定されます。このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  callbackResourcePathプロパティとともに使用してリソースの完全なURLを提供できるRESTリソースのベースURLを指定するプロパティ。このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdであり、これは、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットであり、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。例: "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"のいずれか。指定しない場合、デフォルトはOWSM_GPAとみなされます。OWSM_LPAの場合、クライアントからアタッチされるデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。"OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ"oracle.wsm.security"の下のCSFで構成されていることを確認する必要があります。DIRECT_OAUTHセキュリティ・スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバは、IDCSでclientIdおよびシークレットが構成されていることを確認する必要があります。

{
    "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 shall 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 shall 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 needs to be specified as per the securityScheme specified.\n"
}

先頭に戻る

レスポンス

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

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

200レスポンス

操作が開始されました

本文()

ルート・スキーマ: Links

型: array

ソースの表示

• 配列: object Link

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

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

型: object

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

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

先頭に戻る