Notify Job Status

Notify Job Status

This is the callback URI that the R1 interface invokes to indicate that the job requested by the rApp is enabled or disabled. The rApp may use this information to choose to take a different course of action.

Request
URI
POST
https://{api_host}/v0alpha1/job_statuses/{job_id}
COPY
Path Parameters
string
job_id
Required

The unique identifier for one job that the rApp has created.

Request Body

Status notification object that indicates the status of a job created by the rApp.

JobStatusNotificationRequest of type(s) application/json
Required 
{
    "job_status_notification": "string"
}
string
job_status_notification
Required

The status string indicates whether job is ENABLED or DISABLED, from which the rApp can choose future courses of action.

Possible values are : ENABLED, DISABLED,
Responses
204

The status notification has been processed. If the job's status is DISABLED the job has been deleted.

Operation doesn't return any data structure

400

The status notification could not be processed because it does not have the correct format.

Returns ProblemDetails of type(s) application/json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


On This Page
Status Handling Operations
POST
Notify Job Status