Skip to content
Rymax One

Provides the entry point to the API. All resources can be reached through navigation from here by following links, queries and embedded entities.

GET
/api/Jobs

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": [
    "JobsRoot, CollectionRoot"
  ],
  "title": "The Jobs root resource where jobs can be created and accessed.",
  "properties": {},
  "entities": [],
  "actions": [
    {
      "name": "CreateJob",
      "href": "https://localhost:5051/api/Job/CreateJob",
      "method": "POST",
      "title": "Creates a new job, ready to configure."
    },
    {
      "name": "CreateJobQuery",
      "href": "https://localhost:5051/api/JobQuery/Queries",
      "method": "POST",
      "title": "Creates a query for jobs.",
      "type": "application/json",
      "fields": [
        {
          "name": "JobQuery",
          "type": "application/json",
          "value": {
            "Pagination": {
              "PageSize": 20,
              "PageOffset": 0
            },
            "SortBy": {
              "PropertyName": "CreatedOn",
              "SortType": "Descending"
            },
            "Filter": {}
          },
          "class": [
            "https://localhost:5051/ActionParameterTypes/JobQuery"
          ]
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://localhost:5051/api/Jobs"
    },
    {
      "rel": [
        "All"
      ],
      "href": "https://localhost:5051/unknown/object/route?Pagination.PageSize=20&SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending"
    },
    {
      "rel": [
        "Latest"
      ],
      "href": "https://localhost:5051/api/Job/GetJob/09cd34d9-0065-4c10-b468-d55a535df0b6"
    },
    {
      "rel": [
        "Active"
      ],
      "href": "https://localhost:5051/api/Job/GetJob/bff0aa81-0c11-4cf0-96ee-85d0cce18457"
    }
  ]
}

500

Internal error

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