1. REST API for Common Features in Oracle Fusion Cloud Applications
  2. Tasks
  3. Scheduler

Registers the callback URL

post

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

Registers for the callback URL in case it is not done during request submission.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
The typical set of properties that are required to invoke the callback rest endpoint. These properties need to be specified as per the securityScheme.
Show Source
  • URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Allowed Values: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]
    One among "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH". If 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". For "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". For "clientId" and "clientSecret" properties of "DIRECT_OAUTH security" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS.
Request Body - application/vnd.oracle.resource+json ()
Root Schema : schema
Type: object
The typical set of properties that are required to invoke the callback rest endpoint. These properties need to be specified as per the securityScheme.
Show Source
  • URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Allowed Values: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]
    One among "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH". If 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". For "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". For "clientId" and "clientSecret" properties of "DIRECT_OAUTH security" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS.
Back to Top

Response

Supported Media Types

200 Response

Operation initiated
Body ()

400 Response

Unsupported request for registration
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

403 Response

Not allowed for this operation
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

404 Response

Request ID not found
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

409 Response

Conflict
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

500 Response

Scheduling sub-system error
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source
Back to Top