Update typeTwoResource

PATCH 
https://apis.<domain>/resources/resources/typeTwoResources/:ids/

Update typeTwoResource.

Authorization Action:

resource:typeTwoResources:update

Request

Path Parameters

ids stringrequired

Comma-separated globally unique ids (UUID4)

application/vnd.api+json

Body

data objectrequired
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.
links object
self object
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
attributes object
createdAtstring<date>
namestring
relationships object
typeOneResource object
a singular 'to-one' relationship
links object
optional references to other resource objects
self object
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
related object
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
property name*any
optional references to other resource objects
data object
reference to other resource in a to-one relationship
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
meta object
property name*any

Responses

200

application/vnd.api+json

Schema

Schema

data objectrequired
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.
links object
self object
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
attributes object
createdAtstring<date>
namestringrequired
relationships object
typeOneResource object
a singular 'to-one' relationship
links object
optional references to other resource objects
self object
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
related object
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
property name*any
optional references to other resource objects
data object
reference to other resource in a to-one relationship
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
meta object
property name*any
included object[]
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.
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
]
links object
Link members related to primary data
first object
oneOf
string
string
a string containing the link's URL
1-item-properties
nulltype
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
last object
oneOf
string
string
a string containing the link's URL
1-item-properties
nulltype
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
prev object
oneOf
string
string
a string containing the link's URL
1-item-properties
nulltype
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
next object
oneOf
string
string
a string containing the link's URL
1-item-properties
nulltype
hrefstring<uri-reference>required
a string containing the link's URL
meta object
property name*any
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
jsonapi object
The server's implementation
versionstring
meta object
property name*any

Example (auto)

{
  "data": {
    "type": "string",
    "id": "string",
    "links": {
      "self": "string"
    },
    "attributes": {
      "createdAt": "2024-07-29",
      "name": "string"
    },
    "relationships": {
      "typeOneResource": {
        "links": {
          "self": "string",
          "related": "string"
        },
        "data": {},
        "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 [
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": {}
}

403

Forbidden

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

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

409

[Conflict](Conflict

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.Patch, "https://apis.<domain>/resources/resources/typeTwoResources/:ids/");
request.Headers.Add("Accept", "application/vnd.api+json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"string\",\n    \"id\": \"string\",\n    \"links\": {\n      \"self\": \"string\"\n    },\n    \"attributes\": {\n      \"createdAt\": \"2024-07-29\",\n      \"name\": \"string\"\n    },\n    \"relationships\": {\n      \"typeOneResource\": {\n        \"links\": {\n          \"self\": \"string\",\n          \"related\": \"string\"\n        },\n        \"data\": {},\n        \"meta\": {}\n      }\n    }\n  }\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

Body

{
  "data": {
    "type": "string",
    "id": "string",
    "links": {
      "self": "string"
    },
    "attributes": {
      "createdAt": "2024-07-29",
      "name": "string"
    },
    "relationships": {
      "typeOneResource": {
        "links": {
          "self": "string",
          "related": "string"
        },
        "data": {},
        "meta": {}
      }
    }
  }
}