SdsUomQuantity API

The REST API (REpresentational State Transfer - Application Programming Interface)s provide programmatic access to read and write Sequential Data Store (SDS (Sequential Data Store)) Key Distribution Center (KDC (Key Distribution Center))

• Ticket Granting Service (TGS (Ticket Granting Service))

• Ticket-Granting-Ticket (TGT (Ticket-Granting-Ticket))

• Service Principle Name (SPN (Service Principal Name))

Transport Level Security (TLS (Transport Layer Security)) SDS (Sequential Data Store) data. The API (Application Programming Interface)s in this section interact with SdsUomQuantitys. For more information, see 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?skip={skip}&count={count}

Parameters

string tenantId Tenant identifier

string namespaceId Namespace identifier

[Optional] int skip

Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[Optional] int count

Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

Response

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

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 identifier

string uomId The unit of measure identifier

Response

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

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. For example, A unit of measure 'meter' would measure a quantity 'length'.

Properties

{

"Id": "string",

"Name": "string",

"BaseUom": {

"Id": "string",

"Abbreviation": "string",

"Name": "string",

"DisplayName": "string",

"QuantityId": "string",

"ConversionFactor": 0,

"ConversionOffset": 0

},

"Dimensions": [

0

]

}

SdsUom

DataContract representing a unit of measure

Properties

{

"Id": "string",

"Abbreviation": "string",

"Name": "string",

"DisplayName": "string",

"QuantityId": "string",

"ConversionFactor": 0,

"ConversionOffset": 0

}

ErrorResponseBody

Contains the error message format that follows the CONNECT data services error standards

Properties

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}