data

Catalog of Fulcra Data Types

get/data/v1/catalog

Request

  • Base URL: https://api.fulcradynamics.com
  • URL: https://api.fulcradynamics.com/data/v1/catalog
  • Auth: HTTP bearer

Query parameters

data_typestring nullable
categorystring nullable
fulcra_useridstring uuid nullable

Response

Successful Response

api_version'v0' | 'v1alpha1' | 'v1' required

fulcra API versions

categoriesFulcraCategory[] required

Categories this data type belongs to

class'metric' | 'event' | 'location' | 'entry' | 'tombstone' required

Fulcra record types

column_namestring required

Name of data column as returned by Fulcra APIs

deprecatedboolean

Whether this type is deprecated

descriptionstring required

Human-readable description

fulcra_useridstring uuid required
iconstring nullable

Icon identifier

idstring required

Programmatic Identifier

metric_kind'cumulative' | 'discrete' required

fulcra metric aggregation

namestring required

Human-readable name

queryableboolean

Denotes if this type can be queried

recordableboolean

Denotes if this type can be recorded

unitstring nullable required

Example response

[
  {
    "record_spec": {
      "unit": "mg"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.