Create the reference data type definition
- Last UpdatedApr 15, 2025
- 2 minute read
Use this process to create the AssetSupportedType reference data definition:
-
In the left pane of CONNECT data services, select Developer Tools, then select API Console.
-
Select v1 in the Full Path dropdown.
-
Select POST in the Verb dropdown.
-
In the URI field, type / at the end of the existing text, then select your desired Namespace.
-
Paste the following AssetSupportedType JSON text in the Body field.
{
"Name": "AssetSupportedType",
"Version": 0,
"Id": "AssetSupportedType",
"State": "Active",
"Description": "A Type that allows you to build a mapping between an Asset instance and a specific Type. It can also specify a capability contract for the type via the BaseTypeId",
"Category": "ReferenceData",
"Properties": [
{
"PropertyTypeCode": "String",
"Id": "siteName",
"Name": "siteName",
"Flags": "Indexed",
"State": "Active",
"Description": "Site from which this record was curated"
},
{
"PropertyTypeCode": "String",
"Id": "sourceName",
"Name": "sourceName",
"Flags": "Indexed",
"State": "Active",
"Description": "Source provider from which this record was curated"
},
{
"PropertyTypeCode": "String",
"Id": "baseTypeId",
"Name": "baseTypeId",
"Flags": "Indexed",
"State": "Active",
"Description": "Well-known Base Type Id that specifies the capability contract of this type"
},
{
"PropertyTypeCode": "String",
"Id": "typeId",
"Name": "typeId",
"Flags": "Indexed",
"State": "Active",
"Description": "The Type Id of this mapping. This can be used to look up the type"
},
{
"PropertyTypeCode": "String",
"Id": "typeName",
"Name": "typeName",
"Flags": "Indexed",
"State": "Active",
"Description": "The GraphQL Type name of the mapping. This can be used to build queries"
},
{
"PropertyTypeCode": "String",
"Id": "context",
"Name": "context",
"Flags": "Indexed",
"State": "Active",
"Description": "Provides extra context for this mapping. For example, the source property"
},
{
"PropertyTypeCode": "Boolean",
"Id": "isReferenceType",
"Name": "isReferenceType",
"Flags": "Indexed",
"State": "Active",
"Description": "If true, this is a referenceType; else it is an event"
},
{
"PropertyTypeCode": "Boolean",
"Id": "isEnabled",
"Name": "isEnabled",
"Flags": "Indexed",
"State": "Active",
"Description": "True if this mapping is supported. False if it is not supported and this record can be deleted"
},
{
"PropertyTypeCode": "Asset",
"Id": "asset",
"Name": "asset",
"Flags": "Indexed",
"State": "Active",
"RemoteReferenceName": "assetSupportedTypes",
"Description": "The Asset instance that owns this Type mapping. It can be left null if this is not an asset specific mapping"
}
],
}
-
In the URI field, type /ReferenceDataTypes/AssetSupportedType at the end of the existing text.
-
Select the POST button.