Quantities
- Last UpdatedJan 10, 2025
- 6 minute read
The API in this section interacts with quantities and units of measure.
List Quantities
Returns a list of all quantities available within a given namespace
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities
?filter={filter}&skip={skip}&count={count}&orderby={orderby}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
[optional] string filter
Filter expression.[optional] integer skip
Parameter representing the zero-based offset of the first SdsUomQuantity to retrieve. If not specified, a default value of 0 is used[optional] integer count
Parameter representing the maximum number of SdsUomQuantity to retrieve. If not specified, a default value of 100 is used[optional] string orderby
Parameter representing sorted order of returned objects. A field name is required. The sorting is based on the stored values for the given field.
For example, orderby=name would sort the returned results by the name values (ascending by default).
Additionally, a value can be provided along with the field name to identify whether to sort ascending or descending,
by using values asc or desc, respectively.
For example, orderby=name desc would sort the returned results by the name values, descending.
If no value is specified, there is no sorting of results.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | SdsUomQuantity[] | Returns a list of SdsUomQuantity objects |
| 400 | ErrorResponseBody | Missing or invalid inputs |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | One of the resources specified was not found |
| 500 | ErrorResponseBody | An error occurred while processing the request |
| 503 | ErrorResponseBody | Service Unavailable |
Example response body
200 Response
HTTP/1.1 200
Content-Type: application/json
[
{
"Id":"Angular Velocity",
"Name":"Angular Velocity",
"BaseUom":{
"Id":"radian per second",
"Abbreviation":"rad/s",
"Name":"radian per second",
"DisplayName":"radian per second",
"QuantityId":"Angular Velocity",
"ConversionFactor":1
},
"Dimensions":[
0,
0,
-1,
0,
0,
0,
0
]
},
{
"Id":"Area",
"Name":"Area",
"BaseUom":{
"Id":"square meter",
"Abbreviation":"m2",
"Name":"square meter",
"DisplayName":"square meter",
"QuantityId":"Area",
"ConversionFactor":1
},
"Dimensions":[
2,
0,
0,
0,
0,
0,
0
]
}
]
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Get Quantity
Returns the quantity corresponding to the specified quantityId within a given namespace
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string quantityId
The quantity identifier
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | SdsUomQuantity | Returns the SdsUomQuantity |
| 400 | ErrorResponseBody | Missing or invalid inputs |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | One of the resources specified was not found |
| 500 | ErrorResponseBody | An error occurred while processing the request |
| 503 | ErrorResponseBody | Service Unavailable |
Example response body
200 Response
HTTP/1.1 200
Content-Type: application/json
{
"Id":"Length",
"Name":"Length",
"BaseUom":{
"Id":"meter",
"Abbreviation":"m",
"Name":"meter",
"DisplayName":"meter",
"QuantityId":"Length",
"ConversionFactor":1
},
"Dimensions":[
1,
0,
0,
0,
0,
0,
0
]
}
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Get Quantity Unit of Measure
Returns the unit of measure associated with the specified uomId belonging to the quantity with the specified quantityId
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string quantityId
The quantity identifierstring uomId
The unit of measure identifier
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | SdsUom | Returns the SdsUom |
| 400 | ErrorResponseBody | Missing or invalid inputs |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | One of the resources specified was not found |
| 500 | ErrorResponseBody | An error occurred while processing the request |
| 503 | ErrorResponseBody | Service Unavailable |
Example response body
200 Response
HTTP/1.1 200
Content-Type: application/json
{
"Id": "mile",
"Abbreviation": "mi",
"Name": "mile",
"DisplayName": "mile",
"QuantityId": "Length",
"ConversionFactor": 1609.344
}
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
List Quantity Units of Measure
Returns the list of units of measure that belongs to the quantity with the specified quantityId
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.string quantityId
The quantity identifier
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | SdsUom[] | Returns a list of SdsUom objects |
| 400 | ErrorResponseBody | Missing or invalid inputs |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | One of the resources specified was not found |
| 500 | ErrorResponseBody | An error occurred while processing the request |
| 503 | ErrorResponseBody | Service Unavailable |
Example response body
200 Response
HTTP/1.1 200
Content-Type: application/json
[
{
"Id":"milliampere",
"Abbreviation":"mA",
"Name":"milliampere",
"DisplayName":"milliampere",
"QuantityId":"Electric Current",
"ConversionFactor":0.001
},
{
"Id":"ampere",
"Abbreviation":"A",
"Name":"ampere",
"DisplayName":"ampere",
"QuantityId":"Electric Current",
"ConversionFactor":1
}
]
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Definitions
SdsUomQuantity
DataContract representing a measurable quantity. i.e. A unit of measure 'meter' would measure a quantity 'length'
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Unique identifier for this quantity. |
| Name | string | false | true | Friendly name for this quantity. |
| BaseUom | SdsUom | false | true | The base unit of measurement for this quantity. All other uom's measuring this quantity will be calculated relative to the base uom. |
| Dimensions | [integer] | false | true | Powers of each dimension that define this quantity. This array must have a length of 7. Dimensions represented in index order are Length, Mass, Time, Electric Current, Thermodynamic Temperature, Amount of Substance, and Luminous Density. i.e. A velocity quantity would have values [1,0,-1,0,0,0,0] for (length)/(time) |
| CreatedDate | date-time | false | false | The DateTime in ISO 8601 extended format and UTC time standard when the SdsUomQuantity was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users. |
| ModifiedDate | date-time | false | false | The DateTime in ISO 8601 extended format and UTC time standard when the SdsUomQuantity was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users. |
{
"Id": "string",
"Name": "string",
"BaseUom": {
"Id": "string",
"Abbreviation": "string",
"Name": "string",
"DisplayName": "string",
"QuantityId": "string",
"ConversionFactor": 0,
"ConversionOffset": 0,
"CreatedDate": "2019-08-24T14:15:22Z",
"ModifiedDate": "2019-08-24T14:15:22Z"
},
"Dimensions": [
0
],
"CreatedDate": "2019-08-24T14:15:22Z",
"ModifiedDate": "2019-08-24T14:15:22Z"
}
SdsUom
DataContract representing a unit of measure.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Unique identifier for this unit of measure. |
| Abbreviation | string | false | true | Abbreviation for this unit of measure. |
| Name | string | false | true | Full name for this unit of measure. |
| DisplayName | string | false | true | Display name for this unit of measure. |
| QuantityId | string | false | true | The Id of the quantity that this unit is a measure of. |
| ConversionFactor | double | false | false | When a value of this unit is multiplied by the ConversionFactor and then incremented by the ConversionOffset, the value in terms of the base unit of the corresponding quantity is returned. |
| ConversionOffset | double | false | false | When a value of this unit is multiplied by the ConversionFactor and then incremented by the ConversionOffset, the value in terms of the base unit of the corresponding quantity is returned. |
| CreatedDate | date-time | false | false | The DateTime in ISO 8601 extended format and UTC time standard when the SdsUom was created. This value is set upon object creation and is immutable. The default value of the CreatedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users. |
| ModifiedDate | date-time | false | false | The DateTime in ISO 8601 extended format and UTC time standard when the SdsUom was last modified. This value is initialized upon object creation and is updated each time an object's properties are successfully modified. The ModifiedDate property of an object will also update if the object's ACL or owner is modified. The default value of the ModifiedDate property of existing objects is DateTime.MinValue. This property cannot be modified by users. |
{
"Id": "string",
"Abbreviation": "string",
"Name": "string",
"DisplayName": "string",
"QuantityId": "string",
"ConversionFactor": 0,
"ConversionOffset": 0,
"CreatedDate": "2019-08-24T14:15:22Z",
"ModifiedDate": "2019-08-24T14:15:22Z"
}
ErrorResponseBody
The error response contains standard details on the cause and resolution of the error.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | Operation unique identifier of action that caused the error |
| Error | string | false | true | Error description |
| Reason | string | false | true | Reason for the error |
| Resolution | string | false | true | Resolution to resolve the error |
| Parameters | object | false | true | IDs or values that are creating or are affected by the error |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}