SdsUom 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 SdsUoms. For more information, see Units of measure.

List Units of Measure

Returns a list of all available units of measure in the system

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Units?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":"count",

"Abbreviation":"count",

"Name":"count",

"DisplayName":"count",

"QuantityId":"Quantity",

"ConversionFactor":1

},

{

"Id":"Ampere hour",

"Abbreviation":"Ah",

"Name":"Ampere hour",

"DisplayName":"Ampere hour",

"QuantityId":"Electric Charge",

"ConversionFactor":3600

},

{

"Id":"coulomb",

"Abbreviation":"C",

"Name":"coulomb",

"DisplayName":"coulomb",

"QuantityId":"Electric Charge",

"ConversionFactor":1

}

]

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Get Unit of Measure

Returns the unit of measure corresponding to the specified uomId within a given namespace

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Units/{uomId}

Parameters

string tenantId

Tenant identifier

string namespaceId

Namespace identifier

string uomId

The unit of measure identifier

Response

Example response body

200 Response

HTTP/1.1 200

Content-Type: application/json

{

"Id":"ounce",

"Abbreviation":"oz",

"Name":"ounce",

"DisplayName":"ounce",

"QuantityId":"Mass",

"ConversionFactor":0.028349523

}

400 Response (ErrorResponseBody)

{

"OperationId": "string",

"Error": "string",

"Reason": "string",

"Resolution": "string",

"Parameters": {

"property1": "string",

"property2": "string"

}

}

Definitions

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"

}

}