User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Create an Attribute Mapping

This endpoint allows you to map an input attribute to a unified attribute. Both attributes must already exist. The POST body is flexible with regards to identifying the input and unified attributes. For example, the post body:

{
    "relativeInputAttributeId": "datasets/9/attributes/attribute1",
    "inputDatasetName": "myFile.csv",
    "inputAttributeName": "attribute1",
    "relativeUnifiedAttributeId": "datasets/10/attributes/myAttribute",
    "unifiedDatasetName": "My Project - Unified Dataset",
    "unifiedAttributeName": "myAttribute"
}

will map the input attribute attribute1 from the dataset myFile.csv to the unified attribute myAttribute in the My Project project.

Note that a variety of different specifications in the POST body will achieve the same results. The following rules must be followed:

  • at least one full specification of an input attribute must be included, i.e.:
    • both inputDatasetName and inputAttributeName
    • inputAttributeId
    • relativeInputAttributeId
  • multiple specifications of an input attribute may be included, as long as they do not conflict with each other
  • at least one full specification of an unified dataset attribute must be included, i.e.:
    • both unifiedDatasetName and unifiedAttributeName
    • unifiedAttributeId
    • relativeUnifiedAttributeId
  • multiple specifications of an unified attribute may be included, as long as they do not conflict with each other
  • when specifying the unified dataset attribute, either a dataset-namespace ID (v1/datasets/<id>/<attr>) or a project-namespace ID (v1/projects/<id>/unifiedDataset/<attr>)may be used.
Language