Interrupt API

The Execution Status (POST) API Interrupts a batch/batch group execution.

• HTTP Method - POST
• URL - /SchedulerService/rest-api/v1/external/interrupt
• Header Parameters
  • ofs_tenant_id - Tenant ID of the Application
  • ofs_service_id - Service ID of the Application
  • ofs_workspace_id - Workspace ID of the Application. It is defaulted to “WS001” and same should be passed each time.
  • ofs_remote_user - Used ID of the user. This parameter should be mapped to 'BATCH_EXEC' function.
  • locale - locale in languageCode-countryCode format. For example, en-US.
  • Authorization: Bearer <token> - Access token required to authenticate the API. If this token is not provided, 401 Unauthorized error is generated. For more information about Bearer token, refer to Generate the Access Token.
• Sample cURL Command

  curl -i -H "ofs_service_id:<Service ID>" -H "ofs_remote_user:<User ID>" -H
        "ofs_tenant_id:<Tenant ID>" -H "ofs_workspace_id:WS001" -H "locale:en-US" -H
        "Content-Type: application/json" -H "Authorization: Bearer <BEARER_TOKEN>" -X POST
        <APPLICATION_BASE_PATH>/<URL> -d '<REQUEST_JSON>'