Create Type

Creates a new type.

Request

This endpoint expects an object.

namestringRequired

propertyConfigsmap from strings to objectsRequired

descriptionstringOptional

iconNamestringOptional

workspacestringOptional

The workspace in which to create the asset type. If not provided, the asset type will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

Response

This endpoint returns an object.

ridstring

namestring

propertyConfigsmap from strings to objects

createdAtdatetime

descriptionstringOptional

iconNamestringOptional

The name of the icon to display for the type. This name maps to a Lucide icon in the frontend.

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/type \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"propertyConfigs": {
7	"propertyConfigs": {
8	"isRequired": true
9	}
10	}
11	}'

1	{
2	"rid": "rid",
3	"name": "name",
4	"propertyConfigs": {
5	"propertyConfigs": {
6	"isRequired": true,
7	"description": "description"
8	}
9	},
10	"createdAt": "2024-01-15T09:30:00Z",
11	"description": "description",
12	"iconName": "iconName"
13	}

Headers

Request

Response