Find a job by its identifier

GET 
/projects/:projectId/jobs/:jobId

Get the job by its id in the path.

Request

Path Parameters

projectId stringrequired

Project Identifier

jobId stringrequired

Job identifier

Header Parameters

X-API-Key string

Your SIU token if you use this API through Orange Developer.

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

application/json

Schema

Schema

id uuidrequired

Id of the job

hRef urirequired

Href of the job.

state JobStateEnum (string)required
Possible values: [acknowledged, in-progress, completed, failed]
• acknowledged: the request has been taken into account
• in-progress: the process is in progress
• completed: the process has been completed so you can request the virtual machine resource
• failed: the process has failed
description stringrequired

Description of the job.

createdDate date-timerequired

Date when the job was created.

requesterId stringrequired

Id of the user who submitted the request.

startProcessingDate date-timerequired

Date when the job status changed to "in progress".

endProcessingDate date-time

Date when the job status changed to "completed" or "failed".

messages

object[]

Messages raised on the job.

Array [

code int32required

Error code.

message stringrequired

Content of the message.

description string

Additional details.

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hRef": "string",
  "state": "acknowledged",
  "description": "string",
  "createdDate": "2024-10-02T15:25:04.028Z",
  "requesterId": "string",
  "startProcessingDate": "2024-10-02T15:25:04.028Z",
  "endProcessingDate": "2024-10-02T15:25:04.028Z",
  "messages": [
    {
      "code": 0,
      "message": "string",
      "description": "string"
    }
  ]
}

400

Bad Request

Request is not valid

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

code int32required

An integer coding the error type. This is given to caller so he can translate them if required.

message stringrequired

A short localized string that describes the error.

description string

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Loading...