Skip to main content

Find jobs by searching criteria

GET 
/projects/:projectId/jobs

Return jobs that match all searching criteria. Criteria are job status or the reference to the resource on which jobs are about.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

Query Parameters

    state JobStateEnum[]

    Possible values: [acknowledged, in-progress, completed, failed]

    Status of the job

    offset int32

    Default value: 0

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    limit int32

    Possible values: >= 1

    Default value: 100

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

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​

Ok

Response Headers

  • X-Total-Count

    integer

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

  • X-Result-Count

    integer

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema

  • Array [

    • 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.

  • ]

  • ]

Loading...