Organization management

Create a new business entity

This endpoint creates a new business entity.

post/v1/organization/business_entities

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
https://skmtc.dev/sinai/apis/sinai-api/docs/v1/organization/business_entities/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

parentIDstring uuid required

namestring required

The name of the new business entity.

descriptionstring

The description of the new business entity.

countryCodestring

The country code of the business entity.

subIndustryCodestring

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

facilityTypeIDstring uuid nullable

The facility type of the business entity if it is a facility.

processTypeIDstring uuid nullable

The process type of the business entity if it is a process.

businessEntityTypeIDstring uuid required

defaultFunctionalUnitIDstring uuid

customFunctionalUnitNamestring

The name of the custom functional unit for the business entity. If you want to define a custom functional unit for the business entity, make sure to set this parameter.

defaultDisplayUnitstring

The default display unit for the functional unit of the business entity. If you want to define a custom functional unit for the business entity, make sure to set this parameter.

activeStartTimestampnumber

The timestamp when the business entity becomes active, in milliseconds since epoch.

activeEndTimestampnumber

The timestamp when the business entity becomes inactive, in milliseconds since epoch.

Example request

{
  "name": "New Business Entity",
  "description": "Description of the new business entity."
}

Response

Business entity successfully created

idstring uuid required

orgIDstring uuid

parentIDstring uuid nullable

namestring required

The name of the business entity

descriptionstring

A description of the business entity

countryCodestring

The country code of the business entity.

subIndustryCodestring nullable

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

facilityTypeIDstring uuid nullable

The facility type of the business entity if it is a facility.

processTypeIDstring uuid nullable

The process type of the business entity if it is a process.

businessEntityTypeIDstring uuid

defaultFunctionalUnitIDstring uuid

defaultDisplayUnitstring

The default display unit for the functional unit of the business entity

activeStartTimestampnumber

The timestamp when the business entity becomes active, in milliseconds since epoch

activeEndTimestampnumber

The timestamp when the business entity becomes inactive, in milliseconds since epoch

Example response

{
  "name": "Manufacturing plant",
  "description": "The building where things are manufactured"
}

Changes

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