Read all Properties of a Property Set Type

With this method, you can retrieve all properties that belong a property set type.

By default, the service displays a maximum of 500 records per response. You can navigate to the next set of results, if available, using the __next link at the end in the response payload. However, the number of records retrieved depends on the query parameter $top, if provided in the request URL. For more information, see Retrieving List of Records.

Request

URI: /ThingConfiguration/v1/PropertySetTypes('<property set type name>')/Properties

Operation Type: CRUD

HTTP Method: GET

Permissions: <thingconf>.r

Request Headers

Header	Required	Values
Accept-Language	No	Language of the property set type description. The default language is en.

Request Parameters

Parameter	Required	Data Type	Description
property set type name	Yes	String	Name of the property set type

Query Request Parameters

Parameter	Required	Data Type	Description
$top	No	Integer	Number of records to include in the result set.
$skip	No	Integer	Number of the first n records to be excluded from the result set.
$inlinecount	No	String	Total number of property set types available; permissible values are allpages and none. The following results apply if this parameter is used in conjunction with the other query parameters: If you use this with the $top and $skip parameters, the result contains the total count of property set types available. If you use this with $filter parameter, the result contains the total count of property set types based on the defined filter condition.
$orderby	No	String	Field name to be used for sorting the result set in ascending order; only valid fields are property name, description, type, property length, quality code, and unit of measure. To sort the result set, use asc for the ascending order and desc for the descending order.
$filter	No	String	Filter condition to be applied; only valid fields are property name, description, type, property length, quality code, and unit of measure. The filter operators supported are eq, lt, gt, le, ge, and ne. Multiple filters are supported using the separators – and, or. You can use the string functions such as substringof, startswith, and endswith to search data using $filter. Valid fields are property name, type, property set type.
$select	No	String	Select condition for the data fields to be included in the result set; all fields in the response payload are supported.

Request Example

/ThingConfiguration/v1/PropertySetTypes('core.automobiles:Engine')/Properties

Retrieves all properties that belong to the property set type core.automobiles:Engine

Response

Response Status and Error Codes

Code	Description
200	Data retrieved successfully

Payload

Format: JSON

Media types supported are JSON and XML. The JSON for this method has the structure as depicted in the following examples:

Example 1

/ThingConfiguration/v1/PropertySetTypes('core.automobiles:Engine')/Properties

{
	"d": {
		"results": [{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "Temperature",
				"PropertySetType": "core.automobiles:Engine",
				"Description": "Temperature of the Engine",
				"Type": "Numeric",
				"PropertyLength": "",
				"QualityCode": "1",
				"UnitOfMeasure": "AA",
				"ReferenceProperty": null,
				"AttributeType": null,
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')/Annotations"
					}
				},
				"ReferenceProperties": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')/ReferenceProperties"
					}
				}
			},
			{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "Pressure",
				"PropertySetType": "core.automobiles:Engine",
				"Description": "Pressure of the Engine",
				"Type": "Numeric",
				"PropertyLength": null,
				"QualityCode": "0",
				"UnitOfMeasure": "BA",
				"ReferenceProperty": null,
				"AttributeType": null,
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')/Annotations"
					}
				},
				"ReferenceProperties": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')/ReferenceProperties"
					}
				}
			}
		]
	}
}

Example 2

/ThingConfiguration/v1/PropertySetTypes('core.automobiles:Engine')/Properties?$expand=ReferenceProperties

{
	"d": {
		"results": [{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "Temperature",
				"PropertySetType": "core.automobiles:Engine",
				"Description": "Temperature of the Engine",
				"Type": "Numeric",
				"PropertyLength": null,
				"QualityCode": "1",
				"UnitOfMeasure": "AA",
				"ReferenceProperty": null,
				"AttributeType": null,
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Temperature',PropertySetType='core.automobiles:Engine')/Annotations"
					}
				},
				"ReferenceProperties": {
					"results": [{
						"Name": "TemperatureRefUoM",
						"PropertySetType": "core.automobiles:EngineReference",
						"Description": "Reference Temperature of the Engine",
						"Type": null,
						"PropertyLength": null,
						"QualityCode": null,
						"UnitOfMeasure": null,
						"ReferenceProperty": "Temperature",
						"AttributeType": "com.sap.iot.core.UoM",
						"Operation": null,
						"PropertyType": null,
						"IsMultilingual": null
					}]
				}
			},
			{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "Pressure",
				"PropertySetType": "core.automobiles:Engine",
				"Description": "Pressure of the Engine",
				"Type": "Numeric",
				"PropertyLength": null,
				"QualityCode": "0",
				"UnitOfMeasure": "BA",
				"ReferenceProperty": null,
				"AttributeType": null,
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='Pressure',PropertySetType='core.automobiles:Engine')/Annotations"
					}
				},
				"ReferenceProperties": {
					"results": [{
						"Name": "PressureRefLThreshold",
						"PropertySetType": "core.automobiles:EngineReference",
						"Description": "Reference Pressure of the Engine",
						"Type": null,
						"PropertyLength": null,
						"QualityCode": null,
						"UnitOfMeasure": null,
						"ReferenceProperty": "Pressure",
						"AttributeType": "com.sap.iot.core.LowerThreshold",
						"Operation": null,
						"PropertyType": null,
						"IsMultilingual": null
					}]
				}
			}
		]
	}
}

Example 3

/ThingConfiguration/v1/PropertySetTypes('core.automobiles:EngineReference')/Properties?$expand=ReferenceProperties

{
	"d": {
		"results": [{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='TemperatureRefUoM',PropertySetType='core.automobiles:EngineReference')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='TemperatureRefUoM',PropertySetType='core.automobiles:EngineReference')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "TemperatureRefUoM",
				"PropertySetType": "core.automobiles:EngineReference",
				"Description": "Reference Temperature of the Engine",
				"Type": null,
				"PropertyLength": null,
				"QualityCode": null,
				"UnitOfMeasure": null,
				"ReferenceProperty": "Temperature",
				"AttributeType": "com.sap.iot.core.UoM",
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='TemperatureRefUoM',PropertySetType='core.automobiles:EngineReference')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='TemperatureRefUoM',PropertySetType='core.automobiles:EngineReference')/Annotations"
					}
				},
				"ReferenceProperties": {
					"results": []
				}
			},
			{
				"__metadata": {
					"id": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='PressureRefLThreshold',PropertySetType='core.automobiles:EngineReference')",
					"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='PressureRefLThreshold',PropertySetType='core.automobiles:EngineReference')",
					"type": "com.sap.appiot.Property"
				},
				"Name": "PressureRefLThreshold",
				"PropertySetType": "core.automobiles:EngineReference",
				"Description": "Reference Pressure of the Engine",
				"Type": null,
				"PropertyLength": null,
				"QualityCode": null,
				"UnitOfMeasure": null,
				"ReferenceProperty": "Pressure",
				"AttributeType": "com.sap.iot.core.LowerThreshold",
				"Operation": null,
				"PropertyType": null,
				"IsMultilingual": null,
				"Descriptions": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='PressureRefLThreshold',PropertySetType='core.automobiles:EngineReference')/Descriptions"
					}
				},
				"Annotations": {
					"__deferred": {
						"uri": "https://config-thing-sap-ci.cfapps.sap.hana.ondemand.com:443/ThingConfiguration/v1/Properties(Name='PressureRefLThreshold',PropertySetType='core.automobiles:EngineReference')/Annotations"
					}
				},
				"ReferenceProperties": {
					"results": []
				}
			}
		]
	}
}