Golden API schemas

On this page

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

218 schemas.

`BaseResponseDto`

Common response fields for the Golden API.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`BucketStatsDto`

Bucket statistics of an entity in exchange format.

Property	Type	Required	Description
`bucketsByIndex`	map of `integer (int64)`	false	Indexes with buckets, duplicated or not.
`duplicatesByIndex`	map of `integer (int64)`	false	Indexes with duplicate buckets.
`totalBuckets`	`integer (int64)`	false	Total number of buckets.
`totalBucketsValue`	`integer (int64)`	false	Unformatted total candidate-group count.
`totalDuplicatedBuckets`	`integer (int64)`	false	Total number of duplicated buckets.
`totalDuplicatedBucketsValue`	`integer (int64)`	false	Unformatted count of candidate groups containing duplicates.

`ClassificationDetail`

Represents a detailed comparison between two records.

Property	Type	Required	Description
`score`	`integer (int32)`	false	Overall comparison score
`similarities`	map of `number (double)`	false	Map of similarities between compared records, key is column, value is similarity
`tuple0`	`integer (int32)`	false	Index of first compared record
`tuple1`	`integer (int32)`	false	Index of second compared record

`ClassifierWeight`

Weighted classifier is a resource that classifies records according to classification mappings and weights.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“classifier-weight”]
`validation`	Validation	false	Current validation result.
`bucketSizeReviewThreshold`	`integer (int32)`	false	Bucket size review threshold. If a bucket has more records than this threshold, it will marked to be reviewed.
`dataset`	`string`	false	The dataset to use.
`defaultOptions`	array of `string`	false	Default text options used for mappings that do not have specific options. By default, aggressive.
`defaultWeight`	`number (double)`	false	Default weight used for mappings that do not have a specific weight. By default, 1.0.
`mappings`	array of ClassifierWeightMapping	true	List of mappings that define the comparison between columns.
`matchThreshold`	`number (double)`	false	Upper threshold to consider a match. Any score above this threshold will be considered a match.
`nonMatchThreshold`	`number (double)`	false	Lower threshold to consider a non-match. Any score below this threshold will be considered a non-match.
`reviewScoreThreshold`	`number (double)`	false	Minimum representative score (0-1) a bucket/cluster must reach to appear in the default duplicate-review (candidates) view. Fail-safe: when unset or out of the (0,1] range, the effective value is 0.75.

`ClassifierWeightMapping`

A weight classifier mapping is a mapping between columns of a record that are compared to retrieve a weighted score.

Property	Type	Required	Description
`id`	`string`	false	The identifier of the weight classifier mapping.
`keys`	array of `string`	false	The column(s) of the record that are compared.
`nullMismatch`	`boolean`	false	When true, a missing value counts as a mismatch (0) against a present value, and two missing values count as equal (1). When false (default), missing values are excluded from the comparison.
`object`	`boolean`	false	Whether the comparison is an object comparison. By default is not.
`options`	array of `string`	false	The options used for the comparison.
`threshold`	`integer (int32)`	false	The threshold for object comparison. By default is 50.
`weight`	`number (double)`	false	The weight of the mapping.

`Column`

Column definition, including name, description, dataset, validation rules, error rules and formatting/parsing. Also some UI guidelines.

Property	Type	Required	Description
`array`	`boolean`	false	Array flag. Indicates if the column supports multiple values. Default is false. Nested DATASET columns require true. default: false
`dataset`	`string`	false	Dataset identifier.
`description`	`string or null`	false	Column description, in one language: the language of the request on a record or table response, the base language on a resource document. The other languages, when there are any, are in descriptionLocalized.
`descriptionLocalized`	array of LocalizedTextEntry	false	Every language this column’s description was written in. Absent when it was written in one language with no language named, which is what description alone means.
`empty`	`boolean or null`	false	Empty flag. Indicates if the column can be empty. Default is true. SOURCE columns are always mandatory, regardless of this flag. default: true
`enumerations`	array of EnumerationOption or `null`	false	Allowed values and labels. Applies to ENUM and SOURCE tokens.
`error`	`string or null`	false	Error handling. Indicates what to do when an error is found. enum: [“CLEAR”, “REPLACE”, “FIX”, “IGNORE”, “REFUSE”]; default: “IGNORE”
`errorReplacement`	`string or null`	false	Error replacement. Indicates what to replace when an error is found if error policy is to replace.
`foreignKey`	`string or null`	false	Lookup column in table.key[.key]* form, including nested columns. Applies to FOREIGN_ID tokens.
`identity`	`boolean`	false	Identity flag. Indicates if the column is to be used for generating identity. Default is false. default: false
`key`	`string`	true	Column name
`lookup`	`boolean or null`	false	Lookup flag. Indicates if the column can be leveraged for lookups. Default is false. default: false
`lookupDescription`	`boolean or null`	false	Flag to indicate if the column is leveraged in as a lookup description. Default is false.
`regex`	`string or null`	false	Regular expression. Used for validation.
`script`	`string or null`	false	Groovy script. Used for validation.
`source`	`string or null`	false	Data format. Used for validating the format.
`sourceLocale`	`string or null`	false	Data locale. Used for validating the localized format.
`token`	`string or null`	false	Token type. Only meaningful if column is a token. enum: [“COUNTRY_CODE”, “COUNTRY_NAME”, “LANGUAGE”, “PHONE_COUNTRY_CODE”, “PHONE_NUMBER”, “PHONE”, “NAME_PREFIX”, “NAME_FIRST”, “NAME_MIDDLE”, “NAME_LAST”, “NAME”, “ADDRESS_STREET_TYPE”, “ADDRESS_STREET_NAME”, “ADDRESS_NUMBER”, “ADDRESS_STREET”, “ADDRESS_CITY”, “ADDRESS_POSTCODE”, “ADDRESS_STATE”, “ADDRESS”, “GEO_LONGITUDE”, “GEO_LATITUDE”, “GEO_COORDINATES”, “ID”, “FOREIGN_ID”, “EMAIL”, “NUMBER”, “DATE”, “ENUM”, “SOURCE”, “URL”, “TEXT”, “TEXT_AS_IS”, “IGNORE”]; default: “TEXT”
`type`	`string`	false	Column type enum: [“TOKEN”, “DATASET”]; default: “TOKEN”
`validation`	`string or null`	false	Validation type. Indicates how to validate the column. enum: [“NONE”, “DEFAULT”, “PARSER”, “REGEX”, “SCRIPT”]; default: “NONE”

`ColumnChangeDto`

One column whose quality inputs moved.

Property	Type	Required	Description
`attributes`	array of `string`	false	The projected attribute names that differ.
`key`	`string`	false	The column key.

`ColumnRender`

Rendering override for one column.

Property	Type	Required	Description
`column`	`string`	false	Column key.
`render`	`string`	false	Rendering configuration for the column.

`ColumnRuleDto`

Resolved value constraints for one column.

Property	Type	Required	Description
`key`	`string`	false	The column key this rule is about.
`mandatory`	`boolean`	false	True when a value is required. It is the negation of the column’s ’empty’ flag, with the token’s own mandatoriness already folded in — a SOURCE column is mandatory whatever the flag says.
`pattern`	`string`	false	An ECMAScript regular expression, anchored so that a substring test is a whole-string test. Null unless patternScope is PUBLISHED.
`patternMessage`	`string`	false	Localized message for a pattern mismatch. Null unless patternScope is PUBLISHED.
`patternMessageKey`	`string`	false	The stable catalogue key ‘patternMessage’ was rendered from. For diagnostics, and so a consumer can group across languages without parsing prose.
`patternScope`	`string`	false	Whether the pattern is published, and if not, why not. enum: [“NONE”, “PUBLISHED”, “WITHHELD_DIALECT”, “SERVER_ONLY_NORMALISED”, “WITHHELD_UNCOMPILABLE”]

`ColumnSummary`

Summary override for one column.

Property	Type	Required	Description
`column`	`string`	false	Column key.
`summary`	ViewSummary	false	Summary configuration for the column.

`Configuration`

Configuration

Property	Type	Required	Description
`category`	`string`	false	Configuration category
`payload`	`string`	false	Configuration payload

`ConfigurationListResponseDto`

Represents a list of configurations response.

Property	Type	Required	Description
`configurations`	array of Configuration	false	Configurations.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`ConfigurationRequestDto`

Represents a configuration request.

Property	Type	Required	Description
`configuration`	Configuration	true	Configuration.

`ConfigurationResponseDto`

Represents a configuration response.

Property	Type	Required	Description
`configuration`	Configuration	false	Configuration.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`ConfigurationVersionResponseDto`

Represents product version.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`version`	`string`	false	Build version

`Credential`

Credentials to authenticate resources.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“credentials”]
`validation`	Validation	false	Current validation result.
`credentialType`	`string`	true	Type of credential. enum: [“NONE”, “PASSWORD”, “SSH”, “TOKEN”]
`password`	`string`	false	Password.
`sshPrivateCertificate`	`string`	false	Private SSH certificate.
`sshPublicCertificate`	`string`	false	Public SSH certificate.
`token`	`string`	false	Token.
`user`	`string`	false	User name.

`DailyMetricDto`

One daily metric snapshot: envelope and payload.

Property	Type	Required	Description
`calculatedAt`	`string (date-time)`	false	When the aggregation was actually taken. May be after the day closed.
`day`	`string (date)`	false	The UTC day the snapshot describes, in ISO yyyy-MM-dd. It identifies [00:00Z, next 00:00Z).
`family`	`string`	false	The metric family. Stable machine identifier.
`familyVersion`	`string`	false	The version of that family’s payload schema and calculation semantics. Not the record-quality definition, which travels inside the quality payload.
`issues`	QualityIssuesMetricDto	false	The typed issue ranking. Set when, and only when, the family is quality-issues.
`payload`	map of any JSON value	false	The stored payload as a JSON object, for a registered family this API version has no typed view of. Set when, and only when, no typed member above is.
`quality`	QualityDailyMetricDto	false	The typed quality payload. Set when, and only when, the family is quality.
`table`	`string`	false	The business table the snapshot describes.

`DailyMetricListResponseDto`

A bounded ascending run of daily metric snapshots.

Property	Type	Required	Description
`aggregateScope`	`string`	false	The snapshots are computed over the whole table, not over the caller’s data scope. Always ENTITY. enum: [“ENTITY”]
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`family`	`string`	false	The family asked about.
`fromDay`	`string (date)`	false	The first day of the inclusive window.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`snapshots`	array of DailyMetricDto	false	The snapshots that exist in that window, ascending by day.
`table`	`string`	false	The table asked about.
`toDay`	`string (date)`	false	The last day of the inclusive window.

`DataScopeDto`

The data scope of one principal.

Property	Type	Required	Description
`entities`	map of RowScopeDto	false	The granted entities. A null value means the whole entity; a row scope means only the matching rows. Entities absent from the map are invisible to the principal.
`principalId`	`string`	false	Identifier of the user or access token to which the grant applies.
`principalName`	`string`	false	The principal’s display name, when it can still be resolved.
`principalType`	`string`	false	The kind of principal. enum: [“USER”, “ACCESS_TOKEN”]
`updated`	`integer (int64)`	false	When the scope was last written, epoch milliseconds.
`updatedBy`	`string`	false	Who last wrote the scope.

`DataScopeListResponseDto`

Every principal that has a data scope.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`scopes`	array of DataScopeDto	false	The scopes.

`DataScopeResponseDto`

One principal’s data scope.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`scope`	DataScopeDto	false	The scope.

`DataView`

A data-view governs how a dataset’s records are presented.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“data-view”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`form`	ViewForm	false	How the record form is sectioned and rendered.
`list`	ViewList	false	How the record list renders.
`title`	`string`	false	Mustache template naming a record, e.g. “{{apellido1}} {{apellido2}}, {{nombre}}”, in one language. See GoldenTemplate. The other languages, when there are any, are in titleLocalized.
`titleLocalized`	array of LocalizedTextEntry	false	Every language this record title was written in.

`Dataset`

Record structure and semantic column definitions, including identity, validation, nested datasets, and provenance.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“dataset”]
`validation`	Validation	false	Current validation result.
`columns`	array of Column	true	List of columns in this dataset.
`dataType`	`string`	false	Data type. enum: [“RECORD”, “JSON”, “TEXT”, “BINARY”, “XML”]
`identityScript`	`string`	false	Identity function script.
`identityType`	`string`	false	Identity function type. enum: [“DEFAULT”, “COLUMN”, “SCRIPT”]
`lookup`	`boolean or null`	false	Flag to indicate if the dataset can be used for lookups. A lookup table might be referenced in other tables. Default is false.
`merger`	`string`	false	Optional merger. The default merger uses the identity.
`provenance`	DatasetProvenance	false	What this data set declares about record provenance: the format of the source system and of its identifier there. Optional.
`qualityHash`	`string or null`	false	Server-controlled quality definition hash: a lowercase 64-character SHA-256 hexadecimal digest of this dataset’s quality projection, including the hash of every nested dataset it references. Read-only. readOnly: true

`DatasetProjectionDiffDto`

What moved in a dataset’s quality projection.

Property	Type	Required	Description
`addedColumns`	array of `string`	false	Column keys the write would add.
`changedColumns`	array of ColumnChangeDto	false	Columns present before and after whose projected attributes moved.
`newDataType`	`string`	false	The projected data type after the change, or null when it did not move.
`previousDataType`	`string`	false	The projected data type before the change, or null when it did not move.
`removedColumns`	array of `string`	false	Column keys the write would remove.

`DatasetProvenance`

What a data set declares about the provenance the engine writes: the format of the source system (_src) and of its own identifier for the record (_src_id). The structure is the product’s and is not configurable; only what the values may be.

Property	Type	Required	Description
`enabled`	`boolean`	false	Whether this data set records where its records came from. Off by default: when it is on, the declaration below is binding on every writer.
`reference`	Column	false	Format of the source system’s own identifier for the record (_src_id).
`source`	Column	false	Format of the source system value (_src).
`sourceDefault`	`string or null`	false	The source system a record gets when the caller states no origin at all. Must be one of the declared sources. It applies to ABSENCE only: a value that is not in the list is refused, never replaced by this one.

`DatasetQualityImpactResponseDto`

What saving a dataset would invalidate, computed without writing anything.

Property	Type	Required	Description
`affectedDatasets`	array of `string`	false	Every dataset whose stored hash would move: the edited one and every dataset that reaches it through a nested-dataset column, because a nested hash participates in every ancestor’s.
`affectedTables`	array of `string`	false	Every table whose records would become awaiting re-measurement. Empty when no table names an affected dataset.
`changes`	DatasetProjectionDiffDto	false	What moved in the quality projection, or null when the previous projection was never retained by this installation — which is not the same as nothing having moved.
`currentQualityHash`	`string`	false	The stored quality hash, or null when the dataset is being created.
`dataset`	`string`	false	The dataset the draft would write.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`newQualityHash`	`string`	false	The quality hash the write would store.
`qualityHashChanges`	`boolean`	false	Whether the quality hash would move. False is the ordinary outcome of editing a description, retitling an enumeration option or reordering columns: none of them is a quality input.

`Dependency`

Represents a dependency between objects.

Property	Type	Required	Description
`usedBy`	array of `string`	false	Set of objects that are using this object. uniqueItems: true
`usedByCount`	`integer (int32)`	false	Number of objects that are using this object.
`uses`	array of `string`	false	Set of objects that this object is using. uniqueItems: true
`usesCount`	`integer (int32)`	false	Number of objects that this object is using.

`DependencyResponseDto`

The dependencies of one resource, table or entity.

