Skip to main content

Get Collection

info

All JSON array responses have been shortened for readability.

GET/<ApplicationID/collections/<CollectionID>
Endpoint Requires Authentication
Example
https://api.weightron.cloud/641c1177ebc8b2f3c195b02c/collections/641c1177ebc8b2f3c195b033
Description

Returns an object containing the given collection.

This endpoint supports the foreignkeys query parameter, which will populate the schemas of foreign keys for the collection using the importProperty value, only for the first level. This schema will more accurately represent the state of the data object in the database.

Returns
{
"timestamp": "2023-03-23T10:05:55.001Z",
"data": {
"ui": {
"layouts": {
"document": "63f63875c92af5930aba78e6"
},
"group": "Administration",
"icon": "faBuildings"
},
"_id": "641c1177ebc8b2f3c195b033",
"application": "641c1177ebc8b2f3c195b02c",
"name": "Area",
"jsonschema": {
"type": ["object"],
"properties": {
"name": {
"name": "Name",
"domain": "638e02a54cd028b9a6c176d8",
"type": ["string"],
"minLength": 1,
"maxLength": 120
},
"notes": {
"name": "Notes",
"domain": "63999fd24c3a9c0b4c373cf9",
"minLength": 0,
"type": ["string", "null"],
"maxLength": 1000
}
}
},
"createdAt": "2023-02-13T14:16:30.299Z",
"updatedAt": "2023-03-01T10:51:57.582Z",
"__v": 0
}
}