Update typeTwoResource
PATCH/resources/typeTwoResources/:ids/
Update typeTwoResource.
Authorization Action:
resource:typeTwoResources:update
Request
Path Parameters
Comma-separated globally unique ids (UUID4)
- application/vnd.api+json
Body
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
data objectrequired
The type member is used to describe resource objects that share common attributes and relationships.
Each resource object’s type and id pair MUST identify a single, unique resource.
links object
self object
a string containing the link's URL
meta object
attributes object
relationships object
typeOneResource object
a singular 'to-one' relationship
links object
optional references to other resource objects
self object
a string containing the link's URL
meta object
related object
a string containing the link's URL
meta object
optional references to other resource objects
data object
reference to other resource in a to-one relationship
meta object
Responses
- 200
- 401
- 403
- 404
- 409
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
- MOD1
- MOD2
- string uri-reference
a string containing the link's URL
- Array [
- ]
- MOD1
- string uri-reference
- MOD1
- string uri-reference
- MOD1
- string uri-reference
- MOD1
- string uri-reference
data objectrequired
The type member is used to describe resource objects that share common attributes and relationships.
Each resource object’s type and id pair MUST identify a single, unique resource.
links object
self object
a string containing the link's URL
meta object
attributes object
relationships object
typeOneResource object
a singular 'to-one' relationship
links object
optional references to other resource objects
self object
a string containing the link's URL
meta object
related object
a string containing the link's URL
meta object
optional references to other resource objects
data object
reference to other resource in a to-one relationship
meta object
included object[]
The type member is used to describe resource objects that share common attributes and relationships.
Each resource object’s type and id pair MUST identify a single, unique resource.
links object
meta object
links object
first object
last object
prev object
next object
jsonapi object
The server's implementation
meta object
{
"data": {
"type": "string",
"id": "string",
"links": {
"self": "string"
},
"attributes": {
"cretedAt": "2024-05-28",
"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": {}
}
}
not authorized
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]required
links object
source object
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.
A string indicating which query parameter caused the error.
meta object
meta object
jsonapi object
The server's implementation
meta object
links object
{
"errors": [
{
"id": "string",
"status": "string",
"links": {},
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"meta": {}
}
}
],
"meta": {},
"jsonapi": {
"version": "string",
"meta": {}
},
"links": {}
}
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]required
links object
source object
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.
A string indicating which query parameter caused the error.
meta object
meta object
jsonapi object
The server's implementation
meta object
links object
{
"errors": [
{
"id": "string",
"status": "string",
"links": {},
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"meta": {}
}
}
],
"meta": {},
"jsonapi": {
"version": "string",
"meta": {}
},
"links": {}
}
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]required
links object
source object
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.
A string indicating which query parameter caused the error.
meta object
meta object
jsonapi object
The server's implementation
meta object
links object
{
"errors": [
{
"id": "string",
"status": "string",
"links": {},
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"meta": {}
}
}
],
"meta": {},
"jsonapi": {
"version": "string",
"meta": {}
},
"links": {}
}
[Conflict](Conflict
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]required
links object
source object
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.
A string indicating which query parameter caused the error.
meta object
meta object
jsonapi object
The server's implementation
meta object
links object
{
"errors": [
{
"id": "string",
"status": "string",
"links": {},
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"meta": {}
}
}
],
"meta": {},
"jsonapi": {
"version": "string",
"meta": {}
},
"links": {}
}