Skip to main content

List typeOneResources

GET 
/resources/typeOneResources/

List typeOneResources.

Authorization Action:

resource:typeOneResources:list

Request​

Query Parameters

    fields string

    Sparse fieldsets.

    Usage:

    fields[resource-name]=field0,field1,...,fieldN
    filter string

    Filter expression.

    Usage:

    filter[and|or][field][match|fuzzy-match|min|max|exists]=value0,value1,...,valueN

    Limitations

    • Filters can only be applied to attributes (which do not include the id field). In order to filter a resource by id use the read API.
    • Mixing AND with OR 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 and fuzzy-match filter types.

    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 to filter[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

    • filter[field0.field1]=value0
    • filter[field0.field1][fuzzy-match]=value0

    Single filter on related resource property

    • 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

    Multiple filters

    • filter[and][field0]=value0&filter[and][field1]=value1
    • filter[or][field0]=value0&filter[or][field1]=value1

    [and] expression can be omitted, since it is the defalt one.
    filter[and][field0]=value0&filter[and][field1]=value1
    is equivalent to filter[field0]=value0&filter[field1]=value1

    Min, max filter

    • filter[field0][min]=value0
    • filter[related-resource0:field0][min]=value0
    • filter[related-resource0:field0][max]=value0
    • filter[field0][min]=value0&filter[field1][max]=value1

    Exists filter

    • filter[field0][exists]=true|false
    • filter[field0][exists]=true|false&filter[field1][exists]=true|false
    include string

    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
    page[limit] integer

    Number of results to return per page.

    page[offset] integer

    A page offset within the paginated result set.

    sort string

    List of fields to sort by.

    Usage :

    Use -field to sort by descending order

    sort=field0,-field1,...,fieldN

Responses​

Schema
    data object[]required
  • 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.

    links object
    self object
    oneOf
  • string uri-reference

    a string containing the link's URL

    • attributes object
    cretedAt date
    serial stringrequired
    relationships object
    typeTwoResources object

    a multiple 'to-many' relationship

    links object

    optional references to other resource objects

    self object
    oneOf
  • string uri-reference

    a string containing the link's URL

    • related object
    oneOf
  • string uri-reference

    a string containing the link's URL

    • property name* any

    optional references to other resource objects

    data object[]

    An array of objects each containing the 'type' and 'id' for to-many relationships

  • 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
  • ]
    • 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
  • string uri-reference
    • last object
    oneOf
  • string uri-reference
    • prev object
    oneOf
  • string uri-reference
    • next object
    oneOf
  • string uri-reference
    • oneOf
    title
    jsonapi object

    The server's implementation

    version string
    meta object
    property name* any
Loading...