Create a data descriptor
Learn how to create a data descriptor to describe the basic layout of a table.
Data tables are created and referenced through the REST interface as data descriptor objects. Each descriptor describes the basic layout of a table. After you provide information for your descriptor, SAS Customer Intelligence 360 selects the best implementation for you.
Note: You must be authenticated to use the REST interfaces. One method for authentication is to log on to the product on one tab, and then use a client such as Postman (for Chrome) or REST Client (for Firefox) on a second tab in the same browser window.
Use this REST call to create a data descriptor:
POST https:<server>/SASWebMarketingMid/rest/descriptors/
The body of the request should be a JSON structure that defines the table to be created. The response to the request contains the ID value that is used to upload the customer and location data.
These are the HTTP response codes that can be returned from the REST call:
| Response Code | Description |
|---|---|
| 202 | The server received the request and handles it later if the request is still valid. |
| 400 | The request is not well formed or cannot be processed. |
| 401 | You do not have authorization to perform the operation on the resource that is specified in the request. |
| 403 | You do not have permission to access the resource. |
| 500 | There was a server error. |
A data item uses this structure:
| Name | Type | Description |
|---|---|---|
| name | String | Name of the data item (column). |
| label | String | Text to display in the user interface when a user selects the data item. |
| description | String | Describes the purpose of the data item. |
| type | String | Type must be one of these strings:
|
| identity | Boolean | Specifies if the data item contains identity information. Note: If identity is set to true, then the identity_type attribute is required. Otherwise, identity_type is optional and ignored. |
| identity_type | String | If the value for the identity attribute is true, then identity_type must be set to one of these strings: customer_id login_id email_id subject_id visitor_id device_id |
| isKey | Boolean | Specifies if this data item provides a unique value for the data set. Items with the isKey value set to true are the items compared when you upload data with the upsert mode. You can set the value to true for one or more columns. When it is set for more than one column, the combination of those columns produces a unique composite key. The default value is false. |
| segmentation | Boolean | Specifies if the data item is available for segmentation. |
| makeAvailableForTargeting | Boolean | Specifies if the data item is available for targeting. Note: For data items where makeAvailableForTargeting is true, use these values in the data descriptor:
Items with other values cannot be associated with published tasks. |
| uniqueValuesAvailable | Boolean | Specifies if the data item provides a list of distinct values for the user interface. |
| tags | String | One or more constants that the user interface uses to determine the data item purpose. For example, you could use "DEMOGRAPHICS" or "EMAIL." |
| excludeFromAnalytics | Boolean | Specifies if the data item should be ignored by analytics. |
| segmentProfilingField | Boolean | Specifies if the data item should be ignored in segment profiling. |