Property	Type	Required	Description
`dependency`	Dependency	false	What this item uses and what uses it.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EntityAccessEntryDto`

One principal granted an entity, whole or by row scope.

Property	Type	Required	Description
`principalId`	`string`	false	The principal’s identifier.
`principalName`	`string`	false	The principal’s display name, when it can still be resolved.
`principalType`	`string`	false	The kind of principal. enum: [“USER”, “ACCESS_TOKEN”]
`values`	array of `string`	false	The allowed values of the scope column, or null for the whole entity.

`EntityAccessRequestDto`

The complete access list

Property	Type	Required	Description
`principals`	array of EntityAccessEntryDto	true	The principals granted the entity, whole or by row scope.

`EntityAccessResponseDto`

An entity’s access list.

Property	Type	Required	Description
`entity`	`string`	false	The entity.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`principals`	array of EntityAccessEntryDto	false	The principals granted the entity. Empty means only ADMINs see it.
`scopeColumn`	`string`	false	The entity’s scope column, or null when rows cannot be scoped.
`scopeIndexState`	`string`	false	State of the scope column’s index: NONE, BUILDING, VALID or FAILED. enum: [“NONE”, “BUILDING”, “VALID”, “FAILED”]

`EntityDto`

Represents an entity.

Property	Type	Required	Description
`aggregateScope`	`string`	false	The stats and counts in this response are computed over the whole entity, not over the caller’s data scope. Always ENTITY. enum: [“ENTITY”]
`automatic`	`boolean`	false	Automatic synchronization flag.
`bucketCount`	`integer (int64)`	false	Number of managed buckets.
`classifier`	`string`	false	Associated classifier.
`dataset`	`string`	false	Associated dataset.
`datasetViews`	map of `string`	false	Every dataset the entity uses, root first, then the nested ones, mapped to the data-view that presents it or null for none. A dataset is listed even when it has no view.
`dependency`	Dependency	false	Configuration dependencies.
`description`	`string`	false	Entity description.
`duplicateBucketCount`	`integer (int64)`	false	Total number of potential duplicated buckets.
`duplicates`	`boolean`	false	Duplicates supported flag.
`enabled`	`boolean`	false	Enabled flag.
`id`	`string`	false	Entity identifier.
`indexDuplicateCounts`	map of `integer (int64)`	false	Map of indexes and number of potential duplicate buckets per index.
`indexLabels`	map of `string`	false	Index description.
`indexer`	`string`	false	Associated indexer.
`locked`	`boolean`	false	Locked flag.
`merger`	`string`	false	Associated merger.
`pipeline`	`string`	false	Associated pipeline.
`recordCount`	`integer (int64)`	false	Number of managed records.
`scopeColumn`	`string`	false	Dataset column that partitions the entity for data access scopes.
`scopeIndexState`	`string`	false	State of the index on the scope column: NONE, BUILDING, VALID, FAILED. enum: [“NONE”, “BUILDING”, “VALID”, “FAILED”]
`searches`	`boolean`	false	Search supported flag.
`sinks`	array of EntityResourceTransformationSinkDto	false	Sinks.
`sources`	array of EntityResourceTransformationSourceDto	false	Sources.
`status`	`string`	false	Entity status. enum: [“EMPTY”, “WORKING”, “READY”, “INCONSISTENT”, “ERROR”]
`steward`	`string`	false	Associated steward.
`stewardCron`	`string`	false	Steward cron scheduling expression.
`stewardCronType`	`string`	false	Steward cron scheduling type. enum: [“EVERY_5_MINUTES”, “EVERY_15_MINUTES”, “EVERY_30_MINUTES”, “EVERY_HOUR”, “EVERY_DAY_AT_2AM”, “EXPERT”]
`stewarding`	`boolean`	false	Steward supported flag.
`table`	`string`	false	Associated table.
`type`	`string`	false	Entity type. enum: [“NONE”, “SEARCH”, “DUPLICATES”, “AUTO_DUPLICATES”]
`validation`	Validation	false	Current configuration validation result.
`view`	`string`	false	The data-view of the root dataset, or null when the entity has none. Equal to the root dataset’s entry in datasetViews.

`EntityExchangeDto`

Represents an set of entity in exchange format (used for import/export).

Property	Type	Required	Description
`count`	`integer (int32)`	false	Number of exported entities.
`entities`	array of EntityPostDto	true	Exported entity.
`timestamp`	`integer (int64)`	false	Export timestamp.
`version`	`string`	false	Export version.

`EntityExportRequestDto`

Represents a request to export data from a entity

Property	Type	Required	Description
`ids`	array of `string`	true	Entities identifiers to be exported. minItems: 1

`EntityExportResponseDto`

Exported entity configuration package.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`exchange`	EntityExchangeDto	false	Exported entities.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EntityImportRequestDto`

Represents a request to import entities.

Property	Type	Required	Description
`exchange`	EntityExchangeDto	true	Previously exported entities in JSON format.

`EntityImportResponseDto`

Represents a response to import entities.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`imported`	`integer (int32)`	false	Total number of imported entities.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`total`	`integer (int32)`	false	Total number of entities.

`EntityListResponseDto`

Represents a list of entities.

Property	Type	Required	Description
`entities`	array of EntityDto	false	List of entities.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EntityPostDto`

Represents a Golden entity in exchange format.

Property	Type	Required	Description
`asyncIndexing`	`boolean`	false	Whether HTTP upserts queue indexing after records have been stored.
`automatic`	`boolean`	false	Whether the entity is automatic.
`classifier`	`string`	false	Identifier of the classifier associated with the entity.
`datasetViews`	map of `string`	false	Data-view per dataset the entity uses, keyed by dataset id, root included. Null on an entity saved before the per-dataset association existed, whose view field alone names the root dataset’s view.
`description`	`string`	false	Description of the entity.
`enabled`	`boolean`	false	Whether the entity is enabled.
`entityStats`	EntityStatsDto	false	EntityStats.
`id`	`string`	true	Unique identifier for the entity.
`indexer`	`string`	false	Identifier of the indexer associated with the entity.
`locked`	`boolean`	false	Whether the entity is locked.
`merger`	`string`	false	Identifier of the merger associated with the entity.
`pipeline`	`string`	false	Identifier of the pipeline associated with the entity.
`scopeColumn`	`string`	false	Dataset column that partitions the entity for data access scopes.
`sinks`	array of ResourceTransformationSink	false	List of sinks associated with the entity.
`sources`	array of ResourceTransformationSource	false	List of sources associated with the entity.
`status`	`string`	false	Status of the entity. enum: [“EMPTY”, “WORKING”, “READY”, “INCONSISTENT”, “ERROR”]
`steward`	`string`	false	Identifier of the steward associated with the entity.
`stewardCron`	`string`	false	Cron expression for the steward associated with the entity.
`table`	`string`	false	Identifier of the table associated with the entity.
`type`	`string`	false	Type of the entity. enum: [“NONE”, “SEARCH”, “DUPLICATES”, “AUTO_DUPLICATES”]
`view`	`string`	false	Data-view this entity presents its records through.

`EntityResourceTransformationSinkDto`

Represents an entity sink.

Property	Type	Required	Description
`audit`	`boolean`	false	Flag to include metadata audit when sinking.
`resource`	`string`	false	Resource identifier.
`transformation`	`string`	false	Optional transformation identifier.

`EntityResourceTransformationSourceDto`

Represents an entity source.

Property	Type	Required	Description
`cron`	`string`	false	Cron scheduling expression.
`cronType`	`string`	false	Cron scheduling type. enum: [“EVERY_5_MINUTES”, “EVERY_15_MINUTES”, “EVERY_30_MINUTES”, “EVERY_HOUR”, “EVERY_DAY_AT_2AM”, “EXPERT”]
`incremental`	`boolean`	false	Source incremental loading.
`lastExecution`	`string (date-time)`	false	Source last execution.
`resource`	`string`	false	Resource identifier.
`transformation`	`string`	false	Optional transformation identifier.

`EntityResponseDto`

Represents an entity.

Property	Type	Required	Description
`entity`	EntityDto	false	Entity.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EntitySaveRequestDto`

Request to synchronize an entity with its configured sources and destinations.

Property	Type	Required	Description
`classifier`	`string`	false	Classifier identifier
`create`	`boolean`	false	Create entity flag. Default is true. If not set, the entity is meant to be updated.
`datasetViews`	map of `string`	false	Data-view per dataset the entity uses, keyed by dataset id, root included; blank means none. When present it is the whole answer and view is ignored; when absent, view names the root dataset’s view and the nested datasets have none.
`description`	`string`	false	Entity description
`id`	`string`	false	Entity identifier
`indexer`	`string`	false	Indexer identifier
`merger`	`string`	false	Merger identifier
`pipeline`	`string`	false	Pipeline identifier
`sinks`	array of EntityResourceTransformationSinkDto	false	Sinks.
`sources`	array of EntityResourceTransformationSourceDto	false	Sources.
`steward`	`string`	false	Steward identifier
`stewardCron`	`string`	false	Steward cron scheduling expression.
`stewardCronType`	`string`	false	Steward cron scheduling type. enum: [“EVERY_5_MINUTES”, “EVERY_15_MINUTES”, “EVERY_30_MINUTES”, “EVERY_HOUR”, “EVERY_DAY_AT_2AM”, “EXPERT”]
`table`	`string`	false	Table identifier
`type`	`string`	false	Entity type enum: [“NONE”, “SEARCH”, “DUPLICATES”, “AUTO_DUPLICATES”]
`view`	`string`	false	Data-view of the root dataset. Read only when datasetViews is absent; when the map is present it is the whole answer and this field is ignored.

`EntityStatsDto`

Statistics of an entity in exchange format.

Property	Type	Required	Description
`bucketStats`	BucketStatsDto	false	Bucket statistics.
`recordCount`	`integer (int64)`	false	Number of managed records.
`recordCountValue`	`integer (int64)`	false	Unformatted record count.

`EntitySynchronizationRequestDto`

Request to synchronize an entity with its configured sources and destinations.

Property	Type	Required	Description
`id`	`string`	true	Entity identifier
`indexClassificationMask`	`string`	true	FULL rebuilds indexes and classification; CHANGES reconciles changed configuration; DIRTY classifies pending groups without reindexing; NONE skips the phase. Use CHANGES for SEARCH entities. enum: [“FULL”, “CHANGES”, “DIRTY”, “NONE”]
`loadFrom`	`string (date-time)`	false	Represents an instant ISO 8601 timestamp, used as a filter to load data from this timestamp
`loadMask`	`string`	true	Load the full source, an incremental window, custom time bounds, or skip loading. CUSTOM requires loadFrom or loadTo. enum: [“FULL”, “INCREMENTAL”, “CUSTOM”, “NONE”]
`loadOperation`	`string`	false	What the load does with every record it reads. Optional; UPSERT when not supplied, which inserts a record the entity does not have and updates one it does. DELETE removes the record each document identifies. Ignored when loadMask is NONE. enum: [“UPSERT”, “DELETE”]
`loadTo`	`string (date-time)`	false	Represents an instant ISO 8601 timestamp, used as a filter to load data until this timestamp
`sinkMask`	`string`	true	Deliver the full current set or skip delivery. enum: [“FULL”, “NONE”]

`EntitySynchronizationResponseDto`

Represents an entity synchronization response.

Property	Type	Required	Description
`entity`	EntityDto	false	Entity synchronized.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`run`	TzRunView	false	The queued run, or null when the entity was already up to date.

`EntryDto`

One ranked problem type.

Property	Type	Required	Description
`message`	`string`	false	The rendered sentence, in the request’s locale.
`messageArgs`	map of any JSON value	false	The named arguments the key declares.
`messageKey`	`string`	false	The stable catalogue key, retained for diagnostics and support.
`occurrenceCount`	`integer (int64)`	false	How many findings fell into this group. Occurrences, not records: one record with two malformed emails in a repeated field contributes two.
`schemaPath`	`string`	false	The declaration path: dataset keys joined by ‘.’, with ‘[]’ on every repeated segment. It is what groups the problem across records.
`severity`	`string`	false	ERROR or WARNING.

`EnumerationOption`

One entry of a column’s closed vocabulary: its stored key and its label.

Property	Type	Required	Description
`key`	`string`	true	The value stored in the record. Never translated.
`value`	`string`	true	Label in the request language for resolved options, or the base language in a resource definition. Other translations appear in valueLocalized.
`valueLocalized`	array of LocalizedTextEntry	false	Every language this label was written in. Absent when it was written in one language with no language named, which is what value alone means.

`EventDeleteResponseDto`

Represents a set of delete events.

