Jump to

• Request
• Response

Retrieve Job Status

get

/v1/jobs/{jobid}/status

Retrieve the status of jobs of your Service instance.

Request

Path Parameters

• jobid: string
  Id of the job whose status is to be retrieved

Back to Top

Response

Supported Media Types

• application/json

200 Response

Job status obtained

Body ()

Root Schema : JobExecutionInfo

Type: object

Show Source

• duration(optional): string
• endTime(optional): object ZonedDateTime
• jobId(optional): string
• jobName(optional): string
• links(optional): array links
• startTime(optional): object ZonedDateTime
• status(optional): string
• summaryMessage(optional): string

{
    "type":"object",
    "properties":{
        "summaryMessage":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "jobName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "startTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "endTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "duration":{
            "type":"string"
        }
    }
}

Nested Schema : ZonedDateTime

Type: object

Show Source

• chronology(optional): object Chronology
• dayOfMonth(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• dayOfYear(optional): integer(int32)
• hour(optional): integer(int32)
• minute(optional): integer(int32)
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• monthValue(optional): integer(int32)
• nano(optional): integer(int32)
• offset(optional): object ZoneOffset
• second(optional): integer(int32)
• year(optional): integer(int32)
• zone(optional): object ZoneId

{
    "type":"object",
    "properties":{
        "offset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "zone":{
            "$ref":"#/definitions/ZoneId"
        },
        "dayOfYear":{
            "type":"integer",
            "format":"int32"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "format":"int32"
        },
        "year":{
            "type":"integer",
            "format":"int32"
        },
        "monthValue":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        },
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "chronology":{
            "$ref":"#/definitions/Chronology"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Chronology

Type: object

Show Source

• calendarType(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "calendarType":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneOffset

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules
• totalSeconds(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalSeconds":{
            "type":"integer",
            "format":"int32"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneId

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules

{
    "type":"object",
    "properties":{
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset(optional): boolean
  Default Value: false
• transitionRules(optional): array transitionRules
• transitions(optional): array transitions

{
    "type":"object",
    "properties":{
        "fixedOffset":{
            "type":"boolean",
            "default":false
        },
        "transitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransition"
            }
        },
        "transitionRules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransitionRule"
            }
        }
    }
}

Nested Schema : transitionRules

Type: array

Show Source

• Array of: object ZoneOffsetTransitionRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransitionRule"
    }
}

Nested Schema : transitions

Type: array

Show Source

• Array of: object ZoneOffsetTransition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransition"
    }
}

Nested Schema : ZoneOffsetTransitionRule

Type: object

Show Source

• dayOfMonthIndicator(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime(optional): object LocalTime
• midnightEndOfDay(optional): boolean
  Default Value: false
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• standardOffset(optional): object ZoneOffset
• timeDefinition(optional): string
  Allowed Values: [ "UTC", "WALL", "STANDARD" ]

{
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "timeDefinition":{
            "type":"string",
            "enum":[
                "UTC",
                "WALL",
                "STANDARD"
            ]
        },
        "standardOffset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour(optional): integer(int32)
• minute(optional): integer(int32)
• nano(optional): integer(int32)
• second(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ZoneOffsetTransition

Type: object

Show Source

• dateTimeAfter(optional): string(date-time)
• dateTimeBefore(optional): string(date-time)
• duration(optional): object Duration
• gap(optional): boolean
  Default Value: false
• instant(optional): object Instant
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• overlap(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "gap":{
            "type":"boolean",
            "default":false
        },
        "overlap":{
            "type":"boolean",
            "default":false
        },
        "dateTimeAfter":{
            "type":"string",
            "format":"date-time"
        },
        "dateTimeBefore":{
            "type":"string",
            "format":"date-time"
        },
        "instant":{
            "$ref":"#/definitions/Instant"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

• nano(optional): integer(int32)
• negative(optional): boolean
  Default Value: false
• seconds(optional): integer(int64)
• units(optional): array units
• zero(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "seconds":{
            "type":"integer",
            "format":"int64"
        },
        "negative":{
            "type":"boolean",
            "default":false
        },
        "zero":{
            "type":"boolean",
            "default":false
        },
        "units":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemporalUnit"
            }
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Instant

Type: object

Show Source

• epochSecond(optional): integer(int64)
• nano(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "epochSecond":{
            "type":"integer",
            "format":"int64"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : units

Type: array

Show Source

• Array of: object TemporalUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemporalUnit"
    }
}

Nested Schema : TemporalUnit

Type: object

Show Source

• dateBased(optional): boolean
  Default Value: false
• duration(optional): object Duration
• durationEstimated(optional): boolean
  Default Value: false
• timeBased(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "dateBased":{
            "type":"boolean",
            "default":false
        },
        "durationEstimated":{
            "type":"boolean",
            "default":false
        },
        "timeBased":{
            "type":"boolean",
            "default":false
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• relation(optional): string

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

400 Response

Bad request

500 Response

Server error

Back to Top