Replicated Dataset Fields Resource

Retrieves a list of fields for the specified connected object.

Resource URL

1/wave/replicatedDatasets/<Id>/fields

Formats

JSON

Available Version

37.0

Available Components

HTTP Methods

GET PATCH

GET Response Body (ReplicatedFieldCollectionRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`fields`	ReplicatedFieldRepresentation[]	A list of fields belonging to the connected object.	Small, 37.0	37.0
`replicatedDataset`	AssetReferenceRepresentation	A reference to the replicated dataset that the fields belong to.	Small, 53.0	53.0
`url`	String	URL to get the collection.	Small, 37.0	37.0

ReplicatedFieldRepresentation

ReplicatedFieldRepresentation inherits properties from the abstract AbstractFieldRepresentation. These base properties appear in ReplicatedFieldRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`skipped`	Boolean	If set to `true`, this field isn’t synced, but the field metadata can still be stored and retrieved.	Small, 37.0	37.0

PATCH Request Body

Property Name	Type	Description	Required or Optional	Available Version
`replicatedFields`	ReplicatedFieldCollectionInputRepresentation[]	The collection of field configurations.	Required	37.0

ReplicatedFieldCollectionInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`fields`	ReplicatedFieldInputRepresentation[]	The list of field configurations.	Required	37.0

ReplicatedFieldInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`defaultValue`	Object	An optional default value.	Optional	37.0
`description`	String	A long-form description of the field.	Optional	37.0
`fieldType`	ConnectWaveFieldTypeEnum	The type of the field. Valid values are: `Date` `Numeric` `Text` When Analytics custom time zone support is enabled, use `DateTime` or `DateOnly` instead of `Date`. Note	Required if the field is new.	37.0
`format`	String	For dates, the format string is used to parse the input value; for other field types, the format string is used for display.	Optional	37.0
`label`	String	A user-friendly label for the field.	Optional	37.0
`multiValue`	Boolean	Indicates whether the field is a multivalue field (`true`) or not (`false`). The default is `false`.	Optional	37.0
`multiValueSeparator`	String	The value separator, used only if the field is a multivalue field.	Optional	37.0
`name`	String	The field developer name.	Required	37.0
`precision`	Integer	The numeric precision or text length depending on field type.	Optional	37.0
`scale`	Integer	The numeric scale.	Optional	37.0
`skipped`	Boolean	Indicates whether the field should be skipped on replication (`true`) or not (`false`). The default is `false`. If set to `true`, this field is ignored when syncing. The field metadata isn’t deleted, however, so the field can be 'unskipped' and made active later.	Required	37.0
`systemField`	Boolean	Indicates whether the field is a system field (`true`) or not (`false`). The default is false. System fields aren’t queryable.	Optional	37.0
`uniqueId`	Boolean	Indicates whether the field is a unique ID for the data set (`true`) or not (`false`). The default is `false`. There can only be one unique ID for any dataset.	Optional	37.0

The following JSON shows how to update fields for a connected object.

1{
2  "fields": [
3    {"fieldType": "text", "label": "Id", "name": "Id", "skipped": "false"},
4    {"fieldType": "text", "label": "Name", "name": "Name", "skipped": "false"},
5    {"fieldType": "numeric", "label": "Amount", "name": "Amount", "precision": 18,
6      "scale": 2, "skipped": "false"},
7    {"fieldType": "date", "label": "CloseDate", "name": "CloseDate", 
8      "format": "yyyy-MM-dd‘T‘HH:mm:ss.SSS‘Z‘", "skipped": "false"}
9  ]
10}

PATCH Response Body (ReplicatedFieldCollectionRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`fields`	ReplicatedFieldRepresentation[]	A list of fields belonging to the connected object.	Small, 37.0	37.0
`replicatedDataset`	AssetReferenceRepresentation	A reference to the replicated dataset that the fields belong to.	Small, 53.0	53.0
`url`	String	URL to get the collection.	Small, 37.0	37.0

Tableau CRM REST API Developer Guide

Replicated Dataset Fields Resource