Jump to

• Request
• Response

View Job Status

post

/pds/rest-service/dataservice/jobStatus

Send a request to view job details. This endpoint will return list of job details.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Filter conditions.

Root Schema : JobFilterRO

Type: object

Title: JobFilterRO

Filter condition entity.

Show Source

• jobIds: array jobIds
  List of scheduled job ids
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

  Scheduled job status
• jobType: string
  Allowed Values: [ "EXPORT_DATA" ]

  Scheduled job type

{
    "title":"JobFilterRO",
    "type":"object",
    "properties":{
        "jobIds":{
            "type":"array",
            "description":"List of scheduled job ids",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "jobType":{
            "type":"string",
            "description":"Scheduled job type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EXPORT_DATA"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"Scheduled job status",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        }
    },
    "description":"Filter condition entity.",
    "exampleSetFlag":false
}

Nested Schema : jobIds

Type: array

List of scheduled job ids

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of scheduled job ids",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Operation

Body ()

Root Schema : List<JobDetailsRO>

Type: array

Title: List<JobDetailsRO>

Show Source

• Array of: object JobDetailsRO
  Title: JobDetailsRO

{
    "title":"List<JobDetailsRO>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/JobDetailsRO",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : JobDetailsRO

Type: object

Title: JobDetailsRO

Show Source

• endDate: string
  The date and time the job was completed
• jobDataExpireTime: string
  The last date and time the job details to be available
• jobId: string
  The unique identifier for the background service.
• jobLog: string
  Log of the job. This will retrun if job is failed
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

  Scheduled job status
• jobType: string
  Allowed Values: [ "EXPORT_DATA", "EXPORT_DATA" ]

  Scheduled job type
• startDate: string
  The date and time the job was started

{
    "title":"JobDetailsRO",
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"The unique identifier for the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobType":{
            "type":"string",
            "description":"Scheduled job type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EXPORT_DATA",
                "EXPORT_DATA"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"Scheduled job status",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "jobLog":{
            "type":"string",
            "description":"Log of the job. This will retrun if job is failed",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The date and time the job was started",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the job was completed",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobDataExpireTime":{
            "type":"string",
            "description":"The last date and time the job details to be available",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

No Content

500 Response

Internal Server Error

Back to Top