Analytics REST API Developer Guide
jNewer Version Available
Replicated Dataset Fields Resource
- Resource URL
-
1/wave/replicatedDatasets/<Id>/fieldsRequires the following permissions:- orgHasReplicationEnabled
- ELTEditor
- InsightsAdmin
- Formats
- JSON
- Available Version
- 37.0
- HTTP Methods
- GET PATCH
- GET Response Body
-
ReplicatedFieldCollectionRepresentation
Property Name Type Description Filter Group and Version Available Version fields ReplicatedFieldRepresentation[] A list of replicated fields. Small, 37.0 37.0 url String URL to get the collection. Small, 37.0 37.0 -
ReplicatedFieldRepresentation
Property Name Type Description Filter Group and Version Available Version skipped Boolean If set and true, this field will not be replicated, but the field metadata can still be stored and retrieved. Small, 37.0 37.0 - PATCH Request Body
-
ReplicatedFieldCollectionInputRepresentation
Property Name Type Description Required or Optional Available Version fields ReplicatedFieldInputRepresentation[] The list of field configurations. 37.0 -
ReplicatedFieldInputRepresentation
Property Name Type Description Required or Optional Available Version defaultValue Object An optional default value. 37.0 description String A long-form description of the field. 37.0 fieldType ConnectWaveFieldTypeEnum The type of the field (Date, Numeric, or Text). 37.0 format String For dates, the format string is used to parse the input value; for other field types, theformat string is used for display. 37.0 label String A user-friendly label for the field. 37.0 multiValue Boolean Indicates if the field is mulit-value or not (default false). 37.0 multiValueSeparator String The value separator, used only if this is a multi-value field. 37.0 name String The field's developer name. 37.0 precision Integer The numeric precision or text length depending on field type. 37.0 scale Integer The numeric scale. 37.0 skipped Boolean If set, this field is ignored when replicating. The field metadata is not deleted, however, so the field can be 'unskipped' and made active later. 37.0 systemField Boolean Indicates if the field is a system field (default false). System fields are not queryable. 37.0 uniqueId Boolean Indicates if the field is a unique ID for the data set (default false). There can be only one unique ID for any dataset. 37.0 - PATCH Response Body
- ReplicatedFieldCollectionRepresentation
Property Name Type Description Filter Group and Version Available Version fields ReplicatedFieldRepresentation[] A list of replicated fields. Small, 37.0 37.0 url String URL to get the collection. Small, 37.0 37.0 - PATCH Request Parameters
-
Parameter Name Type Description Required or Optional Available Version replicatedFields Object (ReplicatedFieldCollectionInputRepresentation) The field collection for updating the replicated dataset. Required 37.0