Jump to

• Request
• Response

Get Job Details

get

/cloudapi/restapi/v3/bgjobs/{bgJobName}

This end point returns background job details. It includes the last run date, start time of job, end time of completed job, job status, logs if job is processed, and runtime user Example request: GET /cloudapi/restapi/v3/bgjobs/PVD

Request

Path Parameters

• bgJobName(required): string
  Background job name for which the status is being requested

  Example:

  PVD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : BackgroundJobService

Type: object

Title: BackgroundJobService

Show Source

• created: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• end: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• id: integer (int32)
  Title: id
• isLocked: boolean
  Title: isLocked
• lastRunUser: string
  Title: lastRunUser
• logs: string
  Title: logs
• start: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• status: string
  Title: status

  Allowed Values: [ "NEW", "RUNNING", "FAILED", "COMPLETED" ]
• type: string
  Title: type

  Allowed Values: [ "DATASYNC", "BIDDER", "PVD" ]
• updated: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• workerHost: string
  Title: workerHost

{
    "title":"BackgroundJobService",
    "type":"object",
    "properties":{
        "id":{
            "title":"id",
            "type":"integer",
            "format":"int32"
        },
        "type":{
            "title":"type",
            "type":"string",
            "enum":[
                "DATASYNC",
                "BIDDER",
                "PVD"
            ]
        },
        "isLocked":{
            "title":"isLocked",
            "type":"boolean"
        },
        "start":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "status":{
            "title":"status",
            "type":"string",
            "enum":[
                "NEW",
                "RUNNING",
                "FAILED",
                "COMPLETED"
            ]
        },
        "workerHost":{
            "title":"workerHost",
            "type":"string"
        },
        "logs":{
            "title":"logs",
            "type":"string"
        },
        "created":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "updated":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "end":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "lastRunUser":{
            "title":"lastRunUser",
            "type":"string"
        }
    }
}

Nested Schema : CloudTZDateTime

Type: object

Title: CloudTZDateTime

Read Only: true

Date and time when the password was last reset.

Show Source

• millis: integer (int64)
  Title: millis
• wrappedDateTime: string (date-time)
  Title: wrappedDateTime

{
    "title":"CloudTZDateTime",
    "type":"object",
    "properties":{
        "millis":{
            "title":"millis",
            "type":"integer",
            "format":"int64"
        },
        "wrappedDateTime":{
            "title":"wrappedDateTime",
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Date and time when the password was last reset.",
    "readOnly":true
}

400 Response

An invalid job name was specified. Please recheck the input. Job name can only be pvd, datasync or bidder

Back to Top