Read typeOneResource

GET 
/resources/typeOneResources/:ids/

Get typeOneResource.

Authorization Action:

resource:typeOneResources:get

Request

Path Parameters

ids stringrequired

Comma-separated globally unique ids (UUID4)

Query Parameters

include string
List of included related resources.
Usage:
Including nested relationships is currently not supported.
include=related-resource0,related-resource1,...,related-resourceN
Authorization Action:
The user must be authorized to include the requested resource.
resource:<related-resource>:list
fields string
Sparse fieldsets.
Usage:
fields[resource-name]=field0,field1,...,fieldN

Responses

200

application/vnd.api+json

Schema

Schema

data objectrequired
type typerequired
The type member is used to describe resource objects that share common attributes and relationships.
id idrequired
Each resource object’s type and id pair MUST identify a single, unique resource.
links object
self object
oneOf
MOD1
string uri-reference
a string containing the link's URL
MOD2
href uri-referencerequired
a string containing the link's URL
meta object
property name* any
attributes object
cretedAt date
serial stringrequired
relationships object
typeTwoResources object
a multiple 'to-many' relationship
links object
optional references to other resource objects
self object
oneOf
MOD1
string uri-reference
a string containing the link's URL
MOD2
href uri-referencerequired
a string containing the link's URL
meta object
property name* any
related object
oneOf
MOD1
string uri-reference
a string containing the link's URL
MOD2
href uri-referencerequired
a string containing the link's URL
meta object
property name* any
property name* any
optional references to other resource objects
data object[]
An array of objects each containing the 'type' and 'id' for to-many relationships
Array [
type typerequired
The type member is used to describe resource objects that share common attributes and relationships.
id idrequired
Each resource object’s type and id pair MUST identify a single, unique resource.
meta object
property name* any
]
meta object
property name* any
included object[]
Array [
type typerequired
The type member is used to describe resource objects that share common attributes and relationships.
id idrequired
Each resource object’s type and id pair MUST identify a single, unique resource.
attributes object
relationships object
links object
oneOf
title
meta object
property name* any
]
links object
first object
oneOf
MOD1
string uri-reference
last object
oneOf
MOD1
string uri-reference
prev object
oneOf
MOD1
string uri-reference
next object
oneOf
MOD1
string uri-reference
oneOf
title
jsonapi object
The server's implementation
version string
meta object
property name* any

Example (from schema)

{
  "data": {
    "type": "string",
    "id": "string",
    "links": {
      "self": "string"
    },
    "attributes": {
      "cretedAt": "2024-05-28",
      "serial": "string"
    },
    "relationships": {
      "typeTwoResources": {
        "links": {
          "self": "string",
          "related": "string"
        },
        "data": [
          {
            "type": "string",
            "id": "string",
            "meta": {}
          }
        ],
        "meta": {}
      }
    }
  },
  "included": [
    {
      "type": "string",
      "id": "string",
      "attributes": {},
      "relationships": {},
      "links": {},
      "meta": {}
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "jsonapi": {
    "version": "string",
    "meta": {}
  }
}

401

not authorized

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
id string
status string
links object
oneOf
title
code string
title string
detail string
source object
pointer string
A JSON Pointer to the associated entity in the request document [e.g. /data for a primary data object, or /data/attributes/title for a specific attribute.
parameter string
A string indicating which query parameter caused the error.
meta object
property name* any
]
meta object
property name* any
jsonapi object
The server's implementation
version string
meta object
property name* any
links object
oneOf
title

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "status": "string",
      "links": {},
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string",
        "meta": {}
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "string",
    "meta": {}
  },
  "links": {}
}

404

not found

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
id string
status string
links object
oneOf
title
code string
title string
detail string
source object
pointer string
A JSON Pointer to the associated entity in the request document [e.g. /data for a primary data object, or /data/attributes/title for a specific attribute.
parameter string
A string indicating which query parameter caused the error.
meta object
property name* any
]
meta object
property name* any
jsonapi object
The server's implementation
version string
meta object
property name* any
links object
oneOf
title

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "status": "string",
      "links": {},
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string",
        "meta": {}
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "string",
    "meta": {}
  },
  "links": {}
}

Loading...