data [required]
\n[object]
A list of form resource objects.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\n[object]
A list of form resource objects.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
The data for publishing a form version.
attributes [required]
\nobject
The attributes for publishing a form version.
version [required]
\nint64
The version number to publish.
type [required]
\nenum
The resource type for a form publication. \nAllowed enum values: form_publications
default: form_publications
data [required]
\nobject
A list-of-form-versions resource object.
attributes [required]
\nobject
The attributes for a list of form versions.
versions [required]
\n[object]
The list of versions for the form.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nstring
The ID of the form.
type [required]
\nenum
The resource type for a list of form versions. \nAllowed enum values: form_version_lists
default: form_version_lists
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
A form version resource object.
attributes [required]
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nstring
The ID of the form version.
type [required]
\nenum
The resource type for a form version. \nAllowed enum values: form_versions
default: form_versions
data [required]
\nobject
A form version resource object.
attributes [required]
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nstring
The ID of the form version.
type [required]
\nenum
The resource type for a form version. \nAllowed enum values: form_versions
default: form_versions
data [required]
\nobject
The data for creating or updating a form version.
attributes [required]
\nobject
The attributes for creating or updating a form version.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
upsert_params [required]
\nobject
Concurrency control parameters for the form version upsert operation.
etag
\nstring
The ETag of the latest version. Required when match_policy is if_etag_match.
insert_only
\nboolean
If true, only a new version may be inserted; updating the current draft is not allowed.
match_policy [required]
\nenum
The policy for matching the latest form version during an upsert operation. \nAllowed enum values: none,if_etag_match
type [required]
\nenum
The resource type for a form version. \nAllowed enum values: form_versions
default: form_versions
data [required]
\nobject
A form version resource object.
attributes [required]
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nstring
The ID of the form version.
type [required]
\nenum
The resource type for a form version. \nAllowed enum values: form_versions
default: form_versions
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with single_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms
data [required]
\nobject
A form resource object.
attributes [required]
\nobject
The attributes of a form.
active [required]
\nboolean
Whether the form is currently active.
anonymous [required]
\nboolean
Whether the form accepts anonymous submissions.
created_at [required]
\ndate-time
The time at which the form was created.
datastore_config [required]
\nobject
The datastore configuration for a form.
datastore_id [required]
\nuuid
The ID of the datastore.
primary_column_name [required]
\nstring
The name of the primary column in the datastore.
primary_key_generation_strategy [required]
\nstring
The strategy used to generate primary keys in the datastore.
description [required]
\nstring
The description of the form.
end_date
\ndate-time
The date and time at which the form stops accepting responses.
has_submitted
\nboolean
Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.
idp_survey [required]
\nboolean
Whether the form is an IDP survey.
modified_at [required]
\ndate-time
The time at which the form was last modified.
name [required]
\nstring
The name of the form.
org_id [required]
\nint64
The ID of the organization that owns this form.
publication
\nobject
The attributes of a form publication.
created_at [required]
\ndate-time
The time at which the publication was created.
form_id [required]
\nuuid
The ID of the form.
form_version [required]
\nint64
The version number that was published.
id
\nstring
The ID of the form publication.
modified_at [required]
\ndate-time
The time at which the publication was last modified.
org_id [required]
\nint64
The ID of the organization that owns this publication.
publish_seq [required]
\nint64
The sequential publication number for this form.
user_id [required]
\nint64
The ID of the user who created this publication.
user_uuid [required]
\nuuid
The UUID of the user who created this publication.
self_service [required]
\nboolean
Whether the form is available in the self-service catalog.
single_response [required]
\nboolean
Whether each user can only submit one response.
user_id [required]
\nint64
The ID of the user who created this form.
user_uuid [required]
\nuuid
The UUID of the user who created this form.
version
\nobject
The attributes of a form version.
created_at [required]
\ndate-time
The time at which the version was created.
data_definition [required]
\nobject
A JSON Schema definition that describes the form's data fields.
description
\nstring
A description shown to form respondents.
properties
\nobject
A map of field names to their JSON Schema definitions.
required
\n[string]
List of field names that must be answered.
title
\nstring
The title of the form schema.
type
\nenum
The root schema type. \nAllowed enum values: object
default: object
definition_signature [required]
\nstring
The signature of the version definition.
etag [required]
\nstring
The ETag for optimistic concurrency control.
has_ever_been_published
\nboolean
Whether this version number has ever appeared in the form's publication history.
id
\nstring
The ID of the form version.
modified_at [required]
\ndate-time
The time at which the version was last modified.
state [required]
\nenum
The state of a form version. \nAllowed enum values: draft,frozen
ui_definition [required]
\nobject
UI configuration for rendering form fields, including widget overrides, field ordering, and themes.
ui:order
\n[string]
The order in which form fields are displayed.
ui:theme
\nobject
The visual theme applied to the form.
primaryColor
\nenum
The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo
user_id [required]
\nint64
The ID of the user who created this version.
user_uuid [required]
\nuuid
The UUID of the user who created this version.
version [required]
\nint64
The sequential version number.
id [required]
\nuuid
The ID of the form.
type [required]
\nenum
The resource type for a form. \nAllowed enum values: forms
default: forms