Skip to content

Find product data model by id

GET
/product-data-models/{productDataModelId}

Find product data model by id.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

productDataModelId*

The id of the product data model.

Typestring
Required
formatuuid

Responses

application/json
JSON
{
"id": "string",
"name": "string",
"version": "string",
"sections": [
{
"id": "string",
"name": "string",
"type": "string",
"parentId": "string",
"subSections": [
"string"
],
"dataFields": [
{
"id": "string",
"name": "string",
"type": "string",
"options": {
"additionalProperties": "string"
},
"granularityLevel": "string",
"layout": {
"colStart": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"colSpan": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"rowStart": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"rowSpan": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
}
}
}
],
"granularityLevel": "string",
"layout": {
"colStart": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"colSpan": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"rowStart": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
},
"rowSpan": {
"xs": 0,
"sm": 0,
"md": 0,
"lg": 0,
"xl": 0
}
}
}
],
"visibility": "string",
"createdByUserId": "string",
"ownedByOrganizationId": "string"
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI