Skip to main content
POST
Archive an event type

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

event_type_id
string
required

The event type's friendly ID (e.g. et_aBcD1234eFgH5678).

Response

The archived event type.

id
string

The event type's friendly ID (e.g. et_aBcD1234eFgH5678).

Example:

"et_aBcD1234eFgH5678"

slug
string | null
name
string | null
description
string | null
created_at
string<date-time>
updated_at
string<date-time>
archived_at
string<date-time> | null
data_point_types
object[]
requires_locations
boolean

True when expected_locations is two.

requires_tracking_id
boolean
requires_feedstock
boolean
requires_asset
boolean
reusable_in_batches
boolean
cadence_amount
integer<int32> | null

How often an event of this type is expected, as a count of cadence_unit. An event type carries both cadence fields or neither; both null means no cadence is declared, which the app shows as Irregular.

Required range: x >= 1
Example:

15

cadence_unit
enum<string> | null

The unit cadence_amount counts. second, minute and hour measure elapsed time; day and above are calendar periods advanced in the account's time zone, so 1 day and 24 hour are different declarations and a daily stream stays on local midnight across a clock change. From month up, a reading counts toward the period that contains it rather than the nearest period boundary, so a monthly reading taken on the 28th still counts for that month.

Available options:
second,
minute,
hour,
day,
week,
month,
year,
null
Example:

"minute"

ui_url
string<uri>

Link that opens this event type in the Mangrove app.

Example:

"https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"