Skip to content
Rymax One

Gets the job object which describes available

GET
/api/Job/{jobId}

Parameters

Path Parameters

jobId
required
string format: uuid

Responses

200

Success

object
class
Array<string>
nullable
title
string
nullable
properties
object
entities
Array
nullable
actions
Array<object>
nullable
object
name
required
string
>= 1 characters
href
required
string
>= 1 characters
class
Array<string>
nullable
method
string
nullable
title
string
nullable
type
string
nullable
fields
Array<object>
nullable
object
name
required
string
>= 1 characters
type
string
nullable
value
nullable
class
Array<string>
nullable
title
string
nullable
links
Array<object>
nullable
object
rel
required
Array<string>
href
required
string
>= 1 characters
class
Array<string>
nullable
title
string
nullable
type
string
nullable
Example
{
  "class": [
    "Job"
  ],
  "title": "A Job for the system. Provides access to job lifetime, information and operations",
  "properties": {},
  "entities": [],
  "actions": [],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://localhost:5051/api/Job/GetJob/00000000-0000-0000-0000-000000000000"
    }
  ]
}

400

Bad Request

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

403

Forbidden

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

404

Not Found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

423

Client Error

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

500

Server Error

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties