Jump to

• Request
• Response

Get jobs.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/jobs

This operation retrieves details of jobs.

Request

Path Parameters

• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Jobs were successfully retrieved.

Body ()

Root Schema : Jobs

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Job"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Job

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Job"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Job

Type: object

Show Source

• endTime(optional): string(date-time)
  Time when the job ended
• errorMessage(optional): string
  Detail error message when the job has not ended successfully

  Example: The job ends with unexpected error
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• o:errorCode(optional): string
  IoT error code

  Example: IOT-08001
• startTime: string(date-time)
  Time when the job started
• status: string
  Allowed Values: [ "RUNNING", "SUCCESSFUL", "ERROR" ]

  Status of the job

  Example: RUNNING
• title: string
  Title of the job

  Example: Hcm user import job

{
    "required":[
        "startTime",
        "status",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "title":{
            "type":"string",
            "description":"Title of the job",
            "example":"Hcm user import job"
        },
        "status":{
            "type":"string",
            "description":"Status of the job",
            "example":"RUNNING",
            "enum":[
                "RUNNING",
                "SUCCESSFUL",
                "ERROR"
            ]
        },
        "startTime":{
            "type":"string",
            "description":"Time when the job started",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "description":"Time when the job ended",
            "format":"date-time"
        },
        "errorMessage":{
            "type":"string",
            "description":"Detail error message when the job has not ended successfully",
            "example":"The job ends with unexpected error"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "o:errorCode":{
            "type":"string",
            "description":"IoT error code",
            "example":"IOT-08001"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top