Characteristics

Every material can be characterized according to its many physical properties. Characteristic data contains parameters that reflect on physical properties of materials. characteristics endpoint is accessible at https://platform.exabyte.io/api/v1/characteristics. The following actions are supported on characteristics endpoint:

REST API Test Framework

Please visit our REST API Test Framework to test the queries in this page and see the results. Resuls are not shwown here for simiplicity.

List

GET HTTP method is used to retrieve a list of characteristics.

  • List all characteristics:
curl -X GET https://platform.exabyte.io/api/v1/characteristics -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Number of Returned Results

The number of returned results is limited to 20 by default (Results Pagination).

  • Get characteristic by ID:
curl -X GET https://platform.exabyte.io/api/v1/characteristics/SrYEjcjKqR5ntFrD4 -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"
  • Get characteristic by a property:
curl -X GET https://platform.exabyte.io/api/v1/characteristics?query=query%3D%7B%27data.name%27%3A+%27band_gaps%27%7D -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Query Parameter

The query parameter before encoding is query={"data.name": "band_gaps"}