Skip to main content

Create typeOneResource relationship

POST 
/resources/typeOneResources/:id/relationships/:related_field/

Create a typeTwoResource associated with the typeOneResource.

Authorization Action:

resource:typeTwoResources:create

Request​

Path Parameters

    id stringrequired

    Globally unique ids (UUID4)

    related_field stringrequired

Body

    data objectrequired
    oneOf
  • 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
  • ]

Responses​

Created. Assigned id and/or any other changes are in this response.

Schema
    data objectrequired
    oneOf
  • 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
  • ]
    • 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...