Property	Type	Required	Description
`deleted`	`integer (int32)`	false	Number of deleted events.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EventDto`

Event

Property	Type	Required	Description
`created`	`string (date-time)`	false	Event creation timestamp in ISO 8601 format
`error`	`string`	false	Event error message
`id`	`string`	false	Event identifier
`modified`	`string (date-time)`	false	Event modification timestamp in ISO 8601 format
`payload`	`string`	false	Event payload
`sink`	`string`	false	Sink identifier
`valid`	`boolean`	false	Event valid flag

`EventPageResponseDto`

Represents a page of events

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`events`	array of EventDto	false	List of events in this page.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	Page	false	Page information.
`sink`	`string`	false	Sink identifier.

`EventResponseDto`

Represents an event.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`event`	EventDto	false	Event.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`EventStats`

Event statistics.

Property	Type	Required	Description
`description`	`string`	false	Description of the sink.
`eventsCount`	`integer (int64)`	false	Total number of events pending to be sunk.
`invalidCount`	`integer (int64)`	false	Total number of invalid events.
`nextCheck`	`string (date-time)`	false	Timestamp in ISO 8601 format for the next check (if sink is stalled).
`sink`	`string`	false	Sink identifier.
`stalled`	`boolean`	false	Flag to indicate if the sink is stalled.
`validCount`	`integer (int64)`	false	Total number of valid events.

`EventStatsResponseDto`

Represents event system statistics.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`stats`	map of EventStats	false	Event statistics map indexed by sink.

`FileGolden`

Represents a Golden file.

Property	Type	Required	Description
`contentType`	`string`	false	Content type as MIME type.
`created`	`string (date-time)`	false	Created instant ISO 8601 timestamp.
`description`	`string`	false	File description.
`id`	`string`	false	File identifier.
`length`	`integer (int64)`	false	Length in bytes.
`name`	`string`	false	File name.

`FileListResponseDto`

Represents a list of files.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`files`	array of FileGolden	false	List of files.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	Page	false	Page.

`FileResponseDto`

Represents an file response.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`file`	FileGolden	false	File.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`GoldenBucketFullResponseDto`

Represents a bucket with all available information.

Property	Type	Required	Description
`classification`	`string`	false	Bucket classification outcome. enum: [“MATCH”, “NON_MATCH”, “REVIEW”, “IGNORE”]
`columnMap`	map of Column	false	Map of columns with detailed information.
`columns`	array of `string`	false	Column names in this bucket
`count`	`integer (int32)`	false	Number of records in the bucket.
`details`	array of ClassificationDetail	false	Optional classification information
`deviation`	`integer (int32)`	false	Score standard deviation.
`entity`	EntityDto	false	Entity that owns this bucket
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`escalated`	`boolean`	false	True when a steward escalated this group to an administrator (data access scopes).
`escalatedAt`	`string (date-time)`	false	When it was escalated, when it is escalated.
`escalatedBy`	`string`	false	Who escalated it, when it is escalated.
`escalationNote`	`string`	false	The steward’s note, when it is escalated.
`historyKept`	`boolean`	false	True when the entity keeps history, so the records a merge absorbs are archived rather than gone. False means a merge is irreversible: there is no copy of the sources and no undo to build on.
`id`	`string`	false	Bucket identifier.
`ignore`	`boolean`	false	Ignore flag.
`index`	`string`	false	Index that created this bucket
`judgedPairs`	array of array of `string`	false	The pairs of records inside this group that somebody recorded as different, each as two record ids. A pair is judged when either record lists the other in _metadata._unrelated. A merge whose selection holds one of these pairs is refused unless it crosses the separation on purpose. Empty when there is none.
`key`	`string`	false	Bucket key.
`merged`	Record	false	Candidate to merged record
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`mixed`	`boolean`	false	True when at least one member of the group lies outside the caller’s data scope. Always false for an unrestricted caller. The group is returned whole; the members outside are listed in `outOfScope`.
`outOfScope`	array of `string`	false	Identifiers of the members that lie outside the caller’s data scope. They are returned in `records` like the others so the group can be read whole, and listed here so the client can mark them. Empty for an unrestricted caller.
`reasoning`	`string`	false	Bucket classification reasoning.
`records`	array of Record	false	Records in this bucket
`score`	`integer (int32)`	false	Bucket average score (0-100).
`split`	array of Record	false	Candidates to split records

`GoldenBucketLightResponseDto`

Represents a lightweight bucket (contains less information that a full weight bucket).

Property	Type	Required	Description
`classification`	`string`	false	Bucket classification outcome. enum: [“MATCH”, “NON_MATCH”, “REVIEW”, “IGNORE”]
`count`	`integer (int32)`	false	Number of records in the bucket.
`deviation`	`integer (int32)`	false	Score standard deviation.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`escalated`	`boolean`	false	True when a steward escalated this group to an administrator (data access scopes).
`escalatedAt`	`string (date-time)`	false	When it was escalated, when it is escalated.
`escalatedBy`	`string`	false	Who escalated it, when it is escalated.
`escalationNote`	`string`	false	The steward’s note, when it is escalated.
`id`	`string`	false	Bucket identifier.
`ignore`	`boolean`	false	Ignore flag.
`key`	`string`	false	Bucket key.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`reasoning`	`string`	false	Bucket classification reasoning.
`score`	`integer (int32)`	false	Bucket average score (0-100).

`GoldenBucketPageResponseDto`

Represents a page of lightweight buckets.

Property	Type	Required	Description
`buckets`	array of GoldenBucketLightResponseDto	false	List of lightweight buckets.
`entity`	EntityDto	false	Entity.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	Page	false	Page information.

`GoldenClusterEvaluationResponseDto`

The exhaustive, on-demand evaluation of one cluster: every pair of records compared through the entity’s classifier — n(n-1)/2 comparisons, the half matrix. The stored classification only ever measures adjacent pairs; this answers the expert’s deeper question of which records group with which.

Property	Type	Required	Description
`clusterId`	`string`	false	Cluster identifier.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`pairs`	array of GoldenPairComparisonDto	false	Every pair of records, compared: n(n-1)/2 entries.
`recordIds`	array of `string`	false	Record identifiers, in the order the pairs reference them.

`GoldenClusterPageResponseDto`

Represents a page of logical duplicate clusters.

Property	Type	Required	Description
`clusters`	array of GoldenLogicalClusterDto	false	List of logical clusters.
`entity`	EntityDto	false	Entity.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	`integer (int32)`	false	Current page number (0-based).
`pageSize`	`integer (int32)`	false	Number of clusters per page.
`totalPages`	`integer (int32)`	false	Total number of pages.
`totalRecords`	`integer (int32)`	false	Total number of matching clusters.

`GoldenDeleteBucketRequestDto`

Represents a bucket delete request

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.

`GoldenDeleteBucketResponseDto`

Represents a bucket delete response

Property	Type	Required	Description
`entity`	EntityDto	false	Entity that owns the deleted records.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`records`	array of Record	false	Deleted records.

`GoldenDeleteRequestDto`

Represents a record delete request

Property	Type	Required	Description
`comment`	`string or null`	false	Optional comment describing why the record is being deleted. When present it is recorded on the REMOVE audit event, so it appears in the record’s history.
`recordId`	`string`	true	Record identifier.

`GoldenDeleteResponseDto`

Represents delete record result

Property	Type	Required	Description
`deleted`	`boolean`	false	Indicates if the record was deleted.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`record`	map of `object`	false	Deleted record

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`GoldenDisconnectBucketRequestDto`

Represents a bucket disconnect request

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.

`GoldenDisconnectBucketResponseDto`

Represents a bucket disconnect response

Property	Type	Required	Description
`entity`	EntityDto	false	Entity that owns the disconnected records.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`records`	array of Record	false	Disconnected records.

`GoldenDisconnectRecordsBucketRequestDto`

Represents a request to disconnect specific records from a bucket

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.
`recordIds`	array of `string`	true	Identifiers of the records to peel off from the bucket. Must be a non-empty subset of the records currently in the bucket. To disconnect every record, use the bucket-wide disconnect endpoint instead. minItems: 1

`GoldenDuplicateRecordCountResponseDto`

Records with at least one possible duplicate, per entity.

Property	Type	Required	Description
`counts`	map of `integer (int64)`	false	Entity id to the number of its records that have at least one possible duplicate. An entity whose count could not be read is absent rather than zero.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`GoldenEscalateRequestDto`

Escalates a bucket or cluster to an administrator, with a note

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.

`GoldenIgnoreBucketRequestDto`

Represents a bucket ignore or un-ignore request

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.

`GoldenLogicalClusterDto`

A logical duplicate group joining candidate groups that share at least one record.

Property	Type	Required	Description
`bucketIds`	array of `string`	false	Candidate-group identifiers in this cluster, in ascending order.
`classification`	`string`	false	Classification of the representative bucket. enum: [“MATCH”, “NON_MATCH”, “REVIEW”, “IGNORE”]
`clusterId`	`string`	false	Cluster identifier: the smallest candidate-group identifier in the cluster.
`deviation`	`integer (int32)`	false	Deviation score of the representative bucket (0-100).
`escalated`	`boolean`	false	True when a steward escalated this cluster to an administrator (data access scopes).
`escalatedAt`	`string (date-time)`	false	When it was escalated, when it is escalated.
`escalatedBy`	`string`	false	Who escalated it, when it is escalated.
`escalationNote`	`string`	false	The steward’s note, when it is escalated.
`ignore`	`boolean`	false	Whether the representative bucket is ignored.
`label`	`string`	false	Human-friendly label derived from the indexer mapping keys of a sample record (e.g. ‘Gilbert Chable’ for a name-sur1-fuzzy cluster). Falls back to clusterId when no sample is available.
`mappingId`	`string`	false	Indexer mapping id that produced the cluster.
`reasoning`	`string`	false	Classification reasoning of the representative bucket.
`recordCount`	`integer (int32)`	false	Distinct records in the listed candidate groups. Ignore and classification filters restrict both bucketIds and this count.
`resolved`	`boolean`	false	True when every pair of records inside this group has been recorded as different, so there is nothing left to decide — which requires every bucket of the group to be marked, not just the one the other fields are read from. Groups like this are left out of the listing unless it is asked for them with ‘resolved=true’.
`score`	`integer (int32)`	false	Average score of the representative bucket (0-100).

`GoldenMergeBucketRequestDto`

Represents a bucket merge request

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.
`crossSeparations`	`boolean`	false	Merge even though the group holds a pair of records recorded as different (_metadata._unrelated). Off by default, and without it such a merge is refused with 409. When set, a comment is mandatory, and the merge revokes only the pairs it crosses: the survivor keeps every other separation of the records it absorbs.

`GoldenMergeBucketResponseDto`

Represents a bucket merge response

Property	Type	Required	Description
`entity`	EntityDto	false	Entity that owns the merged record.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`record`	map of `object`	false	Merged record.

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`GoldenMergeRecordsRequestDto`

Represents a request to merge specific records of a cluster

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.
`crossSeparations`	`boolean`	false	Merge even though the selection holds a pair of records recorded as different (_metadata._unrelated). Off by default, and without it such a merge is refused with 409. When set, a comment is mandatory, and the merge revokes only the pairs it crosses: the survivor keeps every other separation of the records it absorbs. Ignored by the preview’s comment rule, since a preview files nothing.
`recordIds`	array of `string`	true	Identifiers of the records to merge. At least two, every one of them in the cluster. minItems: 2

`GoldenPairComparisonDto`

One exhaustive comparison between two records of a cluster: the overall score and the per-column similarities, exactly as the classifier measures them.

Property	Type	Required	Description
`recordA`	`string`	false	Identifier of the first record of the pair.
`recordB`	`string`	false	Identifier of the second record of the pair.
`score`	`integer (int32)`	false	Overall comparison score, 0-100.
`similarities`	map of `number (double)`	false	Map of similarities between the two records; key is column, value 0-1.

`GoldenSearchCapabilitiesResponseDto`

What an entity can be searched by

Property	Type	Required	Description
`entity`	`string`	false	Entity these capabilities belong to.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`fields`	array of GoldenSearchFieldDto	false	The searchable fields, in indexer order.
`freeTextIndexed`	`boolean`	false	Whether free-text search has an index available. When false, search can still return matching records, but may reach its time limit and report truncated results.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`provenanceSearchable`	`boolean`	false	True when a free-text term is also looked up as a source system’s own key for a record (_source._src_id), right after the identifier. It does not depend on the indexer’s mappings: the engine writes provenance on every record.
`searchable`	`boolean`	false	False when the entity has no indexer at all: nothing can be searched.

`GoldenSearchFieldDto`

A searchable field of an entity

Property	Type	Required	Description
`columns`	array of `string`	false	Dataset columns this field is built from. More than one when combined.
`combined`	`boolean`	false	True when the mapping combines its columns into a single key. A free-text term still reaches it – word similarity scores against the best-matching fragment of the key – so this is for display, not for deciding whether to probe.
`description`	`string`	false	The mapping’s description, written for a person.
`freeText`	`boolean`	false	True when a free-text term can probe this field. False only for geographic mappings, whose keys are coordinates: those belong in the advanced form, with a radius.
`mapping`	`string`	false	Identifier of the indexer mapping behind this field.
`matching`	`string`	false	How the mapping matches when it is asked its own question. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

`GoldenSearchRequestDto`

Represents a record search request

Property	Type	Required	Description
`entity`	`boolean`	false	Flag to return entity information. By default is false.
`filter`	TableFilter	false	Optional metadata filter, the same one the record page and the free-text search send. Applied to the records the search found, before ranking and paging. Absent means no filtering.
`options`	SearchOptions	false	Optional search options. If not indicated, default search options are used.
`pageNumber`	`integer (int32)`	false	Optional page number for multiple results. Default is 0. minimum: 0
`pageSize`	`integer (int32)`	false	Optional page size for multiple results. Default is 10. Page size, at most 1000. A larger value is a 400, not a clamped page. minimum: 1; maximum: 1000
`record`	map of any JSON value	true	Search record document: contains the column and values to search for. Search is performed using the indexer associated to the entity.
`tableType`	`string`	false	Optional table scope. TABLE searches only current records; HISTORY searches only historical records. When absent, the established combined search is preserved. enum: [“TABLE”, “HISTORY”]
`transformation`	`string`	false	Optional transformation name. If indicated, the transformation must exist and will be applied to the search record before searching.

Fields within record:

Property	Type	Required	Description
`empty`	`boolean`	false	—

Additional properties: any JSON value.

`GoldenSearchResponseDto`

Represents found records

Property	Type	Required	Description
`count`	`integer (int32)`	false	Total number of records found.
`entity`	EntityDto	false	Optional entity that was searched. Only included if the entity flag was enabled.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	Page	false	Page returned.
`result`	array of Record	false	List of found records. If no records are found, this list will be empty.
`search`	map of `object`	false	Record that was used to search.
`truncated`	`boolean`	false	True when the search stopped early – it hit the result cap or the deadline – so this is part of the answer and not all of it. A truncated search that says nothing cannot be told apart from one that found exactly this much.

Fields within search:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`GoldenSplitBucketRequestDto`

Represents a bucket split request

Property	Type	Required	Description
`comment`	`string`	false	Optional comment for the bucket operation.

`GoldenSplitBucketResponseDto`

Represents a bucket split response

Property	Type	Required	Description
`entity`	EntityDto	false	Entity that owns the split record.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`records`	array of Record	false	Split records.

`GoldenTextSearchRequestDto`

Free-text search request

Property	Type	Required	Description
`entity`	`boolean`	false	Flag to return entity information. By default is false.
`filter`	TableFilter	false	Optional metadata filter, the same one the record page sends. Applied to the records the search found, before ranking and paging, so the total and the page windows describe the filtered answer. Absent means no filtering.
`options`	SearchOptions	false	Search options. Identity, result cap and the deadline all apply.
`pageNumber`	`integer (int32)`	false	Optional page number for multiple results. Default is 0. minimum: 0
`pageSize`	`integer (int32)`	false	Optional page size for multiple results. Default is 10. Page size, at most 1000. A larger value is a 400, not a clamped page. minimum: 1; maximum: 1000
`query`	`string`	false	The text to search for. Whitespace separates terms; double quotes hold a phrase together. Every term is probed against every searchable field, and a record that matches more of them ranks higher.
`similarity`	`number (double)`	false	Word-similarity floor, 0.0..1.0. Higher is stricter. Left unset it is 0.7, which admits a one-letter typo and a phone without its country prefix while keeping out everything that merely shares a mail domain or a dialling prefix – word similarity scores a term against the best-matching fragment of a key, so a low floor is cleared by shared boilerplate alone. It governs only the approximate half of the search: a term found by identifier or by exact key is returned whatever this says, and a term that appears verbatim inside a key is matched by substring rather than by score, so a partial surname does not need a loose floor.
`tableType`	`string`	false	Optional table scope. TABLE searches only the records that are in the table; HISTORY only the ones that have left it. When absent, both are searched and the answer is their union: a record that left the table by a merge is returned as the record it was merged into, annotated MERGED_FORWARD, so a value that is no longer in any column still leads to the record that is current today. enum: [“TABLE”, “HISTORY”]

`GoldenUndoMergeRequestDto`

Represents a request to undo the merge that produced a record

Property	Type	Required	Description
`comment`	`string or null`	false	Optional comment describing why the merge is being undone. When present it is recorded on the operation, so it appears in the history of both the record that is deleted and the records that come back.
`recordId`	`string`	true	Identifier of the record a merge produced.

`GoldenUndoMergeResponseDto`

Represents the result of undoing a merge

Property	Type	Required	Description
`deletedRecordId`	`string`	false	Identifier of the record the merge had produced, now deleted and archived.
`entity`	EntityDto	false	Entity that owns the restored records.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`records`	array of Record	false	The records the merge had absorbed, now back in the table.

`GoldenUpsertRequestDto`

Represents a record upsert (update or insert) request

Property	Type	Required	Description
`comment`	`string or null`	false	Optional comment describing the change. When present it is recorded on the insert/update audit event, so it appears in the record’s history.
`insert`	`boolean or null`	false	Optional forced insert flag. Default is false. If enabled, the record will always be inserted.
`options`	SearchOptions	false	Optional search options. If not indicated, default search procedure is used.
`record`	map of `object`	true	Record to upsert. The record must contain the primary key columns and values to search for the record. If the record is not found, it will be inserted; otherwise, it will be updated.
`transformation`	`string or null`	false	Optional transformation name. If indicated, the transformation must exist and will be applied to the search record before searching.
`update`	`boolean or null`	false	Optional forced update flag. Default is false. If enabled, the record will always be updated; if not found, an error is returned.

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`GoldenUpsertResponseDto`

Represents upserted record result

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`inserted`	`boolean`	false	Indicates if the record was inserted.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`record`	map of `object`	false	Updated/inserted record
`updated`	`boolean`	false	Indicates if the record was updated.

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`IndexStatusResponseDto`

Indexing status for a record under async indexing

Property	Type	Required	Description
`attempts`	`integer or null (int32)`	false	Number of indexing attempts made.
`error`	`string or null`	false	Error message if status is FAILED.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`modifiedAt`	`string or null (date-time)`	false	Timestamp of the last status change.
`queuedAt`	`string or null (date-time)`	false	Timestamp when the record was first queued.
`recordId`	`string`	false	Record identifier.
`status`	`string`	false	Current indexing status. enum: [“PENDING”, “INDEXED”, “FAILED”]

`Indexer`

An indexer is used to calculate indexes for records.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“indexer”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`defaultKeyOptions`	array of `string`	false	Default key options to use when calculating indexes.
`mappings`	array of IndexerMapping	true	Mappings to calculate indexes.

`IndexerMapping`

An indexer mapping is used to calculate one index based on different criteria.

Property	Type	Required	Description
`combine`	`boolean`	false	If true, the mapping combines the keys using permutations or a single key. default: false
`description`	`string`	true	The description of the mapping.
`duplicates`	`boolean`	false	If true, the mapping allows finding duplicates.
`fuzzyMaximumTypos`	`integer (int32)`	false	The maximum number of typographical errors considered for fuzzy indexing.
`geoPrecision`	`string`	false	The geographic precision used for indexing. enum: [“L1”, “L2”, “L3”, “L4”, “L5”, “L6”, “L7”, “L8”, “L9”, “L10”]
`geoSteps`	`integer (int32)`	false	The steps around considered to index a geographical area.
`id`	`string`	true	The unique identifier of the mapping.
`keyOptions`	array of `string`	false	The options to use when calculating the keys. Can override the default options.
`keys`	array of `string`	true	The column keys to use when calculating the index (if type is columns).
`lshBands`	`integer (int32)`	false	Deprecated compatibility field. Ignored during processing; configure fuzzyMaximumTypos instead.
`lshRows`	`integer (int32)`	false	Deprecated compatibility field. Ignored during processing; configure fuzzyMaximumTypos instead.
`matching`	`string`	false	The matching/search used when comparing indexing keys. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]
`script`	`string`	false	The script to use when calculating the index (if type is script).
`type`	`string`	false	How the mapping key is calculated. enum: [“COLUMNS”, “SCRIPT”]

`JsonNode`

Any JSON value: an object, array, string, number, boolean, or null.

Type: object

`LocalizedTextEntry`

One language’s text.

Property	Type	Required	Description
`language`	`string`	false	ISO 639-1 language code.
`text`	`string`	false	The text in that language.

`LookupPageResponseDto`

A page of a lookup table’s values.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`key`	`string`	false	The column that holds the catalogue’s values.
`limit`	`integer (int32)`	false	The maximum number of entries this page could hold.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`narrowed`	`boolean`	false	True when the caller is restricted on the entity owning this catalogue and its scope column is the catalogue’s key, so the values are narrowed to the caller’s own.
`offset`	`integer (int32)`	false	The offset this page starts at.
`table`	`string`	false	The lookup table read.
`total`	`integer (int64)`	false	Number of distinct values matching the query, across every page.
`values`	array of LookupValueDto	false	The entries of this page, ordered by value.

`LookupValueDto`

One value of a lookup (master reference) table.

Property	Type	Required	Description
`description`	`string`	false	The catalogue’s description columns joined by a space, or the value itself when the catalogue declares none.
`label`	`string`	false	Display label in the form [value] description.
`value`	`string`	false	The stored value, which is what a referencing record holds.

`MergerWeight`

A weight merger is a resource aimed at merging records by calculating a weight for each record and then merging the values of each column, considering that the higher the weight, the more important the record/column.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“merger-weight”]
`validation`	Validation	false	Current validation result.
`constant`	`string`	false	—
`dataset`	`string`	false	The dataset to use.
`key`	`string`	false	The key of the column to be used for the merge. By default, the first column of the dataset.
`mergeSort`	`string`	false	The sort of merge to perform. enum: [“HIGHEST_WEIGHT”, “LOWEST_WEIGHT”]
`mergeType`	`string`	true	The type of merge to perform. enum: [“RANDOM”, “CONSTANT”, “DATE”, “NUMBER”, “SCRIPT”]
`script`	`string`	false	—

`Option`

A key-value pair.

Property	Type	Required	Description
`key`	`string`	true	The key of the option.
`value`	`string`	true	The value of the option.

`Page`

Represents a page of data.

Property	Type	Required	Description
`page`	`integer (int32)`	false	Current page number.
`pageSize`	`integer (int32)`	false	Number of items per page.
`totalPages`	`integer (int32)`	false	Number of total pages.

`Pipeline`

A pipeline is a sequence of processors that are applied to records of a certain dataset.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“pipeline”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`processors`	array of Processor	true	The processors in the pipeline.

`Processor`

A processor is used to process records as a stage of a pipeline.

Property	Type	Required	Description
`processorType`	`string`	true	The type of processor. enum: [“CLEANER”, “TRANSFORMER”, “SCRIPT”]
`properties`	array of Option	false	Additional properties of the processor.
`script`	`string`	false	Optional script to execute.
`transformation`	`string`	false	Optional transformation to execute.

`QualityContributionDto`

What one measured field contributed to a record’s quality score.

Property	Type	Required	Description
`earnedDenominator`	`string`	false	Denominator of the fraction this field earned, in lowest terms and strictly positive.
`earnedNumerator`	`string`	false	Numerator of the fraction this field earned, in lowest terms. A decimal integer string, because the value has no bound a JSON number preserves.
`mandatory`	`boolean`	false	Whether the column is mandatory, which is what its weight comes from.
`passing`	`boolean`	false	True when the field earned everything it could, which is what “this field passes” means. Derived from the two above and carried so that a consumer counting passing fields does not have to parse them.
`repeated`	`boolean`	false	Whether the field is repeated, in which case the fraction below is a mean over the occurrences it applied to.
`schemaPath`	`string`	false	Declaration path: dataset keys joined by ‘.’, with ‘[]’ on repeated segments. The same string a finding carries, so the two are joined without building a path.
`weight`	`integer (int32)`	false	The field’s fixed weight: 2 when it is mandatory, 1 when it is not.

`QualityDailyMetricDto`

The quality family payload of a daily metric snapshot.

Property	Type	Required	Description
`averageQuality`	`number`	false	Mean of the scalars of current records, two decimals, half-up. Null when no current record carried a scalar.
`coveragePercentage`	`number`	false	100 x current / total, two decimals, half-up. Null when the table had no records: zero records is not applicable, not 0%.
`currentQualityRecordCount`	`integer (int64)`	false	Records measured under the definition this payload names, including a current record with no scalar because its plan had no measurable field.
`histogram`	array of `integer (int64)`	false	Exactly ten counts: 0..9, 10..19, … 80..89, and 90..100. The last bucket is eleven scores wide because 100 has to land somewhere.
`maximumQuality`	`integer (int32)`	false	Highest scalar among current records. Null on the same condition as the average.
`minimumQuality`	`integer (int32)`	false	Lowest scalar among current records. Null on the same condition as the average.
`qualityDefinition`	`string`	false	The combined quality definition the aggregation was taken against.
`recordsWithErrorsCount`	`integer (int64)`	false	Current records carrying at least one error. Not totalErrorCount, which sums findings: a record with three errors adds three there and one here.
`recordsWithIssuesCount`	`integer (int64)`	false	Current records carrying at least one error or warning. Never below recordsWithErrorsCount; the difference is the records whose only problem is a warning.
`totalErrorCount`	`integer (int64)`	false	Sum of the stored error counts of current records.
`totalRecordCount`	`integer (int64)`	false	Every current record of the table. History records are never counted.
`totalWarningCount`	`integer (int64)`	false	Sum of the stored warning counts of current records.

`QualityFindingDto`

One quality problem found on one value of one record, ready to display.

Property	Type	Required	Description
`message`	`string`	false	Finding message in the request language.
`messageArgs`	map of any JSON value	false	The named arguments the key declares. For diagnostics.
`messageKey`	`string`	false	The stable catalogue key the sentence was rendered from. For diagnostics.
`recordPath`	`string`	false	Occurrence path: the same keys with each repeated segment replaced by its zero-based index, or the container path when the repeated field itself has no items.
`schemaPath`	`string`	false	Declaration path: dataset keys joined by ‘.’, with ‘[]’ on repeated segments.
`severity`	`string`	false	How bad the problem is. enum: [“ERROR”, “WARNING”]

`QualityIssuesMetricDto`

The issue-ranking payload of a daily metric snapshot.

Property	Type	Required	Description
`entries`	array of EntryDto	false	The ranked problem types, most occurrences first. At most the stored limit; what falls outside it is summarised by the two ‘other’ members rather than dropped.
`otherOccurrenceCount`	`integer (int64)`	false	Occurrences belonging to types beyond the stored limit.
`otherTypeCount`	`integer (int64)`	false	Types beyond the stored limit. A pager that reaches the end of ’entries’ has not reached the end of the ranking while this is above zero.
`qualityDefinition`	`string`	false	The combined quality definition the aggregation was taken against.
`totalOccurrenceCount`	`integer (int64)`	false	Every finding on every current record, stored types and beyond alike.
`totalTypeCount`	`integer (int64)`	false	Every distinct problem type, stored or not.

`QualityMeasurementDto`

One quality measurement taken on demand.

Property	Type	Required	Description
`issues`	QualityIssuesMetricDto	false	The issue ranking, as the daily snapshot carries it.
`label`	`string`	false	What the person who asked for it called it, as typed. Absent when unnamed.
`measuredAt`	`string (date-time)`	false	When the measurement was taken. Both payloads describe this instant.
`quality`	QualityDailyMetricDto	false	The quality payload, as the daily snapshot carries it.
`requestedBy`	`string`	false	The principal that asked for the measurement.
`table`	`string`	false	The business table measured.

`QualityMeasurementListResponseDto`

The quality measurements of one table, newest first.

Property	Type	Required	Description
`aggregateScope`	`string`	false	The measurements are computed over the whole table, not over the caller’s data scope. Always ENTITY. enum: [“ENTITY”]
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`fromDay`	`string (date)`	false	The first day of the inclusive window.
`measurements`	array of QualityMeasurementDto	false	The measurements taken in that window, newest first, at most 200.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`table`	`string`	false	The table asked about.
`toDay`	`string (date)`	false	The last day of the inclusive window. May be today.

`QualityMeasurementOperationResponseDto`

The run started by a quality measurement request.

Property	Type	Required	Description
`entity`	`string`	false	The entity being measured.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`run`	TzRunView	false	The queued run.

`QualityMeasurementRequestDto`

A request to measure one entity’s quality now.

Property	Type	Required	Description
`entity`	`string`	true	The entity whose table is measured.
`label`	`string`	false	What to call this measurement, at most 120 characters. Optional.

`Record`

A projected record containing dataset-defined business fields and reserved metadata. See Record metadata for the stored JSON representation. Read audit events through the dedicated audit operation.

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	Record identifier.
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: any JSON value.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`RecordAudit`

Reserved legacy audit representation. Ordinary record responses omit inline audit; use the audit event operations.

Property	Type	Required	Description
`comment`	`string`	false	Recorded comment.
`instant`	`string (date-time)`	false	Time of the change.
`records`	array of `string`	false	Record identifiers associated with the change.
`user`	`string`	false	User recorded for the change.

Additional properties: object.

`RecordAuditChangeDto`

One field-level change carried by an audit event.

Property	Type	Required	Description
`after`	JsonNode	false	The native JSON value after, when the change type carries one.
`before`	JsonNode	false	The native JSON value before, when the change type carries one.
`field`	`string`	false	The raw column name, present exactly when no path could be derived: a migrated change whose legacy field name is not a declared root key, or a column the cleaner deleted because the dataset does not declare it.
`legacyReason`	`string`	false	The migrated free-text reason, untrusted. Migration only; new changes carry a key instead, because the free text embedded the offending value.
`path`	`string`	false	The canonical concrete record path, such as contact[0].email. Absent when the change names a column the dataset does not declare, which has no path.
`reasonArgs`	map of any JSON value	false	That key’s named arguments.
`reasonKey`	`string`	false	The change-level machine reason key, from the audit.reason.* catalogue.
`type`	`string`	false	What happened to the field. enum: [“INSERT”, “REMOVE”, “UPDATE”, “IGNORED”]

`RecordAuditEventDto`

One audit event.

Property	Type	Required	Description
`actorId`	`string`	false	Their immutable identifier, exactly as the row stores it.
`actorLabel`	`string`	false	The display name resolved now, or the localized deleted/unknown label. A response decoration: it is never written back into the event.
`actorType`	`string`	false	Who acted, in the audit vocabulary: USER, TOKEN, SYSTEM or UNKNOWN. enum: [“USER”, “TOKEN”, “SYSTEM”, “UNKNOWN”]
`changes`	array of RecordAuditChangeDto	false	The ordered changes. Empty for COMMENT and for CLEAR.
`comment`	`string`	false	The operator’s own words, when they left any.
`eventId`	`string`	false	The event identifier.
`occurredAt`	`string (date-time)`	false	When it happened, UTC, microsecond precision.
`operationId`	`string`	false	The logical business command this event belongs to. Every event one command wrote carries the same value.
`operationType`	`string`	false	What happened. enum: [“INSERT”, “UPDATE”, “REMOVE”, “MERGE”, “SPLIT”, “DISCONNECT”, “COMMENT”, “CLEAR”, “AUDIT_ENABLED”, “AUDIT_DISABLED”, “BUCKET_IGNORED”, “BUCKET_UNIGNORED”, “BUCKET_ESCALATED”, “BUCKET_ESCALATION_RESOLVED”]
`reasonArgs`	map of any JSON value	false	That key’s named arguments.
`reasonKey`	`string`	false	The operation-level machine reason key.
`recordId`	`string`	false	The record this event is about. Absent on a table-level CLEAR.
`relatedRecordIds`	array of `string`	false	The other side of a relationship operation: the survivor on an absorbed record’s MERGE, the absorbed records on the survivor’s, every record of the operation on a SPLIT, the records declared unrelated on a DISCONNECT. Absent on every other operation. Migrated and new events alike.
`removedRecordCount`	`integer (int64)`	false	How many current data rows a CLEAR removed. Present only on a CLEAR.
`sources`	map of array of `string`	false	Merge provenance, keyed by column key: the absorbed records whose value each merged column took. One record for a single-valued column, every contributor for a repeated one, since there the merge unions rather than choosing. The keys are the merger’s own column names, not the canonical leaf paths the changes array uses. Present only on the survivor’s MERGE. Merge weights are deliberately not stored: they are a function of a merger configuration that can change.

`RecordAuditPageResponseDto`

One page of audit events, newest first.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`events`	array of RecordAuditEventDto	false	The events, ordered by occurrence instant descending then event id descending.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`nextCursor`	`string`	false	Hand this back as the cursor parameter to get the next older page. Absent when there is no older page. Opaque: do not parse it.

`RecordCheckRequestDto`

A draft record to measure without writing it.

Property	Type	Required	Description
`record`	map of `object`	true	The record as it currently stands, values included.

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`RecordMetadata`

Record metadata.

Property	Type	Required	Description
`_errors`	array of `string`	false	List of errors.
`_history`	`boolean`	false	Whether this is a retained history record.
`_merged`	array of `string`	false	Identifiers of contributing records.
`_operation`	`string`	false	Record operation. enum: [“none”, “insert”, “update”, “remove”]
`_operation_bucket`	`string`	false	Bucket operation. enum: [“merge”, “remove”, “split”, “disconnect”, “unmerge”]
`_unrelated`	array of `string`	false	Identifiers recorded as different subjects.
`_updated`	`string (date-time)`	false	Time of the last recorded update.
`_quality`	`integer`	false	Stored quality score, from 0 to 100; absent when unavailable. minimum: 0; maximum: 100; readOnly: true
`_quality_error_count`	`integer`	false	Number of errors in the stored measurement. readOnly: true
`_quality_warning_count`	`integer`	false	Number of warnings in the stored measurement. readOnly: true
`_quality_available_points`	`integer`	false	Total applicable weighted points used to calculate the stored score. readOnly: true
`_quality_definition`	`string`	false	Identifier of the quality definition used for this measurement. readOnly: true
`_quality_calculated_at`	`string (date-time)`	false	Time of the stored measurement. readOnly: true
`_quality_facts`	array of `object`	false	Stored findings, with severity, schemaPath, recordPath, messageKey and messageArgs. Read localized explanations through the record quality operation. readOnly: true

Fields within _quality_facts:

Property	Type	Required	Description
`severity`	`string`	false	enum: [“ERROR”, “WARNING”]
`schemaPath`	`string`	false	—
`recordPath`	`string`	false	—
`messageKey`	`string`	false	—
`messageArgs`	map of any JSON value	false	—

`RecordQualityResponseDto`

Why one record scores what it scores, measured now.

Property	Type	Required	Description
`availablePoints`	`integer (int32)`	false	The denominator: the summed weight of every applicable field.
`contributions`	array of QualityContributionDto	false	One entry per applicable field, in the order the dataset declares them.
`errorCount`	`integer (int32)`	false	How many findings are errors.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`findings`	array of QualityFindingDto	false	The problems this measurement found, rendered in the request’s language. These come from the same measurement as the contributions, so the two always agree.
`measured`	`boolean`	false	True when this record could be measured now. False when the table has no dataset, its plan does not compile, or the measurement failed — in which case every field below except the stored ones is absent and ‘unavailableReason’ says why.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`rawScore`	`integer (int32)`	false	The same rounded ratio before the two caps. Equal to ‘score’ unless a cap moved it: the score is held at 99 when the record carries any error, and lifted to 1 when anything at all was earned. Compare the two rather than inferring.
`recordId`	`string`	false	The record.
`score`	`integer (int32)`	false	The score as measured now, 0..100. Null means the plan had no applicable measurable field, so there is no ratio to report — which is not a score of zero.
`storedCalculatedAt`	`string (date-time)`	false	When the stored measurement was taken. Null when there is none.
`storedScore`	`integer (int32)`	false	The score the record is carrying from when it was last written, or null if it has never been measured. Shown beside the fresh one so a difference is visible.
`storedState`	`string`	false	What the stored measurement is worth against the definition the table is currently on. UNCALCULATED and STALE both mean the stored score should not be read as a description of the record as it stands. enum: [“UNCALCULATED”, “STALE”, “CURRENT”]
`tableId`	`string`	false	The table the record belongs to.
`unavailableReason`	`string`	false	Localized explanation when the record cannot be measured. Absent when measurement is available; does not contain record values or exception details.
`unavailableReasonKey`	`string`	false	The stable catalogue key ‘unavailableReason’ was rendered from, so the three cases — no data model, a model that will not compile, a measurement that threw — can be told apart without parsing prose. For diagnostics.
`warningCount`	`integer (int32)`	false	How many findings are warnings.

`RecordSourceEntry`

One provenance: the source system, and optionally that system’s own key for the record.

Property	Type	Required	Description
`_src`	`string`	true	The source system this entry names.
`_src_id`	`string or null`	false	That system’s own identifier for the record. Optional: a source that only ever appends — readings, events, a transaction feed — has no key to put there.

`Resource`

Represents a generic Golden resource. Specific resources extend this resource with more specific configuration fields.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type enum: [“classifier-weight”, “credentials”, “data-view”, “dataset”, “indexer”, “merger-weight”, “pipeline”, “sink-http”, “sink-jdbc”, “sink-kafka”, “sink-table”, “source-file”, “source-jdbc”, “source-table”, “steward-bucket”, “transformation”]
`validation`	Validation	false	Current validation result.

Discriminator: type.

classifier-weight: ClassifierWeight
credentials: Credential
data-view: DataView
dataset: Dataset
indexer: Indexer
merger-weight: MergerWeight
pipeline: Pipeline
sink-http: SinkHttp
sink-jdbc: SinkJdbc
sink-kafka: SinkKafka
sink-table: SinkTable
source-file: SourceFile
source-jdbc: SourceJdbc
source-table: SourceTable
steward-bucket: StewardBucket
transformation: Transformation

`ResourceEnumsDto`

The data catalogues the resource editors are filled from.

Property	Type	Required	Description
`allRoles`	array of `string`	false	System and user roles.
`allRolesLabels`	map of `string`	false	System and user roles labels.
`classifiers`	array of `string`	false	Classifiers.
`classifiersLabels`	map of `string`	false	Classifiers and labels.
`credentials`	array of `string`	false	Credentials.
`credentialsLabels`	map of `string`	false	Credentials and labels.
`datasetByTable`	map of `string`	false	Each table’s dataset, table id to dataset id.
`datasetColumns`	map of array of `string`	false	Datasets and columns.
`datasetColumnsLabels`	map of map of `string`	false	Datasets, columns and labels.
`datasetNesting`	map of array of `string`	false	The datasets each dataset nests directly, dataset id to the ids its DATASET columns point at, in column order. Walked transitively by whoever needs every dataset an entity uses; a dataset with no nested column is absent.
`datasets`	array of `string`	false	Datasets.
`datasetsLabels`	map of `string`	false	Datasets and labels.
`entities`	array of `string`	false	Entities.
`entitiesLabels`	map of `string`	false	Entities and labels.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`foreignKeys`	array of `string`	false	Foreign keys.
`foreignKeysLabels`	map of `string`	false	Foreign keys and labels.
`indexerMappings`	map of array of `string`	false	Indexers and mappings.
`indexerMappingsLabels`	map of map of `string`	false	Indexers, mappings and labels.
`indexers`	array of `string`	false	Indexers.
`indexersLabels`	map of `string`	false	Indexers and labels.
`mergers`	array of `string`	false	Mergers.
`mergersLabels`	map of `string`	false	Mergers and labels.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`pipelines`	array of `string`	false	Pipelines.
`pipelinesLabels`	map of `string`	false	Pipelines and labels.
`roles`	array of `string`	false	Roles.
`rolesLabels`	map of `string`	false	Roles and labels.
`sinks`	array of `string`	false	Sinks.
`sinksLabels`	map of `string`	false	Sinks and labels.
`sources`	array of `string`	false	Sources.
`sourcesLabels`	map of `string`	false	Sources and labels.
`stewards`	array of `string`	false	Stewards.
`stewardsLabels`	map of `string`	false	Stewards and labels.
`systemRoles`	array of `string`	false	System roles.
`systemRolesLabels`	map of `string`	false	System roles labels.
`tables`	array of `string`	false	Tables.
`tablesEntitiesResources`	array of `string`	false	Tables, entities and resources.
`tablesEntitiesResourcesLabels`	map of `string`	false	Tables, entities and resources, with labels.
`tablesLabels`	map of `string`	false	Tables and labels.
`transformations`	array of `string`	false	Transformations.
`transformationsLabels`	map of `string`	false	Transformations and labels.
`views`	array of `string`	false	Data-views.
`viewsByDataset`	map of array of `string`	false	Views available per dataset, dataset id to view ids.
`viewsLabels`	map of `string`	false	Data-views and labels.

`ResourceExchangeDto`

Represents an set of resources in exchange format (used for import/export).

Property	Type	Required	Description
`count`	`integer (int32)`	false	Exported resource count.
`resources`	array of one of: ClassifierWeight, Credential, DataView, Dataset, Indexer, MergerWeight, Pipeline, SinkHttp, SinkJdbc, SinkKafka, SinkTable, SourceFile, SourceJdbc, SourceTable, StewardBucket, Transformation	true	Exported resources. minItems: 1
`timestamp`	`integer (int64)`	false	Export timestamp.
`version`	`string`	true	Export version.

`ResourceExportRequestDto`

Represents a request to export resources.

Property	Type	Required	Description
`all`	`boolean`	false	Export all resources flag.
`id`	array of `string`	false	Identifiers to export when all is false. Omit when all is true. minItems: 1

`ResourceExportResponseDto`

Represents a response with exported resources.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`exchange`	ResourceExchangeDto	false	Exported resources.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`ResourceImportRequestDto`

Represents a request to import resources.

Property	Type	Required	Description
`exchange`	ResourceExchangeDto	true	Previously exported resources in JSON format.

`ResourceImportResponseDto`

Represents a response to import resources.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`imported`	`integer (int32)`	false	Total number of imported resources.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`total`	`integer (int32)`	false	Total number of resources.

`ResourceListResponseDto`

Represents a list of resources.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`resources`	array of one of: ClassifierWeight, Credential, DataView, Dataset, Indexer, MergerWeight, Pipeline, SinkHttp, SinkJdbc, SinkKafka, SinkTable, SourceFile, SourceJdbc, SourceTable, StewardBucket, Transformation	true	List of resources.

`ResourceResponseDto`

Represents a resource.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`resource`	one of: ClassifierWeight, Credential, DataView, Dataset, Indexer, MergerWeight, Pipeline, SinkHttp, SinkJdbc, SinkKafka, SinkTable, SourceFile, SourceJdbc, SourceTable, StewardBucket, Transformation	true	Resource.
`test`	Test	false	Resource test result, when requested.
`testInputTypes`	array of `string`	false	Which kinds of input data a test of this resource can run with. The wizard offers the rest disabled: a resource with no dataset cannot resolve records through one.
`testSupported`	`boolean`	false	Whether the resource supports testing.

`ResourceSaveRequestDto`

Represents a resource object in JSON format.

Property	Type	Required	Description
`create`	`boolean`	false	Create flag. If true, the resource will be created if it does not exist. Otherwise, it will be updated. default: false
`resource`	`string`	true	A resource in JSON format.
`test`	`boolean`	false	Test configuration instead of saving. Default is false. default: false
`testOptions`	`string`	false	Test configuration options in JSON format. Ignored if not testing.

`ResourceTransformationSink`

Represents an entity sink in exchange format.

Property	Type	Required	Description
`audit`	`boolean`	false	Flag to include metadata audit when sinking.
`resource`	`string`	false	Resource identifier.
`transformation`	`string`	false	Optional transformation identifier.

`ResourceTransformationSource`

Represents an entity source in exchange format.

Property	Type	Required	Description
`cron`	`string`	false	Cron scheduling expression.
`incremental`	`boolean`	false	Source incremental loading.
`lastExecution`	`string (date-time)`	false	Source last execution.
`resource`	`string`	false	Resource identifier.
`transformation`	`string`	false	Optional transformation identifier.

`RowScopeDto`

A restriction to the rows whose scope column holds one of the values.

Property	Type	Required	Description
`column`	`string`	false	The entity’s scope column this restriction was validated against.
`values`	array of `string`	false	The allowed values. A record is in scope when its column holds any.

`SampleDto`

An installable sample project.

Property	Type	Required	Description
`description`	`string`	false	What the sample demonstrates.
`entity`	`string`	false	The entity the sample installs.
`id`	`string`	false	Identifier, and the directory the sample ships in.
`installed`	`boolean`	false	Whether the sample is currently installed.
`name`	`string`	false	Display name.
`table`	`string`	false	The records table the entity is built on.
`version`	`string`	false	Version of the sample bundle.

`SampleListResponseDto`

The available sample projects.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`samples`	array of SampleDto	false	The samples, in a stable order.

`SampleOperationResponseDto`

The run started by a sample install or remove.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`run`	TzRunView	false	The queued run.
`sampleId`	`string`	false	The sample the task is operating on.

`SampleResponseDto`

A sample project.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`sample`	SampleDto	false	Sample project description.

`ScopeColumnRequestDto`

The column, or null to clear

Property	Type	Required	Description
`column`	`string`	false	The dataset column key, or null to clear.

`ScopeValuesResponseDto`

Distinct values of an entity’s scope column.

Property	Type	Required	Description
`column`	`string`	false	The scope column the values were read from.
`entity`	`string`	false	The entity.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`truncated`	`boolean`	false	True when the cap or the time budget cut the list short.
`values`	array of `string`	false	The distinct values, sorted, capped.

`SearchOptions`

Search options

Property	Type	Required	Description
`combine`	`string`	false	How populated search fields combine: ANY returns records found through any field; ALL requires all populated fields. API default: ANY. The web interface requests ALL. enum: [“ALL”, “ANY”]
`exact`	`string`	false	Exact search type. Default is EXACT. Can not be null. enum: [“EXACT”, “PREFIX”, “SUFFIX”, “INFIX”]; default: “EXACT”
`fieldModes`	map of `string` (enum: [“MAPPING”, “EXACT”, “SIMILAR”])	false	Per-field probe mode, keyed by dataset column. A column absent from this map is probed with its mapping’s own matching type. Only meaningful for the structured search: free text always probes by word similarity.
`fuzzy`	`boolean`	false	Fuzzy search flag. If enabled, the search also considers fuzzy search. Default is true.
`fuzzyMaximumTypos`	`integer (int32)`	false	Fuzzy search maximum number of typographical errors considered during the search. Must be positive (at least 1 typo). Default is 2. minimum: 1
`geo`	`boolean`	false	Geographic search flag. If enabled, the search also considers geographic search. Default is true.
`geoPrecision`	`string`	false	Geographical precision for searching. enum: [“L1”, “L2”, “L3”, “L4”, “L5”, “L6”, “L7”, “L8”, “L9”, “L10”]; default: “L6”
`geoSteps`	`integer (int32)`	false	Steps around center to create a geographical search area. Must be positive. Default is 1. minimum: 1
`identity`	`boolean`	false	Identity search flag. If enabled and record identity is available, the search is done by identity. Default is true.
`maximumDuration`	`string`	false	Maximum duration of the search. Default is 5 seconds.
`maximumResults`	`integer (int32)`	false	Maximum number of search results. Default is -1 (no limits).
`provenance`	`boolean`	false	Provenance search flag. If enabled, a free-text term is also looked up as a source system’s own key for a record (_source._src_id), right after the identifier. Default is true.
`radiusMeters`	`number (double)`	false	Radius in metres for a geographic search. When positive it is used as-is; when zero or negative the radius falls back to geoPrecision, which is what the search did before this field existed. Default is 0 (fall back).

`SinkHttp`

An HTTP sink is a resource that writes records to a remote endpoint URL using a certain method (POST, PUT, PATCH).

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“sink-http”]
`validation`	Validation	false	Current validation result.
`credentials`	`string`	false	The credentials to use for the HTTP(S) call.
`dataset`	`string`	false	The dataset to use.
`method`	`string`	false	The HTTP method to use for the call.
`timeoutMs`	`integer (int32)`	true	The timeout in milliseconds for writing a record. default: 2000; minimum: 1
`url`	`string`	true	The URL of the remote endpoint.

`SinkJdbc`

A JDBC sink is a resource that writes records to a JDBC database.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“sink-jdbc”]
`validation`	Validation	false	Current validation result.
`credentials`	`string`	false	The credentials to use for the JDBC connection.
`dataset`	`string`	false	The dataset to use.
`logicalDelete`	`boolean`	false	Flag to enable logical delete. By default, records are physically deleted.
`operationColumn`	`string`	false	The column to use for logical delete.
`properties`	array of Option	false	The properties to use for the JDBC connection.
`table`	`string`	true	The name of the table to write. Eventually include catalog and schema.
`timeoutMs`	`integer (int32)`	true	The timeout in milliseconds for writing a record. default: 2000; minimum: 1
`url`	`string`	true	The JDBC URL to connect to the database.
`writeIdColumn`	`string`	false	The column to use for writing Golden identifier.
`writeIdFlag`	`boolean`	false	Flag to enable writing Golden identifier. False by default.
`writeTimestampColumn`	`string`	false	The column to use for writing Golden timestamp.
`writeTimestampFlag`	`boolean`	false	Flag to enable writing Golden timestamp. False by default.

`SinkKafka`

A Kafka sink is a resource that writes records to an external Kafka.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“sink-kafka”]
`validation`	Validation	false	Current validation result.
`bootstrapServers`	`string`	true	The list of Kafka brokers to connect to.
`credentials`	`string`	true	The credentials to use for the Kafka producer.
`dataset`	`string`	false	The dataset to use.
`properties`	array of Option	false	The properties to use for the Kafka producer.
`timeoutMs`	`integer (int32)`	true	The timeout in milliseconds for writing a record. default: 2000; minimum: 1
`topicName`	`string`	true	The name of the topic in the Kafka broker.

`SinkTable`

A sink table is a resource that writes records to a Golden table.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“sink-table”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`table`	`string`	true	The name of the table.
`timeoutMs`	`integer (int32)`	true	The timeout in milliseconds for writing a record. default: 2000; minimum: 1

`SourceFile`

A source file is a resource that reads records from a Golden file.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“source-file”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`format`	`string`	true	The format of the file. enum: [“CSV”, “JSON”]
`fromFilter`	`string (date-time)`	false	The from instant filter (optional).
`header`	`boolean`	false	The file has a header (only for CSV).
`ignoreQuotes`	`boolean`	false	Ignore quotes in the file (only for CSV).
`inputPattern`	`string`	true	The pattern of the file name. Supports wildcards.
`separator`	`string`	false	The separator in the file (only for CSV).
`toFilter`	`string (date-time)`	false	The to instant filter (optional).

`SourceJdbc`

A JDBC source is a resource that reads records from a database table using a JDBC connection.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“source-jdbc”]
`validation`	Validation	false	Current validation result.
`count`	`boolean`	false	Flag to enable count query.
`countQueryScript`	`string`	false	The custom count query script to use for reading.
`credentials`	`string`	false	The credentials to use for the JDBC connection.
`customScripts`	`boolean`	false	Flag to enable custom scripts for reading.
`dataset`	`string`	false	The dataset to use.
`fromFilter`	`string (date-time)`	false	The from instant filter (optional).
`properties`	array of Option	false	The properties to use for the JDBC connection.
`queryScript`	`string`	false	The custom query script to use for reading.
`readIdColumn`	`string`	false	The column to use for reading Golden identifier.
`readIdFlag`	`boolean`	false	Flag to enable reading Golden identifier. False by default.
`readTimestampColumn`	`string`	false	The column to use for reading Golden timestamp.
`readTimestampFlag`	`boolean`	false	Flag to enable reading Golden timestamp. False by default.
`table`	`string`	true	The name of the table to read. Eventually include catalog and schema.
`timestampFilteringColumn`	`string`	false	The column to use for timestamp filtering.
`timestampFilteringFlag`	`boolean`	false	Flag to enable timestamp filtering.
`toFilter`	`string (date-time)`	false	The to instant filter (optional).
`url`	`string`	true	The JDBC URL of the database.

`SourceTable`

A table source is a resource that reads records from a Golden table.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“source-table”]
`validation`	Validation	false	Current validation result.
`dataset`	`string`	false	The dataset to use.
`fromFilter`	`string (date-time)`	false	The from instant filter (optional).
`table`	`string`	true	The name of the table.
`toFilter`	`string (date-time)`	false	The to instant filter (optional).

`SsoProviderInfo`

SSO provider configuration

Property	Type	Required	Description
`authorizationEndpoint`	`string`	false	Authorization endpoint URL for OAuth2 flow
`clientId`	`string`	false	OAuth2 client ID
`displayName`	`string`	false	The provider’s name for a login button, in the language of the Accept-Language header. Falls back to the deployment’s display-name property, and then to the identifier, so it is never empty.
`displayNameKey`	`string`	false	Translation key for the provider name, for clients that provide their own translations.
`name`	`string`	false	Provider identifier (e.g., ‘google’, ‘keycloak’). A machine value; never translated.
`scopes`	array of `string`	false	Requested OAuth2 scopes

`StewardBucket`

A steward to automatically curate duplicated buckets.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“steward-bucket”]
`validation`	Validation	false	Current validation result.
`coffeeBreak`	`integer (int32)`	false	The maximum number of items to steward before taking a coffee break. Must be positive. Default is 100.
`entity`	`string`	true	The entity to steward.
`rules`	array of StewardRule	true	The rules to apply to steward the buckets.

`StewardCondition`

A steward condition to apply to the buckets.

Property	Type	Required	Description
`interval`	`string`	false	The type of the interval. Default is MINIMUM. enum: [“MINIMUM”, “MAXIMUM”, “INTERVAL”]
`max`	`number (double)`	false	The maximum value of the interval. Must be greater than or equal to 0 and eventually greater than min. Default is -1 (no limit). Required and non-negative for MAXIMUM or INTERVAL conditions; unused otherwise. default: -1.0
`min`	`number (double)`	false	The minimum value of the interval. Must be greater than or equal to 0. Default is -1 (no limit). Required and non-negative for MINIMUM or INTERVAL conditions; unused otherwise. default: -1.0
`type`	`string`	false	An interval used to check the condition. enum: [“RECORD_COUNT”, “SCORE”, “DEVIATION”]

`StewardFiltering`

A filtering to apply to the buckets.

Property	Type	Required	Description
`classification`	`string`	false	The classification used to filter. Optional. Default is to consider all classifications. enum: [“MATCH”, “NON_MATCH”, “REVIEW”, “IGNORE”]
`index`	`string`	false	The index identifier used to filter. Optional. Default is to consider all indexes.

`StewardRule`

A rule to filter buckets and execute an action.

Property	Type	Required	Description
`action`	`string`	true	The action to execute on the selected buckets. enum: [“MERGE”, “DISCONNECT”, “SPLIT”, “DELETE”, “IGNORE”]
`conditions`	array of StewardCondition	false	The bucket conditions.
`crossSeparations`	`boolean`	false	Only for MERGE. Merge a cluster even though it holds a pair of records recorded as different, revoking that separation; the rule’s own sentence is the comment. Off by default: such a cluster is skipped and counted, never merged.
`description`	`string`	false	The description of the rule.
`filtering`	StewardFiltering	false	The filtering to apply to the buckets.
`id`	`string`	true	The identifier of the rule.
`sorting`	array of `string`	false	The sorting used to filter. Optional. Default is to consider natural sorting.

`TableAuditResponseDto`

A table and the result of switching its audit capability.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`outcome`	`string`	false	What the call did. Enabling is idempotent and repairs missing storage. enum: [“ENABLED”, “REPAIRED”, “ALREADY_IN_ORDER”, “DISABLED”, “ALREADY_DISABLED”]
`table`	TableDto	false	Table.

`TableCreateRequestDto`

Represents a request to create a table.

Property	Type	Required	Description
`auditable`	`boolean`	false	Auditable flag to keep track of changes to each individual record (eg. changed values). Default is false. default: false
`dataset`	`string`	true	Dataset identifier. Must exist. minLength: 1
`description`	`string`	false	Table description
`history`	`boolean`	false	History flag to keep track of changes to records (eg. merged or deleted). Default is false. default: false
`quality`	`boolean`	false	Whether this table is measured for quality. Default is true; set it to false for a table whose quality nobody acts on — a test copy of another table, typically — and it is skipped by the background re-measurement and left out of the quality figures. A table switched off reads as “not measured by choice” on screen, which is a different state from “not measured yet”. default: true
`table`	`string`	true	Table identifier minLength: 1

`TableDatasetResponseDto`

Exported table configuration package.

Property	Type	Required	Description
`datasets`	map of Dataset	false	Map of datasets. Usually it is just one dataset, except if the dataset contains nested datasets.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`TableDto`

Represents a data table.

Property	Type	Required	Description
`aggregateScope`	`string`	false	`size` is computed over the whole table, not over the caller’s data scope. Always ENTITY. enum: [“ENTITY”]
`audit`	`boolean`	false	Table audit flag.
`created`	`string (date-time)`	false	Table creation ISO timestamp.
`dataset`	`string`	false	Table dataset.
`dependency`	Dependency	false	Table dependencies.
`description`	`string`	false	Table description.
`hasIndex`	`boolean`	false	Indicates if this table has an index (entity with type different from NONE).
`history`	`boolean`	false	Table history flag.
`id`	`string`	false	Table identifier.
`locked`	`boolean`	false	Table locked flag.
`qualityEnabled`	`boolean`	false	Whether this table is included in quality measurement and aggregate quality figures. Omission means enabled.
`size`	`integer (int64)`	false	Number of records.
`type`	`string`	false	Table type. enum: [“TABLE”, “HISTORY”]

`TableExchangeDto`

Represents an set of table in exchange format (used for import/export).

Property	Type	Required	Description
`count`	`integer (int32)`	false	Number of exported entities.
`tables`	array of TablePostDto	true	Exported table.
`timestamp`	`integer (int64)`	false	Export timestamp.
`version`	`string`	false	Export version.

`TableExportRequestDto`

Request to transform table data.

Property	Type	Required	Description
`ids`	array of `string`	true	Table identifiers to be exported. minItems: 1

`TableExportResponseDto`

Exported table configuration package.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`exchange`	TableExchangeDto	false	Exported tables.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.

`TableFilter`

Filters for table record queries.

Property	Type	Required	Description
`filterError`	`boolean`	false	Filter records that have quality errors. default: false
`filterQualityGreater`	`integer (int32)`	false	Filter records whose quality score is greater than or equal to this value (0-100). Omit the parameter to apply no lower bound.
`filterQualityLess`	`integer (int32)`	false	Filter records whose quality score is less than or equal to this value (0-100). Omit the parameter to apply no upper bound.
`filterSource`	`string`	false	Filter records whose provenance names this source system. Combined with filterSourceId it matches one provenance entry carrying both, never the two separately.
`filterSourceId`	`string`	false	Filter records whose provenance carries this key. It is the source system’s own identifier for the record, not the record’s _id.
`filterUpdatedAfter`	`string (date-time)`	false	Filter records that have been updated after this ISO 8601 timestamp (included)
`filterUpdatedBefore`	`string (date-time)`	false	Filter records that have been updated before this ISO 8601 timestamp (included)

`TableImportRequestDto`

Represents a request to import tables.

Property	Type	Required	Description
`exchange`	TableExchangeDto	true	Previously exported tables in JSON format.

`TableImportResponseDto`

Represents a response to import tables.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`imported`	`integer (int32)`	false	Total number of imported tables.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`total`	`integer (int32)`	false	Total number of tables.

`TableListResponseDto`

Represents a list of tables.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`tables`	array of TableDto	false	List of tables.

`TableMetadataResponseDto`

The shape of a table: columns, their descriptions and its data-view.

Property	Type	Required	Description
`columnMap`	map of Column	false	Columns by name, with their type and description.
`columns`	array of `string`	false	Column keys, in dataset order.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`table`	TableDto	false	The table, without its row count.
`view`	ViewDto	false	The data-view the table’s owning entity presents its records through, resolved. Null means one of three things, and a caller cannot tell them apart: no entity owns the table, the owning entity chose no view, or the view it chose no longer names the table’s dataset. All three render the way every table did before data-views existed.

`TableOperationExportRequestDto`

Request to transform table data.

Property	Type	Required	Description
`chunkRecords`	`integer (int64)`	false	Chunk sink file into a maximum number of records. Ignored if 0 or negative. Default is 0 (no chunking). default: 0
`maxRecords`	`integer (int32)`	false	Optional maximum number of records to process (use <0 to process all records). Default is -1 (process all source records).
`pipeline`	`string`	false	Optional pipeline identifier. If indicated, the pipeline will be applied after the optional transformation.
`sampleRecords`	`integer (int32)`	false	Optionally use sampling when processing records (use <=0 to avoid sampling). Default is -1 (no sampling).
`source`	`string`	true	Source or table identifier. Must exist. minLength: 1
`transformation`	`string`	false	Optional transformation name. If indicated, the transformation will be applied to the source data after reading from the source.

`TableOperationLoadRequestDto`

Represents a request to load data into a table

Property	Type	Required	Description
`maxRecords`	`integer (int32)`	false	Optional maximum number of records to process (use <0 to process all records). Default is -1 (process all source records).
`operation`	`string`	false	Load operation. Default is INSERT records. enum: [“INSERT”, “UPSERT”, “DELETE”]
`pipeline`	`string`	false	Optional pipeline identifier. If indicated, the pipeline will be applied after the optional transformation.
`sampleRecords`	`integer (int32)`	false	Optionally use sampling when processing records (use <=0 to avoid sampling). Default is -1 (no sampling).
`sinkTable`	`string`	true	Sink table identifier. Must exist. minLength: 1
`source`	`string`	true	Source or table identifier. Must exist. minLength: 1
`transformation`	`string`	false	Optional transformation name. If indicated, the transformation will be applied to the source data after reading from the source.

`TableOperationResponseDto`

Represents a response from a data ETL operation

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`run`	TzRunView	true	The queued run.

`TableOperationTransformRequestDto`

Request to transform table data.

Property	Type	Required	Description
`maxRecords`	`integer (int32)`	false	Optional maximum number of records to process (use <0 to process all records). Default is -1 (process all source records).
`pipeline`	`string`	false	Optional pipeline identifier. If indicated, the pipeline will be applied after the optional transformation.
`sampleRecords`	`integer (int32)`	false	Optionally use sampling when processing records (use <=0 to avoid sampling). Default is -1 (no sampling).
`source`	`string`	true	Source or table identifier. Must exist. minLength: 1
`transformation`	`string`	false	Optional transformation name. If indicated, the transformation will be applied to the source data after reading from the source.

`TablePostDto`

Represents a Golden table in exchange format.

Property	Type	Required	Description
`_id`	`string`	true	Table identifier.
`audit`	`boolean`	false	Table audit flag.
`created`	`string (date-time)`	true	Created instant.
`dataset`	`string`	true	Dataset for this table.
`dependency`	Dependency	false	Table dependencies.
`description`	`string`	false	Table description.
`history`	`boolean`	false	Table history flag.
`lockCount`	`integer (int32)`	false	Table lock count.
`locked`	`boolean`	false	Table lock flag.
`updated`	`string (date-time)`	true	Updated instant.

`TableRecordPageResponseDto`

Represents a page of records in a table

Property	Type	Required	Description
`columnMap`	map of Column	false	Map of columns with detailed information.
`columns`	array of `string`	false	Column names in this page.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`page`	Page	false	Page information.
`records`	array of Record	false	List of records in this page.
`table`	TableDto	false	Table.
`view`	ViewDto	false	The data-view the table’s owning entity presents its records through, resolved. Null means one of three things, and a caller cannot tell them apart: no entity owns the table, the owning entity chose no view, or the view it chose no longer names the table’s dataset. All three render the way every table did before data-views existed.

`TableRecordResponseDto`

Represents one record and optional expanded data.

Property	Type	Required	Description
`columnMap`	map of Column	false	Map of columns with detailed information.
`columnRules`	map of map of ColumnRuleDto	false	Value constraints indexed by dataset identifier and column key. Use these resolved rules when building record forms.
`columns`	array of `string`	false	Basic columns for this record.
`datasets`	map of Dataset	false	Map of datasets.
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`findings`	array of QualityFindingDto	false	The problems the last measurement found, rendered in the request’s language. Absent unless qualityState is CURRENT.
`merged`	array of Record	false	If this record is the result of a merge, these are the original records.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`qualityState`	`string`	false	What this record’s stored quality measurement is worth against the definition its table is currently on. enum: [“UNCALCULATED”, “STALE”, “CURRENT”]
`record`	map of `object`	false	Record itself.
`servedFromOtherTable`	`boolean`	false	True when the record was not in the table type the caller asked for and was served from the other relation instead — a record deleted or superseded in the data table and read out of history, or the reverse. `table` names where it actually came from.
`table`	TableDto	false	Table that owns this record.
`view`	ViewDto	false	The data-view the table’s owning entity presents its records through, resolved. Null means one of three things, and a caller cannot tell them apart: no entity owns the table, the owning entity chose no view, or the view it chose no longer names the table’s dataset. All three render the way every table did before data-views existed.

Fields within record:

Property	Type	Required	Description
`_audit`	array of RecordAudit	false	Reserved audit member. Ordinary record responses omit this field, including expanded responses. Read events through the dedicated record audit endpoint. Requests carrying _audit are refused with 400. readOnly: true
`_id`	`string`	false	—
`_metadata`	RecordMetadata	false	Server-owned metadata: quality, merge pointers, the last write. Read-only; requests must not include this member. readOnly: true
`_search`	map of `object`	false	Search metadata associated to the record, present on a search result. Read-only; requests must not include this member. readOnly: true
`_source`	array of RecordSourceEntry	false	Where the record came from: one entry per system that has contributed to it, with that system’s own key for it. A caller may state this WHEN IT CREATES the record, and never afterwards: an inbound value on an update is refused with a 400. The engine adds to it — a load that reincorporates the record from a second system, a merge that unions what it absorbs — and nothing ever removes an entry. When a data set declares which source systems it accepts, a value outside that list is refused.

Additional properties: object.

Fields within _search:

Property	Type	Required	Description
`exact`	`boolean`	false	True when the match is exact. Decided by the engine, not by the score.
`index`	`string`	false	Index that found this search result.
`match`	`string`	false	Matched text.
`origin`	`string`	false	How this result was reached, which is not what matched it. enum: [“DIRECT”, “CLUSTER”, “HISTORY”, “MERGED_FORWARD”]
`rank`	`number (double)`	false	Search rank.
`sourceId`	`string`	false	The record this result was reached through, when that is not the record itself: the absorbed record for a merged-forward hit. Null otherwise.
`type`	`string`	false	Search type. enum: [“ID”, “SOURCE”, “EXACT”, “PREFIX”, “SUFFIX”, “INFIX”, “FUZZY”, “FUZZY_LSH”, “GEOGRAPHIC”, “NONE”]

Additional properties: object.

`TableResponseDto`

Represents a table.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`table`	TableDto	false	Table.

`Test`

Test helper object to store (eventually formatted) messages and errors.

Property	Type	Required	Description
`duration`	`string`	false	Test duration. Contains the duration of the test as ISO 8601 string.
`errorCount`	`integer (int32)`	false	Test error count. Contains the number of errors in the test.
`format`	`string`	false	Test payload format. Indicates the format of the payload. enum: [“PLAIN”, “HTML”]
`options`	map of any JSON value	false	Test options. Contains the options used for the test.
`payload`	`string`	false	Test payload. Contains the formatted messages and errors.
`result`	`string`	false	Test result. Indicates the result of the test. enum: [“OK”, “ERROR”, “WARNING”, “NOT_SUPPORTED”]
`timeEnd`	`string (date-time)`	false	Test end time. Contains the end time of the test as ISO 8601 string.
`timeStart`	`string (date-time)`	false	Test start time. Contains the start time of the test as ISO 8601 string.
`warningCount`	`integer (int32)`	false	Test warning count. Contains the number of warnings in the test.

Fields within options:

Property	Type	Required	Description
`empty`	`boolean`	false	—

Additional properties: any JSON value.

`Transformation`

A transformation is a resource that maps data from a source dataset to a target dataset.

Composition: all of: Resource, object.

Property	Type	Required	Description
`_id`	`string`	true	Resource identifier
`category`	`string`	false	Functional category of the resource.
`dependency`	Dependency	false	Resources and objects related by configuration dependencies.
`description`	`string`	true	Resource description
`id`	`string`	false	Alternative input identifier; use _id in resource definitions. writeOnly: true
`lastUpdated`	`string (date-time)`	false	Last update timestamp
`lockCount`	`integer (int32)`	false	Resource lock count. Resource unlocked only if count is zero.
`locked`	`boolean`	false	Locking flag to indicate if resource can be modified
`type`	`string`	true	Resource type. enum: [“transformation”]
`validation`	Validation	false	Current validation result.
`carryOverData`	`boolean`	false	Carry over (copy) data from source to target.
`carryOverMetadata`	`boolean`	false	Carry over (copy) metadata from source to target.
`mappings`	array of TransformationMapping	true	The transformation mappings.
`script`	`string`	false	Optional transformation script.
`source`	`string`	true	The source dataset identifier.
`target`	`string`	true	The target dataset identifier.
`transformationType`	`string`	false	The transformation type. enum: [“MAPPINGS”, “SCRIPT”]

`TransformationMapping`

A transformation mapping is a mapping between columns of two datasets.

Property	Type	Required	Description
`constant`	`string`	false	The constant value used as source.
`delimiter`	`string`	false	The delimiter used to concatenate source columns. By default, a space.
`description`	`string`	false	The description of the transformation mapping.
`id`	`string`	false	The identifier of the transformation mapping.
`mappingType`	`string`	false	The type of transformation mapping. enum: [“COLUMN”, “CONSTANT”]
`source`	array of `string`	false	The source columns of the transformation mapping.
`target`	array of `string`	false	The target columns of the transformation mapping.

`TzAuthRequestDto`

Authentication request

Property	Type	Required	Description
`email`	`string (email)`	true	User email minLength: 1
`password`	`string`	false	Password (in clear text) for user/password authentication
`token`	`string`	false	Token for OAuth2/SSO authentication

`TzAuthResponseDto`

Authentication response

Property	Type	Required	Description
`email`	`string`	false	User email
`errors`	array of `string`	false	Errors. Present when the request was refused
`id`	`string`	false	Unique principal identifier
`messages`	array of `string`	false	Informational messages. Present on a successful response
`name`	`string`	false	Display name
`refreshToken`	`string`	false	Refresh token for obtaining new JWT
`roles`	array of `string`	false	Roles assigned uniqueItems: true
`token`	`string`	false	Bearer token (JWT)
`type`	`string`	false	Principal type. A machine value; never translated. enum: [“NONE”, “INTERNAL”, “SSO”, “TOKEN”]
`typeLabel`	`string`	false	The authentication type in the language of the Accept-Language header
`typeLabelKey`	`string`	false	The bundle key typeLabel was rendered from, for a client that would rather translate it itself

`TzChainView`

Retry chain for a run.

Property	Type	Required	Description
`attempts`	array of TzRunSummary	false	Attempts in the retry chain.
`requestedRunId`	`string (uuid)`	false	Run whose retry chain was requested.
`rootRunId`	`string (uuid)`	false	First run in this retry chain.

`TzDefinitionRequest`

Complete editable scheduling definition.

Property	Type	Required	Description
`cronExpression`	`string`	false	Quartz cron expression used when scheduleKind is CRON.
`description`	`string`	false	Human-readable description.
`enabled`	`boolean`	false	Whether the definition is enabled for scheduled execution.
`intervalSeconds`	`integer (int64)`	false	Interval between scheduled starts, in seconds, for INTERVAL schedules.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`maxAttempts`	`integer (int32)`	false	Maximum number of attempts, including the first attempt.
`maxDuration`	`string`	false	Maximum permitted duration of one attempt.
`misfirePolicy`	`string`	false	Handling of a missed scheduled start: FIRE_ONCE starts once and advances to the next occurrence; SKIP advances without running the missed occurrence. enum: [“FIRE_ONCE”, “SKIP”]
`name`	`string`	false	Human-readable definition name.
`overlapPolicy`	`string`	false	Handling when the definition already has a live run: SKIP skips this occurrence; ALLOW permits overlap. enum: [“SKIP”, “ALLOW”]
`rawInput`	`string`	false	Job input encoded as a JSON string, not as a nested JSON object.
`retryBackoff`	`string`	false	Initial delay before retrying a failed attempt.
`retryMaxBackoff`	`string`	false	Upper limit for retry delay.
`runAt`	`string (date-time)`	false	Scheduled instant for a ONCE definition.
`scheduleKind`	`string`	false	Scheduling mode: CRON, fixed INTERVAL, ONCE, or MANUAL. enum: [“CRON”, “INTERVAL”, “ONCE”, “MANUAL”]
`timeZone`	`string`	false	Time zone used to evaluate the schedule.
`validFrom`	`string (date-time)`	false	Start of the scheduling validity window.
`validUntil`	`string (date-time)`	false	End of the scheduling validity window.

`TzDefinitionResponse`

Scheduling definition and current scheduling state.

Property	Type	Required	Description
`code`	`string`	false	Stable identifier of a product-provided definition.
`createdAt`	`string (date-time)`	false	Creation timestamp.
`cronExpression`	`string`	false	Quartz cron expression used when scheduleKind is CRON.
`customized`	`boolean`	false	Whether the product-provided definition has customer modifications.
`description`	`string`	false	Human-readable description.
`enabled`	`boolean`	false	Whether the definition is enabled for scheduled execution.
`id`	`string (uuid)`	false	Identifier of this object.
`inertReason`	`string`	false	Reason the definition cannot currently schedule work, when applicable. enum: [“ORPHANED”, “WINDOW_INVERTED”, “WINDOW_EXPIRED”, “MANUAL”, “ONCE_CONSUMED”, “ONCE_IN_THE_PAST”, “ZONE_UNKNOWN”, “NO_OCCURRENCE_IN_WINDOW”, “NO_NEXT_OCCURRENCE”]
`intervalSeconds`	`integer (int64)`	false	Interval between scheduled starts, in seconds, for INTERVAL schedules.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`lastRunAt`	`string (date-time)`	false	Most recent recorded run time.
`maxAttempts`	`integer (int32)`	false	Maximum number of attempts, including the first attempt.
`maxDuration`	`string`	false	Maximum permitted duration of one attempt.
`misfirePolicy`	`string`	false	Handling of a missed scheduled start: FIRE_ONCE starts once and advances to the next occurrence; SKIP advances without running the missed occurrence. enum: [“FIRE_ONCE”, “SKIP”]
`name`	`string`	false	Human-readable definition name.
`nextRunAt`	`string (date-time)`	false	Next scheduled run time, when available.
`orphanedAt`	`string (date-time)`	false	Time the definition lost its registered job type, when applicable.
`overlapPolicy`	`string`	false	Handling when the definition already has a live run: SKIP skips this occurrence; ALLOW permits overlap. enum: [“SKIP”, “ALLOW”]
`owner`	`string`	false	Principal recorded as the owner.
`rawInput`	`string`	false	Job input encoded as a JSON string, not as a nested JSON object.
`retryBackoff`	`string`	false	Initial delay before retrying a failed attempt.
`retryMaxBackoff`	`string`	false	Upper limit for retry delay.
`runAt`	`string (date-time)`	false	Scheduled instant for a ONCE definition.
`scheduleKind`	`string`	false	Scheduling mode: CRON, fixed INTERVAL, ONCE, or MANUAL. enum: [“CRON”, “INTERVAL”, “ONCE”, “MANUAL”]
`skipStreakCount`	`integer (int32)`	false	Number of consecutive skipped scheduled occurrences.
`source`	`string`	false	Origin of the definition. enum: [“DECLARED”, “API”]
`timeZone`	`string`	false	Time zone used to evaluate the schedule.
`updatedAt`	`string (date-time)`	false	Last modification timestamp.
`validFrom`	`string (date-time)`	false	Start of the scheduling validity window.
`validUntil`	`string (date-time)`	false	End of the scheduling validity window.
`version`	`integer (int64)`	false	Version used for concurrent modification control.

`TzDefinitionRunResponse`

Identifier of a requested execution.

Property	Type	Required	Description
`runId`	`string (uuid)`	false	Identifier of the created run.

`TzEnabledRequest`

Change to the enabled state of a definition.

Property	Type	Required	Description
`enabled`	`boolean`	false	Whether the definition is enabled for scheduled execution.

`TzNextRunsResponse`

Preview of upcoming scheduled instants.

Property	Type	Required	Description
`nextRuns`	array of `string (date-time)`	false	Upcoming execution instants for the schedule.

`TzPageTzDefinitionResponse`

Page of scheduling definitions.

Property	Type	Required	Description
`content`	array of TzDefinitionResponse	false	Items in this result page.
`page`	`integer (int32)`	false	Zero-based page number.
`size`	`integer (int32)`	false	Requested page size.
`totalElements`	`integer (int64)`	false	Total number of matching items.

`TzPageTzRunSummary`

Page of run summaries, without input and output payloads.

Property	Type	Required	Description
`content`	array of TzRunSummary	false	Items in this result page.
`page`	`integer (int32)`	false	Zero-based page number.
`size`	`integer (int32)`	false	Requested page size.
`totalElements`	`integer (int64)`	false	Total number of matching items.

`TzPasswordUpdateRequestDto`

Password update request

Property	Type	Required	Description
`password`	`string`	true	New password (clear text) minLength: 8
`token`	`string`	true	Unique reset token (previously provided). Unless this token is valid, the password will not be updated.

`TzRefreshRequestDto`

Token refresh request

Property	Type	Required	Description
`refreshToken`	`string`	true	Refresh token minLength: 1

`TzRefreshResponseDto`

Token refresh response

Property	Type	Required	Description
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`refreshToken`	`string`	false	New refresh token
`token`	`string`	false	New JWT token

`TzRoleDto`

An available role

Property	Type	Required	Description
`description`	`string`	false	Role description, in the language of the request’s Accept-Language header
`descriptionKey`	`string`	false	The bundle key the description was rendered from, for a client that would rather translate it itself. Null when the application supplied a literal description.
`role`	`string`	false	Role identifier. A machine value; never translated.

`TzRunCancelRequest`

Cancellation request.

Property	Type	Required	Description
`reason`	`string`	false	Reason supplied for cancellation.

`TzRunDeleteRequest`

Run deletion request.

Property	Type	Required	Description
`runIds`	array of `string (uuid)`	false	Identifiers of runs to delete.

`TzRunNowRequest`

Request to run a definition immediately.

Property	Type	Required	Description
`overrideInput`	`boolean`	false	Whether rawInput replaces the definition input for this run.
`rawInput`	`string`	false	Job input encoded as a JSON string, not as a nested JSON object.

`TzRunSubmitRequest`

Request for a one-off run.

Property	Type	Required	Description
`description`	`string`	false	Human-readable description.
`idempotencyKey`	`string`	false	Caller-supplied key used to avoid duplicate submissions within its validity period.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`maxAttempts`	`integer (int32)`	false	Maximum number of attempts, including the first attempt.
`maxDuration`	`string`	false	Maximum permitted duration of one attempt.
`rawInput`	`string`	false	Job input encoded as a JSON string, not as a nested JSON object.
`retryBackoff`	`string`	false	Initial delay before retrying a failed attempt.
`retryMaxBackoff`	`string`	false	Upper limit for retry delay.
`scheduledAt`	`string (date-time)`	false	Instant at which the run is eligible to start.

`TzRunSummary`

Run status without input and output payloads.

Property	Type	Required	Description
`attempt`	`integer (int32)`	false	Attempt number within the retry chain.
`cancelForced`	`boolean`	false	Whether cancellation was forced.
`cancelReason`	`string`	false	Recorded cancellation reason.
`cancelRequestedAt`	`string (date-time)`	false	Time cancellation was requested.
`createdAt`	`string (date-time)`	false	Creation timestamp.
`definitionId`	`string (uuid)`	false	Definition that created this run, when applicable.
`description`	`string`	false	Human-readable description.
`errorMessage`	`string`	false	Reported failure message, when present.
`errorType`	`string`	false	Classification of the reported failure. enum: [“INPUT_INVALID”, “TYPE_UNKNOWN”, “PRINCIPAL_UNKNOWN”, “INFRASTRUCTURE_UNAVAILABLE”, “JOB_FAILED”, “JOB_FAILED_PERMANENT”, “OUTPUT_INVALID”, “TIMEOUT”, “PROCESS_INTERRUPTED”]
`fencedBy`	`string`	false	Reason or actor that closed a run that did not finish on its own. enum: [“REAPER”, “TIMEOUT”, “SHUTDOWN”, “CANCEL”]
`finishedAt`	`string (date-time)`	false	Time the run finished.
`id`	`string (uuid)`	false	Identifier of this object.
`idempotencyExpiresAt`	`string (date-time)`	false	Expiration time of the submission idempotency key.
`idempotencyKey`	`string`	false	Caller-supplied key used to avoid duplicate submissions within its validity period.
`identity`	`string`	false	Job-specific identity of this input, when the job type defines one.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`maxAttempts`	`integer (int32)`	false	Maximum number of attempts, including the first attempt.
`maxDuration`	`string`	false	Maximum permitted duration of one attempt.
`message`	`string`	false	Latest reported progress or status message.
`owner`	`string`	false	Principal recorded as the owner.
`previousRunId`	`string (uuid)`	false	Previous attempt in this retry chain, when present.
`progress`	`number (double)`	false	Progress reported by the job.
`retryBackoff`	`string`	false	Initial delay before retrying a failed attempt.
`retryMaxBackoff`	`string`	false	Upper limit for retry delay.
`rootRunId`	`string (uuid)`	false	First run in this retry chain.
`scheduleKind`	`string`	false	Scheduling mode: CRON, fixed INTERVAL, ONCE, or MANUAL. enum: [“CRON”, “INTERVAL”, “ONCE”, “MANUAL”]
`scheduledAt`	`string (date-time)`	false	Instant at which the run is eligible to start.
`skipReason`	`string`	false	Reason execution was skipped.
`startedAt`	`string (date-time)`	false	Time execution started.
`status`	`string`	false	Current run status. enum: [“PENDING”, “RUNNING”, “CANCELLING”, “SUCCEEDED”, “FAILED”, “CANCELLED”, “SKIPPED”]
`trigger`	`string`	false	How the run was started. enum: [“SCHEDULED”, “MANUAL”, “API”, “RETRY”]

`TzRunView`

Run status, execution policy, and stored payloads.

Property	Type	Required	Description
`attempt`	`integer (int32)`	false	Attempt number within the retry chain.
`cancelForced`	`boolean`	false	Whether cancellation was forced.
`cancelReason`	`string`	false	Recorded cancellation reason.
`cancelRequestedAt`	`string (date-time)`	false	Time cancellation was requested.
`createdAt`	`string (date-time)`	false	Creation timestamp.
`definitionId`	`string (uuid)`	false	Definition that created this run, when applicable.
`description`	`string`	false	Human-readable description.
`errorMessage`	`string`	false	Reported failure message, when present.
`errorType`	`string`	false	Classification of the reported failure. enum: [“INPUT_INVALID”, “TYPE_UNKNOWN”, “PRINCIPAL_UNKNOWN”, “INFRASTRUCTURE_UNAVAILABLE”, “JOB_FAILED”, “JOB_FAILED_PERMANENT”, “OUTPUT_INVALID”, “TIMEOUT”, “PROCESS_INTERRUPTED”]
`fencedBy`	`string`	false	Reason or actor that closed a run that did not finish on its own. enum: [“REAPER”, “TIMEOUT”, “SHUTDOWN”, “CANCEL”]
`finishedAt`	`string (date-time)`	false	Time the run finished.
`id`	`string (uuid)`	false	Identifier of this object.
`idempotencyExpiresAt`	`string (date-time)`	false	Expiration time of the submission idempotency key.
`idempotencyKey`	`string`	false	Caller-supplied key used to avoid duplicate submissions within its validity period.
`identity`	`string`	false	Job-specific identity of this input, when the job type defines one.
`input`	`string`	false	Stored job input as a JSON string.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`maxAttempts`	`integer (int32)`	false	Maximum number of attempts, including the first attempt.
`maxDuration`	`string`	false	Maximum permitted duration of one attempt.
`message`	`string`	false	Latest reported progress or status message.
`output`	`string`	false	Stored job result as a JSON string.
`owner`	`string`	false	Principal recorded as the owner.
`previousRunId`	`string (uuid)`	false	Previous attempt in this retry chain, when present.
`progress`	`number (double)`	false	Progress reported by the job.
`retryBackoff`	`string`	false	Initial delay before retrying a failed attempt.
`retryMaxBackoff`	`string`	false	Upper limit for retry delay.
`rootRunId`	`string (uuid)`	false	First run in this retry chain.
`scheduleKind`	`string`	false	Scheduling mode: CRON, fixed INTERVAL, ONCE, or MANUAL. enum: [“CRON”, “INTERVAL”, “ONCE”, “MANUAL”]
`scheduledAt`	`string (date-time)`	false	Instant at which the run is eligible to start.
`skipReason`	`string`	false	Reason execution was skipped.
`startedAt`	`string (date-time)`	false	Time execution started.
`status`	`string`	false	Current run status. enum: [“PENDING”, “RUNNING”, “CANCELLING”, “SUCCEEDED”, “FAILED”, “CANCELLED”, “SKIPPED”]
`trigger`	`string`	false	How the run was started. enum: [“SCHEDULED”, “MANUAL”, “API”, “RETRY”]

`TzSetPasswordRequestDto`

Set another user’s password

Property	Type	Required	Description
`password`	`string`	true	The new password (clear text). Must satisfy the deployment’s policy. minLength: 8

`TzSsoConfigResponseDto`

SSO configuration for frontend OAuth integration

Property	Type	Required	Description
`enabled`	`boolean`	false	Whether SSO authentication is enabled
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`providers`	array of SsoProviderInfo	false	Available SSO providers

`TzTokenCreateRequestDto`

Token creation request

Property	Type	Required	Description
`expiryDays`	`integer (int64)`	false	Number of days until expiry default: 365; minimum: 1; maximum: 3650
`name`	`string`	true	Token name minLength: 1; maxLength: 255
`roles`	array of `string`	true	Roles granted to this token minItems: 1; uniqueItems: true

`TzTokenDto`

Represents an access token

Property	Type	Required	Description
`created`	`string (date-time)`	false	Creation timestamp
`enabled`	`boolean`	false	Token enabled flag default: false
`expiresAt`	`string (date-time)`	false	Expiration timestamp
`id`	`string`	false	Token identifier
`name`	`string`	false	Token name
`roles`	array of `string`	false	Roles granted to this token uniqueItems: true
`token`	`string`	false	The secret. Only populated by the create and rotate operations.

`TzTokenListResponseDto`

Token list response

Property	Type	Required	Description
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`roles`	array of TzRoleDto	false	List of available roles, described in the request’s language
`tokens`	array of TzTokenDto	false	List of tokens

`TzTokenResponseDto`

Token response

Property	Type	Required	Description
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`token`	TzTokenDto	false	Token data

`TzTokenRotateRequestDto`

Token rotation request

Property	Type	Required	Description
`expiryDays`	`integer (int64)`	true	Days until the new secret expires, counted from now. Required. minimum: 1; maximum: 3650

`TzTokenUpdateRequestDto`

Token update request

Property	Type	Required	Description
`expiryDays`	`integer (int64)`	false	Number of days until expiry, counted from now default: 365; minimum: 1; maximum: 3650
`name`	`string`	true	Token name minLength: 1; maxLength: 255
`roles`	array of `string`	true	Roles granted to this token minItems: 1; uniqueItems: true

`TzTypeResponse`

Registered job type and concurrency limit.

Property	Type	Required	Description
`description`	`string`	false	Human-readable description.
`jobType`	`string`	false	Registered job type identifier. Use the job types operation to list supported values.
`maxConcurrent`	`integer (int32)`	false	Maximum concurrent executions for this job type.

`TzTypesResponse`

Registered job types.

Property	Type	Required	Description
`types`	array of TzTypeResponse	false	Registered job types.

`TzUserCreateRequestDto`

User creation request

Property	Type	Required	Description
`email`	`string (email)`	true	User email (must be unique)
`internal`	`boolean`	false	Flag to indicate if user is internal or external (Single Sign-On) default: true
`language`	`string`	false	Optional user language as a BCP 47 tag (for example es or en-GB) default: “en”
`name`	`string`	true	User name minLength: 1
`roles`	array of `string`	true	User roles uniqueItems: true
`surname`	`string`	true	User surname(s) minLength: 1
`timeZone`	`string`	false	Optional user time zone as an IANA id or ISO-8601 UTC offset default: “Europe/Madrid”

`TzUserDto`

Represents a user

Property	Type	Required	Description
`attributes`	map of `string`	false	Product-owned settings for this account, as opaque string values under namespaced keys. Empty when nothing is stored
`email`	`string (email)`	true	User email. Must be unique.
`enabled`	`boolean`	false	User enabled flag default: false
`id`	`string`	false	User identifier
`internal`	`boolean`	false	Flag to indicate if user is internal or external (Single Sign-On) default: true
`language`	`string`	false	User language as a BCP 47 tag. Independent of Security’s i18n languages
`lastAccess`	`string (date-time)`	false	Last successful login as ISO timestamp
`locked`	`boolean`	false	User locked flag default: false
`name`	`string`	false	User name
`roles`	array of `string`	true	Roles assigned to this user uniqueItems: true
`surname`	`string`	false	User surname(s)
`timeZone`	`string`	false	User time zone as an IANA id or ISO-8601 UTC offset
`totalFailedAccesses`	`integer (int32)`	false	Total number of failed login attempts since last successful login

`TzUserListResponseDto`

User list response

Property	Type	Required	Description
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`roles`	array of TzRoleDto	false	List of available roles, described in the request’s language
`users`	array of TzUserDto	false	List of users

`TzUserResponseDto`

User response

Property	Type	Required	Description
`errors`	array of `string`	false	Errors. Present when the request was refused
`messages`	array of `string`	false	Informational messages. Present on a successful response
`user`	TzUserDto	false	User data

`TzUserUpdateRequestDto`

User update request

Property	Type	Required	Description
`attributes`	map of `string`	false	Optional patch over this account’s product-owned settings. Omit it to preserve them all; map a key to null to remove that key. Keys are namespaced, lowercase and dot-separated
`email`	`string (email)`	true	User email (must be unique)
`enabled`	`boolean`	true	User enabled flag. Required: this request replaces the whole user
`internal`	`boolean`	true	Whether the user authenticates with a password (true) or through SSO (false). Required: this request replaces the whole user
`language`	`string`	false	Optional user language as a BCP 47 tag (for example es or en-GB). Omit it to preserve the stored value
`name`	`string`	true	User name minLength: 1
`roles`	array of `string`	true	User roles. Required: this request replaces the whole user minItems: 1; uniqueItems: true
`surname`	`string`	true	User surname(s) minLength: 1
`timeZone`	`string`	false	Optional user time zone as an IANA id or ISO-8601 UTC offset. Omit it to preserve the stored value

`Validation`

Configuration validation result.

Property	Type	Required	Description
`errorCount`	`integer (int32)`	false	Number of validation errors.
`errors`	array of `string`	false	Validation error messages.

`ViewColumnDto`

A resolved data-view column.

Property	Type	Required	Description
`align`	`string`	false	How a list cell aligns its content: LEFT, RIGHT or CENTER.
`children`	array of ViewColumnDto	false	Layout of the fields inside a nested dataset. Empty when the view says nothing, which lays the nested columns out in dataset order.
`column`	Column	false	The dataset column, or a synthetic one for a pseudo-column. Never null.
`datasetView`	ViewDto	false	The nested dataset’s own resolved view when the entity names one; null otherwise. Already folded into itemTitle, summary and children; carried whole for a consumer that draws a nested item as a record, and recursively for its own nested columns.
`expression`	`string`	false	A list column’s authored expression, evaluated once per row to produce the cell. Set only on a column that has no dataset column of its own: the two are mutually exclusive. Null on every ordinary column, which reads its value from the record by path.
`format`	`string`	false	How a list cell draws its value: LINK, BADGE, MONO or TEXT.
`itemTitle`	`string`	false	Expression naming one entry of a nested dataset. Null names it by the nested dataset’s identity columns, which is what every nested item was named by before the view could say.
`key`	`string`	false	How the view names the column.
`label`	`string`	false	Label override, or null to use the column’s own description.
`newline`	`boolean`	false	Whether the row breaks after this field.
`path`	`string`	false	Where the value is read from in the record. The key itself for an ordinary column; a metadata path for a pseudo-column such as _quality.
`render`	`string`	false	How an array is edited. Null where arrays do not apply. enum: [“DEFAULT”, “TABLE”, “TABS”, “TABS_TOP”, “GRID”]
`summary`	ViewSummary	false	How a collection collapses into one cell. Null when not a collection.
`truncate`	`integer (int32)`	false	How many characters a list cell shows before it is cut short. Null for no limit.
`width`	`integer (int32)`	false	Width in grid columns, 1 to 12. Resolved: never inherit, never absent.
`widthPercent`	`integer (int32)`	false	A table column’s width, as a percentage (1-100) of the table – never a grid column. Null means auto: the browser’s own sizing. Only set on a list column; a form field leaves this null.

`ViewDto`

A data-view resolved against its dataset.

Property	Type	Required	Description
`columns`	array of ViewColumnDto	false	Columns the record list shows, in order.
`dataset`	`string`	false	The dataset this view presents. A nested column’s datasetView names the nested dataset, which is how a consumer tells whose records an item is.
`diagnostics`	array of `string`	false	What the resolution had to drop, and why.
`id`	`string`	false	The data-view this was resolved from. Null for a draft resolved unsaved.
`sections`	array of ViewSectionDto	false	The record form’s sections, in order.
`title`	`string`	false	Expression that names a record, already resolved: the authored one, or one built from the dataset’s title columns, its identity or the record id. Never blank, so a consumer renders it without a fallback of its own.

`ViewForm`

Record form presentation for a data-view.

Property	Type	Required	Description
`render`	array of ColumnRender	false	Array-editor override per applicable column.
`sections`	array of ViewFormSection	false	Form sections, in order.

`ViewFormField`

How one field is laid out in the record form.

Property	Type	Required	Description
`column`	`string`	false	The dataset column this field shows.
`fields`	array of ViewFormField	false	Layout of the fields inside a nested dataset. Null lays them out flat.
`itemTitle`	`string`	false	Mustache template naming ONE ENTRY of a nested dataset, e.g. “{{via}}, {{ciudad}}”, in one language. Null names it by the nested dataset’s identity columns, which is what it did before this field existed. Only meaningful on a nested-dataset column. The other languages, when there are any, are in itemTitleLocalized.
`itemTitleLocalized`	array of LocalizedTextEntry	false	Every language this item title was written in.
`label`	`string`	false	Label override, as literal text in one language. Null uses the column’s own description. It is not a template: a label names a field, not a record. The other languages, when there are any, are in labelLocalized.
`labelLocalized`	array of LocalizedTextEntry	false	Every language this label was written in.
`newline`	`boolean or null`	false	Break the row after this field. Null inherits the column’s own UI hint.
`render`	`string or null`	false	How a collection is rendered: DEFAULT, TABLE, TABS, TABS_TOP or GRID. Null inherits.
`width`	`integer or null (int32)`	false	Width in grid columns, 1 to 12. Null inherits the column’s own UI hint.

`ViewFormSection`

A labelled section of fields in the record form.

Property	Type	Required	Description
`collapsed`	`boolean or null`	false	Accepted and ignored: a section always renders open.
`columns`	array of ViewFormField	false	Fields in this section, in order.
`frame`	`string or null`	false	The edge the form draws around this section: NONE, RULE_ABOVE, RULE_BELOW or BOX. Null draws nothing.
`label`	`string`	false	The heading shown above this group of fields, as literal text in one language. It is not a template: a section names a group of fields, not a record. The other languages, when there are any, are in labelLocalized.
`labelLocalized`	array of LocalizedTextEntry	false	Every language this heading was written in.
`newline`	`boolean or null`	false	Start this section on a new row. Null lets it flow beside the previous one.
`width`	`integer or null (int32)`	false	Width in grid columns, 1 to 12. Null means the full width.

`ViewList`

Record list presentation for a data-view.

Property	Type	Required	Description
`columns`	array of ViewListColumn	false	Ordered columns the list shows.
`summaries`	array of ColumnSummary	false	Summary per collection or nested-dataset column.

`ViewListColumn`

Presentation of one record-list column.

Property	Type	Required	Description
`align`	`string`	false	Alignment of the list column.
`column`	`string`	false	Dataset column key.
`expression`	`string`	false	Display expression in the base language.
`expressionLocalized`	array of LocalizedTextEntry	false	Translated display expressions by language.
`format`	`string`	false	Value display format.
`label`	`string`	false	Column heading in the base language.
`labelLocalized`	array of LocalizedTextEntry	false	Translated headings by language.
`truncate`	`integer (int32)`	false	Maximum displayed character count before truncation.
`widthPercent`	`integer (int32)`	false	Preferred column width as a percentage.

`ViewResolveResponseDto`

A data-view draft resolved against its dataset.

Property	Type	Required	Description
`errors`	array of `string` or `null`	false	List of errors. If HTTP response represents an error (4xx or 5xx) this will contain a list of errors. Otherwise, not present.
`messages`	array of `string` or `null`	false	Optional informational messages. If present, the request was successful and response code will be 2xx.
`view`	ViewDto	false	The resolved view. Null when the draft is not a data-view.

`ViewSectionDto`

A resolved data-view form section.

Property	Type	Required	Description
`collapsed`	`boolean`	false	Accepted and ignored: a section always renders open.
`columns`	array of ViewColumnDto	false	The section’s columns, in order.
`frame`	`string`	false	Section border style. Resolves to NONE when unspecified.
`label`	`string`	false	Section label. Null for the catch-all section holding every column.
`newline`	`boolean`	false	Whether this section starts a new row rather than flowing beside.
`width`	`integer (int32)`	false	Width in grid columns, 1 to 12. Resolved: never inherit, never absent.

`ViewSummary`

Summary rendering for a collection or nested-dataset column.

Property	Type	Required	Description
`max`	`integer or null (int32)`	false	How many items before the rest become ‘+N more’. Null means the default.
`mode`	`string`	false	Summary mode: TEMPLATE, COUNT, or LIST.
`separator`	`string or null`	false	Separator between LIST items in the base language; null uses a comma followed by a space. Other translations appear in separatorLocalized.
`separatorLocalized`	array of LocalizedTextEntry	false	Every language this separator was written in.
`template`	`string`	false	Mustache template for one item, for example {{street}}, {{city}}. Other translations appear in templateLocalized.
`templateLocalized`	array of LocalizedTextEntry	false	Every language this template was written in.