Docs

Get Event Attribute Profile

GET /Events/{eventId}/attributes

GET/Events/{eventId}/attributes

Returns the event's type with its sections and, for each attribute, the current value, options, required and task tracking settings (each with whether this event overrides the type default), due date, and the tracking task's id and status (NotStarted, NeedsReview or Done) with whether the caller can review it. An event without a type returns a null eventTypeId and no sections. Use this to learn the attribute ids that Events_SetEventAttributeValue and Events_SetEventAttributeTrackingConfig take. Needs read access to the event.

Path Parameters

FieldTypeRequiredDescription
eventIduuidRequired

Response

FieldTypeDescription
eventTypeIduuid| null
typeNamestring| null
iconstring| null
colorstring| null
sectionsGetEventAttributeProfileResponseSection[]| null

GetEventAttributeProfileResponseSection

FieldTypeDescription
iduuid
namestring| null
indexinteger
attributesGetEventAttributeProfileResponseAttribute[]| null

GetEventAttributeProfileResponseAttribute

FieldTypeDescription
attributeIduuid
namestring| null
typestring| null
requiredGetEventAttributeProfileResponseFlagState
taskTrackedGetEventAttributeProfileResponseFlagState
taskReviewRequiredGetEventAttributeProfileResponseFlagState
dueDateGetEventAttributeProfileResponseDueDateState
indexinteger
valuestring| null
optionsGetEventAttributeProfileResponseOption[]| null
availabilityGetEventAttributeProfileResponseAvailabilityInfo
taskIduuid| null
taskStatusstring| null
canReviewboolean

GetEventAttributeProfileResponseFlagState

FieldTypeDescription
effectiveboolean
isOverriddenboolean

GetEventAttributeProfileResponseDueDateState

FieldTypeDescription
effectivedate-time| null
isOverriddenboolean

GetEventAttributeProfileResponseOption

FieldTypeDescription
iduuid
valuestring| null
colorstring| null
isArchivedboolean

GetEventAttributeProfileResponseAvailabilityInfo

FieldTypeDescription
recordIdsuuid[]| null