Delete typeOneResource relationship

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

Delete a typeTwoResource associated with the typeOneResource.

Authorization Action:

resource:typeTwoResources:delete

Request

Path Parameters

ids stringrequired

Globally unique ids (UUID4)

related_field stringrequired

application/vnd.api+json

Body

data objectrequired
oneOf
relationshipToOne
anyOf
nulltype
objectnullable
Default value: null
linkage
typetype (string)required
The type member is used to describe resource objects that share common attributes and relationships.
idid (string)required
Each resource object’s type and id pair MUST identify a single, unique resource.
meta object
property name*any
relationshipToMany
Array [
typetype (string)required
The type member is used to describe resource objects that share common attributes and relationships.
idid (string)required
Each resource object’s type and id pair MUST identify a single, unique resource.
meta object
property name*any
]

Responses

200

OK

application/vnd.api+json

Schema

Schema

meta object
property name*any

Example (auto)

{
  "meta": {}
}

202

Accepted for asynchronous processing

application/vnd.api+json

Schema

Schema

data object
typetype (string)required
The type member is used to describe resource objects that share common attributes and relationships.
idid (string)required
Each resource object’s type and id pair MUST identify a single, unique resource.
attributesobject
relationshipsobject
links object
property name* link
oneOf
string
string
a string containing the link's URL
object
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
meta object
property name*any

Example (auto)

{
  "data": {
    "type": "string",
    "id": "string",
    "attributes": {},
    "relationships": {},
    "links": {},
    "meta": {}
  }
}

204

no content

401

not authorized

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
idstring
statusstring
links object
property name* link
oneOf
string
string
a string containing the link's URL
object
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
codestring
titlestring
detailstring
source object
pointerstring
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.
parameterstring
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
versionstring
meta object
property name*any
links object
property name* link
oneOf
string
string
a string containing the link's URL
object
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any

Example (auto)

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

Resource does not exist

application/vnd.api+json

Schema

Schema

errors object[]required
Array [
idstring
statusstring
links object
property name* link
oneOf
string
string
a string containing the link's URL
object
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
codestring
titlestring
detailstring
source object
pointerstring
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.
parameterstring
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
versionstring
meta object
property name*any
links object
property name* link
oneOf
string
string
a string containing the link's URL
object
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any

Example (auto)

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

Authorization: http

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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://apis.<domain>/resources/resources/typeOneResources/:id/relationships/:related_field/");
request.Headers.Add("Accept", "application/vnd.api+json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {}\n}", null, "application/vnd.api+json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://apis.<domain>/resources

Auth

Bearer Token

Parameters

ids — pathrequired

related_field — pathrequired

Body

{
  "data": {}
}