Skip to content

Retrieve a schema by project id

Request

Retrieve a schema by project id

Security
OAuth2(Required scopes: projects.read)
Path
idstring(ProjectId)required

Project id

Example:63e6663823b4c1f5287398bb
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/projects/63e6663823b4c1f5287398bb/schema \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Schema retrieved

Bodyapplication/json
versioninteger(Version)
Example:1
dataPointsArray of objects(DataPoints)
Example:
[
  {
    "internalName": "type",
    "displayName": "Type",
    "type": "string",
    "source": { … },
    "normalization": [],
    "rules": {}
  },
  {
    "internalName": "number",
    "displayName": "Number",
    "type": "string",
    "source": { … },
    "normalization": [],
    "rules": {}
  },
  {
    "internalName": "issuedAt",
    "displayName": "Issued At",
    "type": "date",
    "preferDayOfMonth": "last",
    "source": { … },
    "normalization": [],
    "rules": {}
  },
  {
    "internalName": "deliveredAt",
    "displayName": "Delivered At",
    "type": "date",
    "preferDayOfMonth": "last",
    "source": { … },
    "normalization": [],
    "rules": {}
  },
  {
    "internalName": "currency",
    "displayName": "Currency",
    "type": "string",
    "source": { … },
    "normalization": [],
    "rules": {}
  }
]
featuresobject
enrichmentobject
normalizationobject
validationobject
Response
{
  "version": 1,
  "dataPoints": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "features": {
    "derivation": false
  },
  "enrichment": {},
  "normalization": {},
  "validation": {}
}