ReferenceFamilyAssignment

Resource: ReferenceFamilyAssignment — CRUD endpoints

List ReferenceFamilyAssignment (find where)

GET

https://api.aerion.app

/v1/reference-family-assignments

OAuth 2.0

Bearer (Opaque)

Find a list of ReferenceFamilyAssignment records that match the specified criteria.

Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.

Note: The per-attribute filter parameters and the where parameter are mutually exclusive. If where is supplied, the per-attribute filters are ignored — put all filter criteria inside where instead. limit, skip, sort, and populate are unaffected.

List ReferenceFamilyAssignment (find where) › query Parameters

project

integer

Filter by project ID

status

integer · enum

Filter by status (1 = active, 0 = inactive)

Enum values:

Default: 1

enabled

string

Filter by enabled

id

integer · unique

Filter by record ID

createdAt

string

Filter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

updatedAt

string

Filter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

where

string

A JSON-encoded Waterline criteria for advanced filtering. Only whitelisted criteria are supported: project, status, enabled, id, createdAt, updatedAt. Sub-attribute modifiers such as startsWith, >=, <=, >, <, and != are supported on any whitelisted criterion. The contains modifier is not supported on this model.

Note: If where is supplied, the per-attribute filter query parameters above are ignored — where is the entire criteria. (limit, skip, sort, and populate are unaffected.) To combine filters, put them all inside where.

e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}

limit

integer · max: 50000

The maximum number of records to return. Defaults to 10000, capped at 50000.

Default: 10000

skip

integer

The number of records to skip (useful for pagination).

sort

string

The sort order. By default, returned records are sorted by primary key value in ascending order.

e.g. ?sort=lastName%20ASC

List ReferenceFamilyAssignment (find where) › Responses

Responds with a paged list of ReferenceFamilyAssignment records that match the specified criteria

referencefamilyassignment[]

object

Create ReferenceFamilyAssignment

POST

https://api.aerion.app

/v1/reference-family-assignments

OAuth 2.0

Bearer (Opaque)

Create a new ReferenceFamilyAssignment record.

Create ReferenceFamilyAssignment › Request Body

referencefamilyassignment · required

Aerion model ReferenceFamilyAssignment

Create ReferenceFamilyAssignment › Responses

Responds with a JSON dictionary representing the newly created ReferenceFamilyAssignment instance

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

POST/v1/reference-family-assignments

curl --request POST \
  --url https://api.aerion.app/v1/reference-family-assignments \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}
'

Example Request Body

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

Example Responses

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

application/json

Get ReferenceFamilyAssignment (find one)

GET

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Look up the ReferenceFamilyAssignment record with the specified ID.

Get ReferenceFamilyAssignment (find one) › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Get ReferenceFamilyAssignment (find one) › Responses

Responds with a single ReferenceFamilyAssignment record as a JSON dictionary

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

Update ReferenceFamilyAssignment

PUT

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Partially update an existing ReferenceFamilyAssignment record. Despite using PUT, this endpoint applies PATCH semantics — only the fields included in the request body are modified; omitted fields are left unchanged.

Update ReferenceFamilyAssignment › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Update ReferenceFamilyAssignment › Request Body

referencefamilyassignment · required

Aerion model ReferenceFamilyAssignment

Update ReferenceFamilyAssignment › Responses

Responds with the newly updated ReferenceFamilyAssignment record as a JSON dictionary

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

PUT/v1/reference-family-assignments/{id}

curl --request PUT \
  --url https://api.aerion.app/v1/reference-family-assignments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}
'

Example Request Body

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

Example Responses

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

application/json

Delete ReferenceFamilyAssignment (destroy)

DELETE

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Delete the ReferenceFamilyAssignment record with the specified ID.

Delete ReferenceFamilyAssignment (destroy) › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Delete ReferenceFamilyAssignment (destroy) › Responses

Record successfully deleted

No data returned

ReferenceFamily Role

Aerion API

ReferenceFamilyAssignment

Resource: ReferenceFamilyAssignment — CRUD endpoints

List ReferenceFamilyAssignment (find where)

GET

https://api.aerion.app

/v1/reference-family-assignments

OAuth 2.0

Bearer (Opaque)

Find a list of ReferenceFamilyAssignment records that match the specified criteria.

Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.

List ReferenceFamilyAssignment (find where) › query Parameters

project

integer

Filter by project ID

status

integer · enum

Filter by status (1 = active, 0 = inactive)

Enum values:

Default: 1

enabled

string

Filter by enabled

id

integer · unique

Filter by record ID

createdAt

string

Filter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

updatedAt

string

Filter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead

where

string

e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}

limit

integer · max: 50000

The maximum number of records to return. Defaults to 10000, capped at 50000.

Default: 10000

skip

integer

The number of records to skip (useful for pagination).

sort

string

The sort order. By default, returned records are sorted by primary key value in ascending order.

e.g. ?sort=lastName%20ASC

List ReferenceFamilyAssignment (find where) › Responses

Responds with a paged list of ReferenceFamilyAssignment records that match the specified criteria

referencefamilyassignment[]

object

Create ReferenceFamilyAssignment

POST

https://api.aerion.app

/v1/reference-family-assignments

OAuth 2.0

Bearer (Opaque)

Create a new ReferenceFamilyAssignment record.

Create ReferenceFamilyAssignment › Request Body

referencefamilyassignment · required

Aerion model ReferenceFamilyAssignment

Create ReferenceFamilyAssignment › Responses

Responds with a JSON dictionary representing the newly created ReferenceFamilyAssignment instance

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

POST/v1/reference-family-assignments

curl --request POST \
  --url https://api.aerion.app/v1/reference-family-assignments \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}
'

Example Request Body

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

Example Responses

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

application/json

Get ReferenceFamilyAssignment (find one)

GET

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Look up the ReferenceFamilyAssignment record with the specified ID.

Get ReferenceFamilyAssignment (find one) › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Get ReferenceFamilyAssignment (find one) › Responses

Responds with a single ReferenceFamilyAssignment record as a JSON dictionary

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

Update ReferenceFamilyAssignment

PUT

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Update ReferenceFamilyAssignment › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Update ReferenceFamilyAssignment › Request Body

referencefamilyassignment · required

Aerion model ReferenceFamilyAssignment

Update ReferenceFamilyAssignment › Responses

Responds with the newly updated ReferenceFamilyAssignment record as a JSON dictionary

referencefamilyassignment

Aerion model ReferenceFamilyAssignment

PUT/v1/reference-family-assignments/{id}

curl --request PUT \
  --url https://api.aerion.app/v1/reference-family-assignments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}
'

Example Request Body

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

Example Responses

{
  "referenceFamilyAssignment": {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "id": 0,
    "status": 1,
    "project": 0,
    "referenceFamily": 0,
    "referenceScope": "referenceScope",
    "settingsObject": "settingsObject"
  }
}

json

application/json

Delete ReferenceFamilyAssignment (destroy)

DELETE

https://api.aerion.app

/v1/reference-family-assignments/{id}

OAuth 2.0

Bearer (Opaque)

Delete the ReferenceFamilyAssignment record with the specified ID.

Delete ReferenceFamilyAssignment (destroy) › path Parameters

id

integer · unique · required

The desired ReferenceFamilyAssignment record's primary key value

Delete ReferenceFamilyAssignment (destroy) › Responses

Record successfully deleted

No data returned

ReferenceFamily Role