Properties

Endpoint shortcuts

POST/:workspace_id/collections/:collection_id/properties

GET/:workspace_id/collections/:collection_id/:collection_id/properties/:property_id

PATCH/:workspace_id/collections/:collection_id/:collection_id/properties/:property_id

PUT/:workspace_id/collections/:collection_id/:collection_id/properties/:property_id

GET/:workspace_id/collections/:collection_id/properties

DELETE/:workspace_id/collections/:collection_id/:collection_id/properties/:property_id

The Property object#

{
  "@context": {...},
  "@id": "ChTOSFASLKdVOraA",
  "createdAt": "2021-01-08T10:24:26.612030+00:00",
  "updatedAt": "2021-02-15T15:48:18.007428+00:00",
  "label": "Contacts",
  "@type": "Property",
  "parents": ["/xbDnos4GHeCO7YnUN8vJ"],
  "itemsType": "Person",
  "properties": [],
  "icon": "\ud83e\udd91",
}

Properties#

Property	Type	Info	Description
@context	object	Optional	JSON-LD context information.
@id	string	Optional	Unique identifier for the object
createdAt	string	Optional	Timestamp of object creation, expressed according to ISO 8601.
updatedAt	string	Read only	Timestamp of object last update, expressed according to ISO 8601.
@type	string	Mandatory	Value is "Property"
name	string	Mandatory	Name of the Property.
range	string	Mandatory	Property data type
key	string	Mandatory	Property identifier
rank	string	Optional	A LexoRank string value.
unique	boolean	Optional	If true, duplicate values for this property will be forbidden in the application
withIndex	boolean	Optional	If true, the property will be sortable in the application
columnWidth	number	Optional	The column width

Any extra field will return a bad request error.

Create a property#

{
  "@type": "Property",
  "name": "First Name",
  "range": "Text",
  "key": "firstName"
}

The key is used to define your items data structure. The range must be one of the primary data types.

For example, a collection with a property having a firstName key will have items with this structure:

{
  "@id": ":item_id",
  "firstName: "Value"
  ...
}

On success, returns a HTTP code 201 with {"@id": "PROPERTY_ID"} and the resource URI in the Location header.

Retrieve a property#

GET https://data.datablist.com/:workspace_id/collections/:collection_id/properties/:property_id

Response - HTTP 200

{
  "@context": {...},
  "@id": "ChTOSFASLKdVOraA",
  "createdAt": "2021-01-08T10:24:26.612030+00:00",
  "updatedAt": "2021-02-15T15:48:18.007428+00:00",
  "@type": "Property",
  "name": "First Name",
  "range": "Text",
  "key": "firstname"
}

Update a property#

Partial#

PATCH https://data.datablist.com/:workspace_id/collections/:collection_id/properties/:property_id

{
  "name": "Updated Name for First Name"
}

On success, returns an empty HTTP 204 No Content.

Full update#

PUT https://data.datablist.com/:workspace_id/collections/:collection_id/properties/:property_id

{
  "@id": "ChTOSFASLKdVOraA",
  "createdAt": "2021-01-08T10:24:26.612030+00:00",
  "updatedAt": "2021-02-15T15:48:18.007428+00:00",
  "@type": "Property",
  "name": "First Name",
  "range": "Text",
  "key": "firstname"
}

On success, returns an empty HTTP 204 No Content.

List all properties#

GET https://data.datablist.com/:workspace_id/collections/:collection_id/properties

Response - HTTP 200

{
  "@context": {...},
  "data": [{
      "@id": "ChTOSFASLKdVOraA",
      "createdAt": "2021-01-08T10:24:26.612030+00:00",
      "updatedAt": "2021-02-15T15:48:18.007428+00:00",
      "@type": "Property",
      "name": "First Name",
      "range": "Text",
      "key": "firstname"
  },{
      "@id": "SDFSAODFASFD",
      "createdAt": "2021-01-08T10:24:26.612030+00:00",
      "updatedAt": "2021-02-15T15:48:18.007428+00:00",
      "@type": "Property",
      "name": "Last Name",
      "range": "Text",
      "key": "lastname"
  }]
}

Delete a property#

DELETE https://data.datablist.com/:workspace_id/collections/:collection_id/properties/:property_id

On success, returns an empty HTTP 204 No Content.