Aircampi LOV (0.1.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://github.com/aircampi Terms of Service

Introduction

Aircampi LOV is a static or dynamic set of values used to display a specific type of page item, such as popup lists of values, a select list, a check box, a radio group, or multiple select lists.

Lookups

Lookups are lists of values in applications. You define a list of values as a lookup consisting of a set of lookup values. Lookup and Lookup values are translated name and description. End users see the list of translated names and descriptions as the available values for an object.
Lookup Values

Lookups provide lists of values where valid values appear on a list with no duplicate values. For example, an application might store the values Male and Female in a Gender in a table, but when displaying those values in the user interface, Male or Female (or their translated equivalents) should be available for end users to select.
Translation

You can translate the lookups and values that you defined to the preferred language(s) without changing the language session of the application. When you edit a particular language entry, you can modify the translated name and description to the language in which you want the lookup to appear. Once the updates are made, the end-users can view the lookup in the translated text.

Quick Links:

Endpoints

This section contains the information about api references for Aircampi LOV.

Group of endpoints:

Lookups
Lookup Values
Translations
Settings
Health Check

Lookups

Lookups are lists of values in applications. You define a list of values as a lookup consisting of a set of lookup values. Lookup and Lookup values are translated name and description. End users see the list of translated names and descriptions as the available values for an object.

Get lookups

Retrieve filtered list of lookups.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Lookup

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Lookup

code required	string (lookup_code) Lookup Code
name required	string (lookup_name) Lookup Name
description	string (lookup_description) Lookup Description
	object (lookup_metadata) Lookup Metadata

Responses

Request samples

Payload

Content type

application/json

{"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Get Lookup

Retrieve lookup details.

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Update Lookup

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Lookup

name	string (lookup_name) Lookup Name
description	string (lookup_description) Lookup Description
	object (lookup_metadata) Lookup Metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Delete Lookup

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Change Lookup Code

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Change Lookup Code

new_code

string (lookup_code)

Lookup Code

Responses

Request samples

Payload

Content type

application/json

{"new_code": "territories"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Lookup Values

Lookups provide lists of values where valid values appear on a list with no duplicate values. For example, an application might store the values Male and Female in a Gender in a table, but when displaying those values in the user interface, Male or Female (or their translated equivalents) should be available for end users to select.

Get Lookup Values

Retrieve filtered list of lookup values.

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Create Lookup Value

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Lookup Value

code required	string (lookup_value_code) Lookup Value Code
name required	string (lookup_value_name) Lookup Value Name
description	string (lookup_value_description) Lookup Value Description
	object (lookup_value_metadata) Lookup Value Metadata
sequence	string (lookup_value_sequence) Lookup Value Sequence

Responses

Request samples

Payload

Content type

application/json

{"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Get Lookup Value

Retrieve lookup value details.

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Update Lookup Value

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Lookup Value

name	string (lookup_value_name) Lookup Value Name
description	string (lookup_value_description) Lookup Value Description
	object (lookup_value_metadata) Lookup Value Metadata
sequence	string (lookup_value_sequence) Lookup Value Sequence
enabled	boolean (lookup_value_enabled) Default: true Is lookup value enabled?

Responses

Request samples

Payload

Content type

application/json

{"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Delete Lookup Value

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Change Lookup Value

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Change Lookup Value

new_code

string (lookup_value_code)

Lookup Value Code

Responses

Request samples

Payload

Content type

application/json

{"new_code": "usa"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Translations

You can translate the lookups and values that you defined to the preferred language(s) without changing the language session of the application. When you edit a particular language entry, you can modify the translated name and description to the language in which you want the lookup to appear. Once the updates are made, the end-users can view the lookup in the translated text.

Get Lookup Translations

Retrieve filtered list of lookup translations.

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Lookup Translation

Authorizations:

Scopes

path Parameters

lookup

required

string (lookup_code)

Example: countries

Lookup Code

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Translation

language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"language": "en_US",
"name": "Countries",
"description": "List of Countries"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Lookup Translation

Retrieve lookup translation details.

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Lookup Translation

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Translation

name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"name": "Countries",
"description": "List of Countries"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Lookup Translation

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Get Lookup Value Translations

Retrieve filtered list of lookup value translations.

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "United States",
"description": "United States of America",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Lookup Value Translation

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Lookup Value Translation

language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"language": "en_US",
"name": "United States",
"description": "United States of America"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "United States",
"description": "United States of America",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Lookup Value Translation

Retrieve lookup value translation details.

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "United States",
"description": "United States of America",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Lookup Value Translation

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Lookup Value Translation

name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"name": "United States",
"description": "United States of America"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "United States",
"description": "United States of America",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Lookup Value Translation

Authorizations:

Scopes

path Parameters

lookup required	string (lookup_code) Example: countries Lookup Code
value required	string (lookup_value_code) Example: us Lookup Value
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Settings

Aircampi LOV's settings allow you to edit your server setup configuration and customize it. You can easily change the it by changing them when running Aircampi LOV.

Get Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"environment": "development"
}

Update Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Settings

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

Responses

Request samples

Payload

Content type

application/json

{"environment": "development"
}

Response samples

Content type

application/json

{"environment": "development"
}

Health Check

The Health service is designed to allow you to both validate and monitor that your Aircampi LOV's instance and all of its internal components are up and responsive.

Check Health

Responses

Response samples

Content type

application/json

{"server_name": "Aircampi LOV",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "Lookup Value Store"
}

Models

This section contains the information about resources for Aircampi LOV and their fields, and child resources.

Group of models:

Lookup Models
Settings Models
Health Check Models

Lookup Models

Lookup
Lookups
Lookup Aggregation
Lookup Value
Lookup Values
Translation
Translations

Lookup

Resource Type: Single Resource

Fields:

id
code
name
description
metadata
enabled
created_at
updated_at

Child Resources:

aggregations
values

id	string <uuid> (lookup_id) Lookup Id
code	string (lookup_code) Lookup Code
name	string (lookup_name) Lookup Name
description	string (lookup_description) Lookup Description
	object (lookup_metadata) Lookup Metadata
enabled	string (lookup_enabled) Default: true is lookup enabled?
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (lookup_aggregation) Lookup Aggregation
	Array of objects (lookup_value)

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Lookups

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (lookup) The lookups in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "countries",
"name": "List of Countries",
"description": "List of Countries",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"enabled": true,
"lookup": "continents"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"type": "number",
"required": false,
"unique": true,
"default_value": 0,
"lov_lookup": null,
"lov_lookup_check": null,
"comments": "ISO Numeric Code for the country"
},
{"name": "currency",
"type": "lov",
"required": false,
"unique": true,
"default_value": "usd",
"lov_lookup": "currencies",
"lov_lookup_check": true,
"comments": "Currency code for the country"
}
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"values": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}
]
}

Lookup Aggregation

Resource Type: Single Resource

Fields:

values
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (id) Unique Identifier (ID)
lookup_id	string <uuid> (lookup_id) Lookup Id
values	integer Default: 0 Number of Values
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"values": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Lookup Value

Resource Type: Single Resource

Fields:

id
lookup_id
code
name
description
metadata
sequence
enabled
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (lookup_value_id) Lookup Value Id
lookup_id	string <uuid> (lookup_id) Lookup Id
code	string (lookup_value_code) Lookup Value Code
name	string (lookup_value_name) Lookup Value Name
description	string (lookup_value_description) Lookup Value Description
	object (lookup_value_metadata) Lookup Value Metadata
sequence	string (lookup_value_sequence) Lookup Value Sequence
enabled	boolean (lookup_value_enabled) Default: true Is lookup value enabled?
created_date	string <date-time> (created_at) Create at date and time
updated_date	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Lookup Values

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (lookup_value) The lookup values in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lookup_id": "b51b2076-52d5-4877-95b8-f534243bd916",
"code": "us",
"name": "United States",
"description": "United States of America",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"cascading": {"lookup_value": "north_america"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "iso_numeric",
"value": 848
},
{"name": "currency",
"value": "usd"
}
]
},
"sequence": 1,
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Translation

Resource Type: Single Resource

Fields:

id
label_id
language
name
description
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (id) Unique Identifier (ID)
label_id	string <uuid> (label_id) Label Id
language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Translations

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (label_translation) The translations in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "List of Countries",
"description": "List of Countries",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Settings Models

Server Settings

Server Settings

Resource Type: Single Resource

Fields:

environment

Child Resources: No child resources.

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

{"environment": "development"
}

Health Check Models

Health Check

Health Check

Resource Type: Single Resource

Fields:

server_name
server_version
server_status
server_description

Child Resources: No child resources.

server_name	string Name of server
server_version	string Version of server
server_status	string Default: "Active" Enum: "Active" "Warning" "Error" Status of server
server_description	string Description of server

{"server_name": "Aircampi LOV",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "Lookup Value Store"
}