Skip to main content

Read typeTwoResource

GET 

/resources/typeTwoResources/:ids/

Get typeTwoResource.

Authorization Action:

resource:typeTwoResources:get

Request

Path Parameters

    ids stringrequired

    Comma-separated globally unique ids (UUID4)

Query Parameters

    fields string

    Sparse fieldsets.

    Usage:

    fields[resource-name]=field0,field1,...,fieldN
    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
    sort string

    List of fields to sort by.

    Usage :

    Use -field to sort by descending order

    sort=field0,-field1,...,fieldN

Responses

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
  • string uri-reference

    a string containing the link's URL

  • attributes object
    cretedAt date
    name stringrequired
    relationships object
    typeOneResource object

    a singular 'to-one' relationship

    links object

    optional references to other resource objects

    self object
    oneOf
  • string uri-reference

    a string containing the link's URL

  • related object
    oneOf
  • string uri-reference

    a string containing the link's URL

  • property name* any

    optional references to other resource objects

    data object

    reference to other resource in a to-one relationship

    anyOf
    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
  • string uri-reference
  • last object
    oneOf
  • string uri-reference
  • prev object
    oneOf
  • string uri-reference
  • next object
    oneOf
  • string uri-reference
  • oneOf
    title
    jsonapi object

    The server's implementation

    version string
    meta object
    property name* any
Loading...