Skip to content
Rymax One

Provides access to the work data of a related job.

GET
/api/WorkData/{workDataId}

Parameters

Path Parameters

workDataId
required
string format: uuid

Responses

200

Returns the entry point for the api

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": [
    "WorkData"
  ],
  "title": "Access to the data required for a job.",
  "properties": {},
  "entities": [],
  "actions": [
    {
      "name": "Upload",
      "href": "https://localhost:5051/api/00000000-0000-0000-0000-000000000000/WorkData/00000000-0000-0000-0000-000000000000/UploadWorkData",
      "method": "POST",
      "title": "Add data"
    },
    {
      "name": "Download",
      "href": "https://localhost:5051/api/00000000-0000-0000-0000-000000000000/WorkData/00000000-0000-0000-0000-000000000000/Download",
      "method": "Undefined",
      "title": "Add data"
    },
    {
      "name": "Delete",
      "href": "https://localhost:5051/api/00000000-0000-0000-0000-000000000000/WorkData/00000000-0000-0000-0000-000000000000/DeleteWorkData",
      "method": "DELETE",
      "title": "Delete the current data"
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://localhost:5051/api/00000000-0000-0000-0000-000000000000/WorkData/00000000-0000-0000-0000-000000000000"
    }
  ]
}

500

Internal error

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