List associated typeTwoResources
GET/resources/typeOneResources/:ids/typeTwoResources/
List associated typeTwoResources.
Authorization Action:
resource:typeTwoResources:list
Request
Path Parameters
Comma-separated globally unique ids (UUID4)
Query Parameters
- Filters can only be applied to
attributes
(which do not include theid
field). In order to filter a resource byid
use theread
API. - Mixing
AND
withOR
conditions is currently not supported and may lead to unexpected results. - Related resource property filtering is only supported for
match
,fuzzy-match
,min
,max
filter types. - Object property filtering is only supported for
match
andfuzzy-match
filter types. filter[field0.field1]=value0
filter[field0.field1][fuzzy-match]=value0
filter[related-resource0:field0]=value0
filter[related-resource0:field0][fuzzy-match]=value0
filter[related-resource0:objectField0.field0]=value0
filter[related-resource0:objectField0.field0][fuzzy-match]=value0
filter[and][field0]=value0&filter[and][field1]=value1
filter[or][field0]=value0&filter[or][field1]=value1
filter[field0][min]=value0
filter[related-resource0:field0][min]=value0
filter[related-resource0:field0][max]=value0
filter[field0][min]=value0&filter[field1][max]=value1
filter[field0][exists]=true|false
filter[field0][exists]=true|false&filter[field1][exists]=true|false
List of included related resources.
Usage:
Including nested relationships is currently not supported.
include=related-resource0,related-resource1,...,related-resourceN
Authorization Action:
The user must be authorized to include the requested resource.
resource:<related-resource>:list
Usage :
Use
-field
to sort by descending order
sort=field0,-field1,...,fieldN
Number of results to return per page.
A page offset within the paginated result set.
Usage:
filter[and|or][field][match|fuzzy-match|min|max|exists]=value0,value1,...,valueN
Limitations
Fuzzy-match filtering
The fuzzy-match filter is used to perform a case-insensitive prefix match on a given field.
The query string can contain the following logical operators: AND
, OR
, NOT
, (
, )
.
Single quotes are ignored and double quoted strings are treated as literals.
Here are some examples of valid query strings:
value0 OR value1
value0 AND value1
(value0 AND value1) OR (value2 AND value3)
NOT value0
NOT value0 OR value1
"exact-value0" OR value1
Examples
Single filter, exact match
filter[field0][match]=value0
[match]
expression can be omitted, since it is the defalt one.
filter[field0][match]=value0
is equivalent tofilter[field0]=value0
Single filter, exact match, multiple values
filter[field0]=value0,value1
filter[field0][fyzz-match]="value0"
Exact match can be also achieved using
fuzzy-match
filter
with double quoted strings
Single filter, fuzzy match
filter[field0][fuzzy-match]=value0
filter[field0][fuzzy-match]=value0 OR value1
filter[field0][fuzzy-match]=NOT value0
Single filter on object property
Single filter on related resource property
Multiple filters
[and]
expression can be omitted, since it is the defalt one.
filter[and][field0]=value0&filter[and][field1]=value1
is equivalent tofilter[field0]=value0&filter[field1]=value1
Min, max filter
Exists filter
Responses
- 200
- 401
- 404
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
- Array [
- 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 object[]required
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": {}
}
not found
- 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": {}
}