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/EntryPoint

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": [
    "EntryPoint"
  ],
  "title": "Entry to the Job-Service REST API",
  "properties": {},
  "entities": [],
  "actions": [],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://localhost:5051/api/EntryPoint"
    },
    {
      "rel": [
        "Jobs"
      ],
      "href": "https://localhost:5051/unknown/object/route"
    }
  ]
}

500

Internal error

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