HIVE Docs
Explore HIVE

Error codes

Every type URL of a problem response (https://docs.hive.clerktree.com/errors/<code>) is the page of its code. Codes are never renamed or removed.

Top-level codes (code)#

CodeTitle
already_existsResource already exists
conflictState conflict
entitlement_required (deprecated)Not included in the current plan
feature_disabledFeature is switched off
feature_not_entitledNot included in your contract
idempotency_key_requiredIdempotency-Key header required
idempotency_key_reusedIdempotency key reused with a different request
internalInternal error
invalid_cursorCursor is invalid or expired
invalid_requestRequest validation failed
ip_not_allowedSource address not allowed
limit_exceededLimit exceeded
method_not_allowedMethod not allowed
mfa_enrollment_requiredMulti-factor enrolment required
not_acceptableNot acceptable
not_foundResource not found
not_implementedNot implemented in this deployment
payload_too_largePayload too large
permission_deniedPermission denied
precondition_failedA business rule blocks this request
precondition_requiredIf-Match header required
principal_not_allowedThis kind of principal may not do this
purpose_not_allowedPurpose not allowed for this operation
quota_exceededQuota exhausted
rate_limitedToo many requests
request_in_progressOriginal request still running
sso_requiredSingle sign-on required
step_up_requiredStronger authentication required
tenant_requiredTenant must be selected
tenant_suspendedTenant is suspended
timeoutRequest timed out
token_expiredAccess token expired
unauthenticatedAuthentication required
unavailableTemporarily unavailable
unsupported_media_typeUnsupported media type
unsupported_versionAPI version not supported
upstream_errorAn external system failed
version_mismatchResource changed since you read it

Field codes (errors[].code)#

CodeTitle
above_maximumAbove the maximum
below_minimumBelow the minimum
duplicate_itemDuplicate item
human_only_permissionHuman-only permission
invalid_enumValue not allowed
invalid_expandInvalid expand
invalid_field_selectionInvalid field selection
invalid_filter_fieldInvalid filter field
invalid_filter_operatorInvalid filter operator
invalid_formatInvalid format
invalid_headerInvalid header
invalid_limitInvalid limit
invalid_referenceInvalid reference
invalid_sort_fieldInvalid sort field
invalid_timestampInvalid timestamp
invalid_typeWrong type
invalid_unitInvalid unit
malformed_jsonMalformed JSON
mutually_exclusiveMutually exclusive fields
not_cancellableNot cancellable
pattern_mismatchPattern mismatch
preview_header_requiredPreview header required
purpose_requiredPurpose required
quantity_not_finiteQuantity not finite
read_only_fieldRead-only field
requiredRequired field missing
requires_fieldRequired companion field missing
scope_invalidScope invalid
timestamp_requires_offsetTimestamp needs an offset
too_few_itemsToo few items
too_longToo long
too_many_itemsToo many items
too_shortToo short
unit_alias_not_allowedUnit alias not allowed
unit_not_in_kindUnit not in kind
unit_unknownUnit unknown
unknown_fieldUnknown field
unknown_permissionUnknown permission
unknown_sectionUnknown section

Precondition codes (failed_preconditions[].code)#

CodeTitle
approval_expired (under precondition_failed)Approval expired
approval_missing (under precondition_failed)Approval missing
asset_decommissioned (under precondition_failed)Asset decommissioned
command_expired (under precondition_failed)Command expired
gateway_offline (under precondition_failed)Gateway offline
has_dependents (under precondition_failed)Resource has dependents
kill_switch_active (under precondition_failed)Control is disabled
remote_enable_off (under precondition_failed)Remote operation not enabled
state_not_allowed (under precondition_failed)State does not allow this action
step_limit_exceeded (under precondition_failed)Step limit exceeded
value_outside_envelope (under precondition_failed)Value outside the engineered range

Detail codes registered by owner modules#

CodeTitle
already_decided (under conflict)Already decided
asset_has_children (under conflict)Asset has children
asset_key_conflict (under conflict)Asset key in use
base_version_changed (under conflict)Base version changed
external_ref_conflict (under conflict)External reference conflict
grants_exist (under conflict)Grants exist
import_commit_in_progress (under conflict)Import commit in progress
mapping_address_conflict (under conflict)Mapping address conflict
merge_not_revertable (under conflict)Merge cannot be reverted
reidentification_pending (under conflict)Re-identification pending
relationship_cardinality (under conflict)Relationship cardinality
run_active (under conflict)Run active
signal_key_conflict (under conflict)Signal key in use
signal_unit_immutable (under conflict)Signal unit cannot change
sync_in_progress (under conflict)Synchronisation in progress
type_in_use (under conflict)Type in use
engaged_by_other_party (under permission_denied)Engaged by another party
four_eyes_required (under permission_denied)Second person required
separation_of_duties (under permission_denied)Separation of duties
aas_package_rejected (under precondition_failed)AAS package rejected
aas_unsupported_version (under precondition_failed)AAS version not supported
aas_validation_failed (under precondition_failed)AAS validation failed
account_mapping_missing (under precondition_failed)Account mapping missing
acknowledgement_required (under precondition_failed)Acknowledgement required
acl_unknown (under precondition_failed)Access rights unknown
agent_disabled (under precondition_failed)Agent disabled
agent_trifecta_violation (under precondition_failed)Agent capability combination not allowed
aggregate_not_supported (under precondition_failed)Aggregate not supported
alarm_not_shelvable (under precondition_failed)Alarm cannot be shelved
alarm_shelved (under precondition_failed)Alarm is shelved
already_in_incident (under precondition_failed)Already part of an incident
approval_needs_second_person (under precondition_failed)Second person required
approval_rejected (under precondition_failed)Approval rejected
archive_limit_exceeded (under precondition_failed)Archive limit exceeded
as_of_out_of_range (under precondition_failed)Point in time out of range
assessment_missing (under precondition_failed)Assessment missing
assessment_review_missing (under precondition_failed)Assessment review missing
asset_not_deletable (under precondition_failed)Asset cannot be deleted
asset_required_for_answer (under precondition_failed)Asset required
attachment_limit (under precondition_failed)Attachment limit reached
automation_not_allowed (under precondition_failed)Automation not allowed
binding_incomplete (under precondition_failed)Binding incomplete
binding_invalid_range (under precondition_failed)Binding range invalid
binding_missing (under precondition_failed)Binding missing
binding_required (under precondition_failed)Binding required
binding_unknown_type (under precondition_failed)Binding type unknown
bundle_not_allowed (under precondition_failed)Bundle not allowed
cad_preview_unavailable (under precondition_failed)CAD preview unavailable
capability_missing (under precondition_failed)Capability missing
case_wrong_state (under precondition_failed)Case in the wrong state
channel_not_enabled (under precondition_failed)Channel not enabled
classification_lowering_requires_reason (under precondition_failed)Reason required
clock_not_ok (under precondition_failed)Clock not trustworthy
command_rate_exceeded (under precondition_failed)Command rate exceeded
commissioning_missing (under precondition_failed)Commissioning missing
component_unresolved (under precondition_failed)Component unresolved
confirm_requires_human (under precondition_failed)Human confirmation required
connector_never_writable (under precondition_failed)Connector is never writable
connector_planned (under precondition_failed)Connector only planned
control_gate_missing (under precondition_failed)Control gate missing
credential_kind_not_allowed (under precondition_failed)Credential kind not allowed
credential_missing (under precondition_failed)Credential missing
credential_revoked (under precondition_failed)Credential revoked
credential_undecryptable (under precondition_failed)Credential cannot be decrypted
cross_cell_unsupported (under precondition_failed)Cross-cell use not supported
current_value_unavailable (under precondition_failed)Current value unavailable
cycle_detected (under precondition_failed)Cycle detected
dataset_locked (under precondition_failed)Dataset locked
definition_incomplete (under precondition_failed)Definition incomplete
definition_invalid (under precondition_failed)Definition invalid
definition_not_approved (under precondition_failed)Definition not approved
definition_not_released (under precondition_failed)Definition not released
definition_not_startable (under precondition_failed)Definition cannot be started
definition_suspended (under precondition_failed)Definition suspended
definition_unknown (under precondition_failed)Definition unknown
depth_exceeded (under precondition_failed)Depth exceeded
destination_blocked (under precondition_failed)Destination blocked
destination_not_verified (under precondition_failed)Destination not verified
dexpi_invalid (under precondition_failed)DEXPI data invalid
document_quarantined (under precondition_failed)Document quarantined
draft_stale (under precondition_failed)Draft is stale
edc_version_unsupported (under precondition_failed)Data space version not supported
encrypted_file (under precondition_failed)Encrypted file
environment_not_supported (under precondition_failed)Environment not supported
eval_gate_missing (under precondition_failed)Evaluation gate missing
expression_invalid (under precondition_failed)Expression invalid
extension_already_used (under precondition_failed)Extension already used
factor_overlap (under precondition_failed)Factor overlap
factor_source_missing (under precondition_failed)Factor source missing
field_owned_by_external (under precondition_failed)Field owned by the external system
file_content_mismatch (under precondition_failed)File content mismatch
file_too_large (under precondition_failed)File too large
file_type_not_allowed (under precondition_failed)File type not allowed
fill_not_supported (under precondition_failed)Fill not supported
format_not_supported (under precondition_failed)Format not supported
gates_not_passed (under precondition_failed)Gates not passed
gateway_outdated (under precondition_failed)Gateway outdated
gateway_required (under precondition_failed)Gateway required
guardrail_blocked (under precondition_failed)Blocked by a guardrail
gxp_prerequisite_missing (under precondition_failed)GxP prerequisite missing
history_unavailable (under precondition_failed)History unavailable
host_not_allowed (under precondition_failed)Host not allowed
identity_kind_unsupported (under precondition_failed)Identity kind not supported
identity_not_verified (under precondition_failed)Identity not verified
import_file_rejected (under precondition_failed)Import file rejected
import_has_errors (under precondition_failed)Import has errors
input_invalid (under precondition_failed)Input invalid
input_not_allowed (under precondition_failed)Input not allowed
insufficient_variation (under precondition_failed)Insufficient variation
invalid_lifecycle_transition (under precondition_failed)Lifecycle transition not allowed
invalid_parent_kind (under precondition_failed)Parent kind not allowed
invitation_expired (under precondition_failed)Invitation expired
invoice_invalid (under precondition_failed)Invoice invalid
ip_allow_self_lockout (under precondition_failed)Would lock you out
key_unavailable (under precondition_failed)Key unavailable
kind_not_allowed (under precondition_failed)Kind not allowed
language_not_supported (under precondition_failed)Language not supported
language_pair_not_supported (under precondition_failed)Language pair not supported
legal_hold_active (under precondition_failed)Legal hold active
link_not_readable (under precondition_failed)Link not readable
macro_content_refused (under precondition_failed)Macro content refused
malware_detected (under precondition_failed)Malware detected
mapping_address_invalid (under precondition_failed)Mapping address invalid
mapping_not_active (under precondition_failed)Mapping not active
mapping_type_mismatch (under precondition_failed)Mapping type mismatch
max_depth_exceeded (under precondition_failed)Maximum depth exceeded
merge_conflict (under precondition_failed)Merge conflict
merge_not_allowed (under precondition_failed)Merge not allowed
move_cycle (under precondition_failed)Move would create a cycle
mtp_unsupported_version (under precondition_failed)MTP version not supported
no_asset_context (under precondition_failed)No asset context
not_in_catalog (under precondition_failed)Not in the command catalog
note_rejected (under precondition_failed)Note rejected
operation_in_progress (under precondition_failed)Operation in progress
operation_not_enabled (under precondition_failed)Operation not enabled
operation_unverified (under precondition_failed)Operation not verified
outcome_required (under precondition_failed)Outcome required
outside_share_terms (under precondition_failed)Outside the share terms
outside_support (under precondition_failed)Outside the supported range
partner_not_active (under precondition_failed)Partner not active
pattern_unsafe (under precondition_failed)Pattern unsafe
plant_not_ready (under precondition_failed)Plant not ready
policy_invalid (under precondition_failed)Policy invalid
precondition_not_met (under precondition_failed)Precondition not met
precondition_unverifiable (under precondition_failed)Precondition cannot be verified
presence_missing (under precondition_failed)Presence missing
prohibited_target (under precondition_failed)Prohibited target
protected_token_lost (under precondition_failed)Protected token lost
purpose_not_shareable (under precondition_failed)Purpose not shareable
range_too_large (under precondition_failed)Range too large
reason_required (under precondition_failed)Reason required
recipient_not_allowed (under precondition_failed)Recipient not allowed
recommendation_invalid (under precondition_failed)Recommendation invalid
region_not_allowed (under precondition_failed)Region not allowed
relationship_degree_limit (under precondition_failed)Relationship limit reached
relationship_endpoint_invalid (under precondition_failed)Relationship endpoint invalid
relationship_prohibited (under precondition_failed)Relationship prohibited
relationship_type_not_writable (under precondition_failed)Relationship type not writable
relay_not_approved (under precondition_failed)Relay not approved
release_not_approved (under precondition_failed)Release not approved
remote_enable_unreadable (under precondition_failed)Remote enable unreadable
reopen_window_passed (under precondition_failed)Reopen window passed
residency_violation (under precondition_failed)Data residency violation
restore_in_progress (under precondition_failed)Restore in progress
restore_quarantine (under precondition_failed)Restore quarantine
retention_out_of_bounds (under precondition_failed)Retention out of bounds
retrofit_signoff_missing (under precondition_failed)Retrofit sign-off missing
revision_not_processed (under precondition_failed)Revision not processed
run_not_resumable (under precondition_failed)Run cannot be resumed
scenario_not_allowed (under precondition_failed)Scenario not allowed
scope_not_restorable (under precondition_failed)Scope not restorable
sequence_invalid (under precondition_failed)Sequence invalid
share_not_active (under precondition_failed)Share not active
share_revoked (under precondition_failed)Share revoked
shelve_duration_exceeded (under precondition_failed)Shelve duration exceeded
signal_person_not_allowed (under precondition_failed)Person signal not allowed
signal_type_mismatch (under precondition_failed)Signal type mismatch
signing_unavailable (under precondition_failed)Signing unavailable
snapshot_required (under precondition_failed)Snapshot required
source_not_allowed (under precondition_failed)Source not allowed
source_not_tested (under precondition_failed)Source not tested
state_changed (under precondition_failed)State changed
statement_not_read_only (under precondition_failed)Statement not read-only
statutory_retention (under precondition_failed)Statutory retention
step_not_allowed (under precondition_failed)Step not allowed
store_not_covered (under precondition_failed)Store not covered
stream_blocked (under precondition_failed)Stream blocked
target_not_active (under precondition_failed)Target not active
template_invalid (under precondition_failed)Template invalid
template_subject_mismatch (under precondition_failed)Template subject mismatch
tenant_not_ready_for_deletion (under precondition_failed)Tenant not ready for deletion
terms_mismatch (under precondition_failed)Terms mismatch
timestamp_out_of_range (under precondition_failed)Timestamp out of range
too_many_eligible_revisions (under precondition_failed)Too many eligible revisions
too_many_links (under precondition_failed)Too many links
transition_not_allowed (under precondition_failed)Transition not allowed
type_deprecated (under precondition_failed)Type deprecated
type_inheritance_invalid (under precondition_failed)Type inheritance invalid
type_not_published (under precondition_failed)Type not published
type_validation_failed (under precondition_failed)Type validation failed
unconfirmed_value (under precondition_failed)Unconfirmed value
unit_incompatible (under precondition_failed)Unit incompatible
unsupported_file_type (under precondition_failed)File type not supported
url_not_allowed (under precondition_failed)URL not allowed
variable_not_allowed (under precondition_failed)Variable not allowed
work_in_progress (under precondition_failed)Work in progress
works_agreement_required (under precondition_failed)Works agreement required
worm_not_available (under precondition_failed)WORM storage not available
write_budget_exhausted (under precondition_failed)Write budget exhausted
degraded_capability (under unavailable)Capability degraded
dependency_unavailable (under unavailable)Dependency unavailable
model_unavailable (under unavailable)Model unavailable
restore_in_progress (under unavailable)Restore in progress
search_unavailable (under unavailable)Search unavailable
shed (under unavailable)Request shed under load
tenant_key_unavailable (under unavailable)Tenant key unavailable