Thing Type

Thing type is used to group the property sets that describes a thing.

For example, you can define a thing type Automobiles. You can create different things, for example, different automobiles identified by their license plates or vehicle identification numbers. You can associate properties to a property set type. You can assign a property set type to a thing type as property sets.

Resource Path:http://<server address>[:<port number>][/path]/ThingConfiguration

Example for a base URI in a cloud foundry environment: https://config-thing-sap.cfapps.eu10.hana.ondemand.com/ThingConfiguration

Operations

CRUD Operations

HTTP Method	Operation	URI	Scope
POST	Create a Thing Type	/ThingConfiguration/<version>/Packages('<package name>')/ThingTypes	`<thingconf>.c`
GET	Read Details of a Thing Type	/ThingConfiguration/<version>/ThingTypes('<thing type name>')	`<thingconf>.r`
GET	Read all Thing Types	/ThingConfiguration/<version>/ThingTypes	`<thingconf>.r`
GET	Read Thing Types of a Package	/ThingConfiguration/<version>/Packages('package name')/ThingTypes	`<thingconf>.r`
PATCH	Update a Thing Type	/ThingConfiguration/<version>/ThingTypes('<thing type name>')	`<thingconf>.u`
DELETE	Delete a Thing Type	/ThingConfiguration/v1/ThingTypes('<thing type name>')	`<thingconf>.d`

Thing Type Object Properties

Property	Type	Mandatory	Maximum Length	Description
Name	String	Yes	81	Unique name of the thing type
Descriptions	Array of description objects	No	-	Description of the thing type for each language with the corresponding ISO language code Note If you include Descriptions along with the CopySource field, the method assigns these descriptions for the newly created thing type. If you do not include Descriptions along with the CopySource field, the method copies descriptions defined in the source thing type to the newly created thing type.
PropertySets	Array of property set objects	No	-	Array of property sets that belong to the thing type
ThingTypeCategory	String	No	Fixed	Category of thing type Only the following values are supported: ASSET – Indicates the root thing COMPONENT – Indicates the sub-items of the ASSET Note You can define this only using `/v2` version of the create method.
CopySource	String	No	81	Name of the thing type You can use this field to specify the already existing thing type name, structure of which is copied to the new thing type to be created. Note You can use this field only in the `/v1` version of the create method. You cannot specify any value other than the thing type name in this field. You cannot create copy of a thing type that belongs to a package with scope=`private`. In a request payload to copy an existing thing type, you can only specify the name of the new thing type, CopySource field, and Descriptions field.

Property Set Object Properties

Property	Type	Mandatory	Maximum Length	Description
Name	String	Yes	50	Unique identifier of the property (that belongs to the propertySetType) defined in a thing type
PropertySetType	String	Yes	81	Name of the property set type referred
Descriptions	Array	No	-	Description of the property set for each language with the corresponding ISO language code

Description Object Properties

Property	Data Type	Maximum Length	Description
LanguageCode	String	2	ISO code of the language of the object description
Description	String	60	Description of the object

Note

When you create an object, you can provide the description in one or more languages. If you want to update the description in a specific language, provide the modified description only for that language in the request payload. The service updates the description only for the provided language and the description in other languages, if any, are retained as is.

The following example request payload updates the description in German (de) language:

{
…
  "Descriptions": [{
    "LanguageCode": "de",
      "Description": "updated description in German"
  }
}

Similarly, if you want to delete the description in a specific language, you must provide a blank value or null value in the request payload.

The following example request payloads, deletes the description in German (de) language:

Example with blank value

{
…
  "Descriptions": [{
    "LanguageCode": "de",
      "Description": ""
  }
}

Example with null value

{
…
  "Descriptions": [{
    "LanguageCode": "de",
      "Description": null
  }
}