Request
Request body
The request body encapsulates an object that specifies properties and values for a single new asset-type.
| Property | Required | Type | Pattern | Description |
|---|---|---|---|---|
| class | Yes | string | [A-Za-zÀ-ú0-9ა-ჰ一-蠼赋]+
|
Specifies the class for the asset type.
|
| name | Yes | string | |
Name of the asset type. A string ≤ 255 characters. The name must be unique for the asset class. |
| views | No | array[object] |
Defines views for the asset type.
|
|
| description | No | string | The description provides context for an asset type. | |
| xref | No | array[string] | An array of alphanumeric identifiers for assets in the workspace. | |
| contexts | No | array[string] | ^[a-fA-F\\d]{24}$ |
An array of object IDs ( |
| style | No | object |
Specifies the background color and icon for an asset type. |
|
| properties | No | array[object] |
Define properties for the asset type.
|
|
| overrides | No | array[object] |
|
|
| displayFormat | Yes | string | ^(?:[\\w\\s\\-_|$%]*\\{[0-9a-zA-ZÀ-ÿ_-]+\\}*[\\w\\s\\-_|<>_$%]*)+$ |
The display format field for the asset type. |
| levels | No | array[object] | Specifies level numbers and names for an asset type. | |
| maximumDepth | No | integer |
This is the maximum depth of nested child model assets |
|
| counter | No | object |
An alpha-numeric prefix and initial (seed) value for the asset counter. If no seed value is specified for the asset type, the counter will be set for one when the first asset is added. |
|
| inheritedId | No | string | ^[a-fA-F\\d]{24}$ |
The ID for an inherited asset type. |
| abstract | Yes | boolean | Set this to true to create an abstract asset type. An abstract asset type provides the base for other tangible asset types. | |
| parentId | No | string |
|
The parent asset type ID for the new asset type. |
| predicateId | No | string | ^[a-fA-F\\d]{24}$ |
The ID the predicate that defines the relationship between this asset type and its parent. |
An example request body is shown here.
{
"class": "Business",
"name": "QA_BUS_EXM_1",
"displayFormat": "{Name}",
"description": "This is a business asset type",
"abstract": false,
"views": [
{
"name": "QA_View",
"viewType": "Grid",
"isDefault": true,
"columns": [
{
"name": "Name",
"widthType": "Fixed",
"widthValue": 250
}
],
"filters": [
{
"name": "Name",
"persist": false
}
],
"sorts": [
{
"name": "Name",
"direction": "Asc"
}
]
}
],
"properties": [
{
"name": "Name",
"label": "Name",
"type": "Text",
"description": "this is a text field",
"category": "",
"requirement": "Key",
"display": {
"show": true,
"showIfEmpty": false,
"showInColumn": false
},
"search": {
"prefix": "",
"suffix": "",
"displayOrder": 1,
"addToResult": true
},
"definition": {
"text": {
"allowRichText": false,
"validation": {}
}
}
},
{
"name": "Boolean",
"label": "Boolean",
"type": "Boolean",
"description": "this is a boolean field",
"category": "",
"requirement": "Optional",
"display": {
"show": true,
"showIfEmpty": false,
"showInColumn": false
},
"search": {
"prefix": "",
"suffix": "",
"displayOrder": 1,
"addToResult": true
},
"definition": {
"boolean": {
"defaultValue": false
}
}
}
]
}Response
The result for this method is returned in the response body. Properties and values for the new asset type are contained in the data object.
Response body
Example status code responses for this method are shown here. To view the response schemas, you can download the Data Catalog APIs Open API Specification from the Precisely Developer Portal..
{
"data": {
"id": "68ca86d1b2347ffa884feae7",
"class": "Business",
"name": "QA_BUS_EXM_1",
"displayFormat": "{Name}",
"abstract": false,
"state": "Active",
"overridability": "All",
"isSystem": false,
"createdBy": "00u17r5rbf45iXfQp0h8",
"createdAt": "2025-09-17T10:00:49.294Z",
"updatedAt": "2025-09-17T10:00:49.294Z",
"updatedBy": "00u17r5rbf45iXfQp0h8",
"views": [
{
"name": "QA_View",
"viewType": "Grid",
"isDefault": true,
"columns": [
{
"name": "Name",
"widthType": "Fixed",
"widthValue": 250
}
],
"filters": [
{
"name": "Name",
"persist": false
}
],
"sorts": [
{
"name": "Name",
"direction": "Asc"
}
]
}
],
"description": "This is a business asset type",
"xref": [
"7e7d3cd60274"
],
"contexts": [],
"properties": [
{
"name": "Name",
"label": "Name",
"type": "Text",
"definition": {
"text": {
"allowRichText": false,
"validation": {}
}
},
"requirement": "Key",
"category": "",
"display": {
"show": true,
"showIfEmpty": false,
"showInColumn": false
},
"search": {
"prefix": "",
"suffix": "",
"displayOrder": 1,
"addToResult": true
},
"description": "this is a text field",
"editableOnUi": true
},
{
"name": "Boolean",
"label": "Boolean",
"type": "Boolean",
"definition": {
"boolean": {
"defaultValue": false
}
},
"requirement": "Optional",
"category": "",
"display": {
"show": true,
"showIfEmpty": false,
"showInColumn": false
},
"search": {
"prefix": "",
"suffix": "",
"displayOrder": 1,
"addToResult": true
},
"description": "this is a boolean field",
"editableOnUi": true
}
],
"maximumDepth": 1,
"assetCount": 0
},
"links": {
"self": "https://api.cloud.precisely.com/asset-types"
}
}{
"statusCode": 400,
"error": "Bad Request",
"message": "Bad Request"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Rate limit exceeded"
}{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service temporarily unavailable"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "Request timeout"
}