SIsinai
Organization management

Create a functional unit

Use this endpoint to create a new functional unit.

post/v1/organization/functional_units

Request

  • Base URL
    https://api.sinai.com
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://auth.sinai.com/oauth2/token
      Scopeshttps://api.sinai.com/organization
    • or OAuth 2
      Authorization codehttps://auth.sinai.com/oauth2/authorize
      Token URLhttps://auth.sinai.com/oauth2/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

The name of the functional unit

descriptionstring

The description of the functional unit

defaultDisplayUnitstring required

A unit of measurement (e.g., kg, MWh, etc).

subIndustryCodestring nullable

The sub-industry code of the business entity or functional unit, formatted as eight digits.

measurementType'COUNTER' | 'GAUGE'

The type of measurement of the functional unit. COUNTER is used for attributes that are added across time periods (e.g., steel produced). GAUGE is used for attributes that are not added across time periods (e.g., number of employees).

Example request

{
  "defaultDisplayUnit": "kg"
}

Response

Functional unit created successfully

idstring uuid required
namestring required

The name of the functional unit

descriptionstring

The description of the functional unit

defaultDisplayUnitstring required

A unit of measurement (e.g., kg, MWh, etc).

supportedUnitsUnit[] required
orgIDstring uuid nullable
subIndustryCodestring nullable required

The sub-industry code of the business entity or functional unit, formatted as eight digits.

measurementType'COUNTER' | 'GAUGE'

The type of measurement of the functional unit. COUNTER is used for attributes that are added across time periods (e.g., steel produced). GAUGE is used for attributes that are not added across time periods (e.g., number of employees).

Example response

{
  "defaultDisplayUnit": "kg",
  "supportedUnits": [
    "kg"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.