Update typeOneResource relationship

PATCH 
https://apis.<domain>/resources/typeOneResources/:id/relationships/:related_field/

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Update a typeTwoResource associated with the typeOneResource.

Authorization Action:

resource:typeTwoResources:update

Request

Path Parameters

id stringrequired

Globally unique ids (UUID4)

related_field stringrequired

application/vnd.api+json

Body

data objectrequired
oneOf
relationshipToMany
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

200

application/vnd.api+json

Schema

Schema

data objectrequired
oneOf
relationshipToMany
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
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": {},
  "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": {}
}

403

Forbidden

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

Related resource does not exist

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": {}
}

409

[Conflict](Conflict

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": {}
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PATCH 'https://apis.<domain>/resources/typeOneResources/:id/relationships/:related_field/' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "data": {}
}'

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

id — pathrequired

related_field — pathrequired

Body

{
  "data": {}
}