Hierarchical Value Service API  future
api index

Hierarchical Value Service API Errors

Error Code Description
HVS-000401 NOT_AUTHENTICATED The request did not have the correct authentication credentials. Check the user information and verify that the user's session has not expired. Example error message: Authentication credentials were missing or incorrect.
HVS-000500 GENERIC_ERROR Unknown internal error. Contact your support representative for assistance and be prepared to provide the service logs. Example error message: An unexpected error occurred. Please contact your support representative for assistance.
HVS-000501 NOT_IMPLEMENTED The requested API has not yet been implemented. Contact your support representative for more information. Example error message: The requested action is not available in this version of the software.
HVS-003001 TABLE_NAME_MISSING The table name to create or rename must be provided as part of the request. Check to be sure that the name is set in the payload for the request. Example error message: The table name is missing.
HVS-003002 TABLE_NAME_INVALID_LENGTH The table name length must be within the required limits. Currently the length must be between 1 and 128 characters, inclusive. Check that the table name specified meets those constraints. Example error message: The length of the table name is invalid.
HVS-003003 SAVE_TABLE_PAYLOAD_MISSING The table creation request did not provide a valid table definition payload. Check to see that the request is correct. Example error message: Cannot save a table without a valid payload.
HVS-003004 TABLE_MULTIPLE_ERRORS There were multiple validation errors while saving the table. Details about the specifics of the errors are provided with the error result. Example error message: Multiple errors were encountered while saving the table.
HVS-003005 TABLE_CREATED_BY_MISSING Probable internal error. The table definition persisted in the database should have information about the user that created the definition. Missing created by information indicates that there is an internal error in populating or reading this field. Example error message: The...
HVS-003006 COLUMN_NAME_INVALID_LENGTH The column name length must be within the required limits. Currently the length must be between 1 and 128 characters, inclusive. Check that the column name specified meets those constraints. Example error message: The length of the column name is invalid.
HVS-003007 COLUMN_TYPE_MISSING The column type was not provided for the column definition for a static column. The currently supported column types are STRING and DECIMAL. Check that the column type is provided as part of the definition. Example error message: The column type must be specified.
HVS-003008 INVALID_COLUMN_TYPE The specified column type for a static column could not be mapped to a supported type. The currently supported column types are STRING and DECIMAL. Check that the column type in the definition is correct. The details present in the error message are: The type specified in the request...
HVS-003009 COLUMN_NAME_MISSING The column name was not provided for a column definition in the table definition. Check that the columns specified in the table definition are correct. Example error message: The column name is missing.
HVS-003010 TABLE_ID_MISSING The table ID was not provided for a table update request. The request must provide an ID in order to correctly update the table. Check that the table ID is provided in the request. Example error message: A table must have an ID.
HVS-003013 COLUMNS_MISSING The table definition for a static table must contain at least one column definition. Check the table definition to be sure it was not intended to be dynamic, and that all the columns were provided. Example error message: At least one column must be specified for the table.
HVS-003014 ACCESS_SEQ_MISSING The table definition provided did not contain an access sequence. The access sequence is required for all table definitions. Check to be sure that the table definition is correct. Example error message: An access sequence must be specified for the table.
HVS-003015 ASPECT_ID_AND_NAME_MISSING An entry in the table's access sequence did not have an aspect identifier or name. An entry must consist of both a dimension and an aspect in order to be valid. Check the access sequence entries to verify that they are correct. Example error message: A dimension aspect must...
HVS-003016 DIMENSION_NAME_AND_ID_MISSING An entry in the table's access sequence did not have a dimension identifier or name. An entry must consist of both a dimension and an aspect in order to be valid. Check the access sequence entries to verify that they are correct. Example error message: An access sequence...
HVS-003017 TABLE_NAME_CONFLICT The specified table name is already in use by another table. Check the name to verify that it is correct or pick another name. The details present in the error message are: The name that is conflicting Example error message: Table name conflict with name TABLE.
HVS-003018 COLUMN_CONSTRAINT_BAD_BOOLEAN The specified constraint value was expected to be able to be parsed as a boolean "true" or "false" value, but could not be parsed correctly. Check the value to be sure it is either "true" or "false". Example error message: Boolean constraint must be "true" or "false".
HVS-003019 COLUMN_CONSTRAINT_UNKNOWN The constraint name specified is not understood for a column of the specified type. Check the constraint name and the column that the constraint is set on to verify that they are correct. Example error message: Unknown constraint to this column type.
HVS-003020 TABLE_ID_AND_NAME_MISSING The request should have specified either the table name or ID, but neither one was found. Check to be sure that one is specified in the request. Example error message: The table must have an ID or a name.
HVS-003021 INVALID_ASPECT An access sequence entry specified an aspect that could not be resolved in the dimension specified by the entry. Check the aspect to verify that it exists and that it is present in the dimension specified. The details present in the error message are: The specified aspect The specified...
HVS-003022 DIMENSION_NOT_FOUND An entry in the access sequence specified a dimension that could not be resolved. Check the dimensions specified in the access sequence to be sure they exist. The details present in the error message are: The specified dimension Example error message: The dimension DIMENSION was not...
HVS-003023 TABLE_ID_ON_CREATE The table creation request specified a table ID in the table metadata. The ID must be created by the system and cannot be provided in the request. Check that the request does not have an ID value for the table. Example error message: A table ID cannot be set upon creation.
HVS-003024 DUPLICATE_COLUMN_NAME The table definition specified two or more columns with the same name. All column names in the table definition must be unique. Check that the columns are correctly specified. The details present in the error message are: The column name that was duplicated Example error message:...
HVS-003501 INVALID_ID_FORMAT The identifier specified in the request does not have the correct format. The format of the identifier must be able to be interpreted as a UUID by the parser. The specified format of a UUID is XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, where X represents any hexadecimal digit either upper...
HVS-003502 TABLE_NOT_FOUND The table name or ID specified in the request could not be found. Check that the correct table is included in the request. The details present in the error message are: The table name specified Example error message: The requested table was not found: TABLE
HVS-003601 UPDATE_TABLE_PAYLOAD_MISSING The table update request did not include the table metadata to use in the update. Check that the request was made correctly and that the table definition was specified. Example error message: Cannot update a table without a valid payload.
HVS-003701 DYNAMIC_TABLE_COLUMNS_NOT_EMPTY A table definition was marked as dynamic, but the definition also specified one or more columns. A dynamic table cannot define any static column definitions. Check to verify that the table should be dynamic, and that no column definitions were specified. The details present...
HVS-003703 DUPLICATE_ACCESS_LEVEL A level in the specified access sequence was duplicated. The unordered set of aspect / dimension pairs that make up a level must not be the same as the set for another level in the sequence. Check to verify that the access sequence is correct and that the levels are unique. Example...
HVS-003704 INVALID_CONSTRAINT_TYPE The specified constraint type could not be parsed as a valid type. Currently only boolean (true / false) constraints are supported. Check that the constraint type is correct and is valid for the particular constraint name specified. The details present in the error message are:...
HVS-004001 RECORD_PAYLOAD_MISSING The request to save a value did not include the value. Check to verify that the value is provided with the request as a payload to the request. Example error message: Cannot save a hierarchical value without a valid payload.
HVS-004002 RECORD_MULTIPLE_ERRORS There were multiple validation errors while saving the record. Details about the specifics of the errors are provided with the error result. Example error message: Multiple errors were encountered while saving the record.
HVS-004004 UNSUPPORTED_COLUMN_TYPE The specified column type for a record column could not be mapped to a supported type. The currently supported column types are STRING and DECIMAL. Check that the column type in the record is correct. The details present in the error message are: The specified column type Example...
HVS-004005 INVALID_TIME_FORMAT The date time specified in the record could not be parsed as a valid date time. The format of the value should match one of these formats: ISO Date / Time format - YYYY-MM-DDThh:mm:ss ISO Date format - YYYY-MM-DD The details present in the error message are: The string that could...
HVS-004007 UNKNOWN_COLUMN_NAME The static table for the specified record did not include one of the column names in the record as one of its static columns. Check that the columns in the record are correct and that the table is specified correctly. The details present in the error message are: The column name that...
HVS-004008 EFFECTIVE_DATE_REQUIRED_PARAMETER_MISSING The record specified in the request did not have either the effective start date time, the effective end date time, or both. The record is required to have a valid start and end date time. Check that the date time parameters are provided with the record. Example...
HVS-004009 SAVE_RECORD_FAILED There was an unknown error while saving the record in the table with the specified ID. The details present in the error message are: The table identifier Example error message: A failure occurred while persisting the record for table with ID 02235e7c-e818-41cd-8198-2566d2150bda
HVS-004010 CURRENCY_REQUIRED_VIOLATION A column in the table is defined as requiring a currency value, but one was not specified in the record for that column. Check that there is a currency value associated with the column value in the record. Example error message: Currency is defined as required for a column...
HVS-004011 UNIT_REQUIRED_VIOLATION A column in the table is defined as requiring a unit value, but one was not specified in the record for that column. Check that there is a unit value associated with the column value in the record. Example error message: Unit is defined as required for a column but the associated...
HVS-004012 REQUIRED_COLUMN_VALUE_MISSING A column in the table is defined as required, but a value was not provided in the record for that column. Check that the column has a value in the record. Example error message: The column is marked as required for the table but the associated record column is missing or...
HVS-004013 INVALID_DECIMAL_FORMAT The column in the table is defined as being a decimal column, but the provided value could not be parsed as a decimal value. Check that the value for the column exists and is formatted as a valid number. The details present in the error message are: The specified value that could...
HVS-004014 EFFECTIVE_END_BEFORE_EFFECTIVE_START The record provided in the request has an effective end date time before the effective start date time. Check that the start date time and end date time for the record are correct. The details present in the error message are: The specified effective end date The...
HVS-004015 SCOPE_MISSING The record requires a valid dimensional scope for its data, and one could not be found. Check that the record contains a valid scope. Example error message: The scope is required.
HVS-004016 INVALID_SCOPE The record requires a valid dimensional scope for its data. The provided scope contained one or more invalid dimension node references. Check that the scope is complete, and that a dimension and node identifier pair exists for each dimension in the scope. Example error message: The scope...
HVS-004017 INVALID_DIMENSION The scope specified contained a dimension that could not be resolved. Check that the dimensions contained in the scope are correct. The details present in the error message are: The specified dimension Example error message: The dimension DIMENSION was not found.
HVS-004018 INVALID_DIMENSION_NODE The scope specified contained a dimension node that could not be resolved in the specified dimension. Check that the dimension nodes contained in the scope are correct. The details present in the error message are: The specified dimension node The specified dimension Example error...
HVS-004019 RECORD_VALUES_MISSING The record did not specify any values. Check that the values for the record are present. Example error message: Values must be specified.
HVS-004021 INVALID_NUMBER_OF_DIMENSION_NODES The scope specified contained multiple nodes for the same dimension. Only one node per dimension specified is allowed. Check that the scope is correct and that no dimensions have been duplicated. The details present in the error message are: The number of dimension node...
HVS-004022 INVALID_NUMBER_OF_ASPECTS The access level specified contained multiple aspects for the same dimension. Only one aspect per dimension specified is allowed. Check that the access level is correct and that no dimensions have been duplicated. The details present in the error message are: The number of aspect...
HVS-004023 REQUESTED_RESOURCE_NOT_FOUND A resource ID referenced in the scope or access level specified could not be converted to a valid UUID. Check that the resource IDs specified in the request are correct. The details present in the error message are: The missing resource identifier Example error message: Did...
HVS-004024 ASPECT_REQUIRED_FOR_DIMENSION The access level specified in the request included a dimension that did not have a specified aspect. Check that the access level is correct and that all the needed aspects are provided. The details present in the error message are: The dimension that does not have an aspect...
HVS-004025 DIMENSION_NODE_REQUIRED_FOR_DIMENSION The scope specified in the request included a dimension that did not have a specified dimension node. Check that the scope is correct and that all the needed dimension nodes are provided. The details present in the error message are: The dimension that does not have...
HVS-004026 SCOPE_LEVEL_NOT_IN_ACCESS_SEQUENCE The record scope must map to a level defined in the access sequence for the table. Check that the record scope is correct and the corresponding level is present in the access sequence for the table. The details present in the error message are: The table name specified...
HVS-004027 RECORD_COLUMN_NAME_MISSING The record specified a column that did not have a name. Check that all of the columns for the record are valid. Example error message: The column name is missing.
HVS-004028 RECORD_COLUMN_NAME_INVALID_LENGTH The column name length must be within the required limits. Currently the length must be between 1 and 128 characters, inclusive. Check that the column name specified meets those constraints. Example error message: The length of the column name is invalid.
HVS-004029 RECORD_COLUMN_TYPE_MISSING The record specified a column that did not have a provided type. The type is required for columns in records for dynamic tables. Check that all of the columns have a type property and that the table is correct. Example error message: The column type must be specified.
HVS-004030 LINK_NAME_INVALID_LENGTH The length of the link name must be between 1 and 128 characters, inclusive. Check to make sure the name specified meets this requirement. Example error message: The length of the link name exceeds 128 characters.
HVS-004031 LINK_NAME_MISSING Link name is not specified. Make sure the link name is specified when creating a link. Example error message: Link name is not specified.
HVS-004032 LINKED_TO_TABLE_MISSING The specified table that this link is linked to was not found in the system. Make sure the specified table exists. Example error message: The table this link is linked to does not exist. Table ID: ff18498a-3228-425a-816c-481bac1030ca
HVS-004033 LINKED_TO_TABLE_ID_MISSING The table ID this link is linked to is not specified. Make sure a table ID is specified. Example error message: The ID of the table this link is linked to is missing.
HVS-004034 LINK_MULTIPLE_ERRORS There are multiple errors in the specified link. Make sure all fields in the specified link are valid. Example error message: Multiple errors were encountered while saving the link.
HVS-004035 LINK_NOT_FOUND The requested link was not found in the system. Example error message: The requested link was not found: ff18498a-3228-425a-816c-481bac1030ca
HVS-004036 CREATE_LINK_PAYLOAD_MISSING The payload is not provided when creating a link. Example error message: Cannot create a link without a valid payload.
HVS-004037 UPDATE_LINK_PAYLOAD_MISSING The payload is not provided when updating a link. Example error message: Cannot update a link without a valid payload.
HVS-004038 LINK_NAME_CONFLICT Link name must be unique among all tables and links. Make sure the specified link name is not used by another table or link. Example error message: Link name conflict with name aNameInUse.
HVS-004039 MANIPULATE_DATA_VIA_LINK The link is a symbolic link to a physical table. It only allows read operation to the linked to table or records. Any write operations to the linked to table or records are not allowed. Example error message: Cannot change table definition or record via a link.
HVS-004040 LINK_TO_ANOTHER_LINK A link can only link to a physical table; it cannot link to another link. Example error message: A link cannot link to another link.
HVS-004041 BATCH_REQUEST_EMPTY A batch request was attempted, but the request payload was empty. Please verify the request contains at least one item and try again.
HVS-004042 BATCH_REQUEST_CORRUPT The batch request contained invalid input, or the payload was corrupt. Please review the request payload for errors. Issues that can cause this error may include, but are not necessarily limited to: Missing required fields Identifier spelling or capitalization mistakes Explicit...
HVS-004043 BATCH_REQUEST_RECORD_PAYLOAD_MISSING Could not process the batch request because the request payload was missing. Please update the request payload and try again.
HVS-004044 BATCH_REQUEST_TOO_MANY_ITEMS The batch request contained too many requested items. For performance and resource utilization reasons, batch requests are limited to a maximum set of items per request. Please reduce the number of items per batch request and try again. Send multiple, smaller batch requests...
HVS-004045 RECORD_OVERLAPPING_DATES The single scope batch request contained items whose effective date ranges overlapped. This endpoint only supports records for a single scope whose dates do not overlap, as these records are newly created or overwritten as a contiguous sequence of records.
HVS-004046 UNSUPPORTED_SINGLE_RECORD_UPDATES The single scope batch request contained items whose effective date ranges overlapped. This endpoint only supports records for a single scope whose dates do not overlap, as these records are newly created or overwritten as a contiguous sequence of records.
HVS-004051 RECORD_VALUES_INVALID_PER_QUANTITY Per quantity value is invalid.
HVS-008000 MIGRATION_IN_PROGRESS Migration is in progress. Operation is not supported.