Docs

Preview Intake

POST /eventTypes/{eventTypeId}/intake/preview

POST/eventTypes/{eventTypeId}/intake/preview

Previews what an event type's intake effects would do for a set of provisional answers, before the event exists: template entities turned off, roles marked required, attribute and role fills, and tracking changes. Nothing is saved. Effects that depend on anything other than intake answers are not previewed, and a type without an intake form previews nothing. Needs an organization token. The event type id comes from the Organization API's EventTypes_GetEventTypes.

Path Parameters

FieldTypeRequiredDescription
eventTypeIduuidRequired

Request Body

FieldTypeRequiredDescription
answersIntakePreviewRequestAnswer[]Optional

IntakePreviewRequestAnswer

FieldTypeDescription
questionIduuid
valuestring| null

Response

FieldTypeDescription
disabledTemplateEntityIdsuuid[]| null
rolesMarkedRequireduuid[]| null
attributeFillsIntakePreviewResponseAttributeFill[]| null
roleOccupantFillsIntakePreviewResponseRoleOccupantFill[]| null
roleTaskTrackedChangesIntakePreviewResponseRoleTaskTrackedChange[]| null
attributeTrackingChangesIntakePreviewResponseAttributeTrackingChange[]| null

IntakePreviewResponseAttributeFill

FieldTypeDescription
targetAttributeIduuid
valuestring| null

IntakePreviewResponseRoleOccupantFill

FieldTypeDescription
roleDefinitionIduuid
occupantIduuid

IntakePreviewResponseRoleTaskTrackedChange

FieldTypeDescription
roleDefinitionIduuid
isTaskTrackedboolean

IntakePreviewResponseAttributeTrackingChange

FieldTypeDescription
targetAttributeIduuid
isRequiredboolean| null
isTaskTrackedboolean| null
isTaskReviewRequiredboolean| null