Skip to main content

Create Datamap

Creates a new Datamap in Promethium based on a SQL definition and optional metadata. Datamaps can be virtualized as views or materialized as physical tables.


Endpoint

POST https://api.prod.promethium.ai/datamap/create

Headers

Header NameValueRequiredDescription
Content-Typeapplication/jsonSpecifies the format of the request body
idtoken<authentication_id_token>Bearer token obtained via authenticated login

Request Body

{
"name": str,
"description": "str",
"tags": str[],
"owner": str,
"sme": str,
"requestor": str,
"custom_attr": {
"product_type": str,
"product_line": str,
"datamap_type": str,
"version": str,
"alias": str,
"concept_name": str,
"context": str,
"expected_date": int, -- epoch timestamp
"review_date": int, -- epoch timestamp
"priority": int,
"value": float
},
"sql": str
}

Fields

FieldTypeRequiredDescription
namestringName of the Datamap
descriptionstringDescription of the Datamap’s purpose or content
tagsstring[]Array of tags for filtering and search
ownerstringPrimary owner of the Datamap
smestringSubject Matter Expert for the Datamap
requestorstringUser who requested the Datamap’s creation
custom_attrobjectAdditional business metadata (see nested fields below)
custom_attr.product_typestringType of product represented (e.g., subscription, physical, digital)
custom_attr.product_linestringProduct line or business unit
custom_attr.datamap_typestringClassification of Datamap (e.g., source, derived, aggregate)
custom_attr.versionstringVersion number of the Datamap
custom_attr.aliasstringShort alias or alternate name for the Datamap
custom_attr.concept_namestringConceptual term or business definition associated with this Datamap
custom_attr.contextstringDescription of usage context (e.g., "monthly snapshot")
custom_attr.expected_dateintegerExpected data availability date (epoch timestamp)
custom_attr.review_dateintegerDate this Datamap should be reviewed (epoch timestamp)
custom_attr.priorityintegerPriority level (e.g., 1 = highest, 5 = lowest)
custom_attr.valuefloatBusiness value or impact score (can be any numeric value)
sqlstringSQL query that defines the Datamap