Units

/units.get

GET https://admin-api.imid.infomaker.io/v1/units.get

Get unit by id

Query Parameters

Name	Type	Description
unitId	string	UUIDv4

200 Successful

{
  "id": "Unit id",
  "organizationId": "Organization id",
  "name": "barometern",
  "displayName": "Barometern OT",
  "description": "Description of speicific part xxx",
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.list

GET https://admin-api.imid.infomaker.io/v1/units.list

List units

Query Parameters

Name	Type	Description
id	string	Unit id
name	string	Unit name
displayName	string	Unit display name
organizationId	string	Organization id
updatedBySub	string	Organization subject

200 Successful

[
  {
    "id": "Unit id",
    "organizationId": "Organization id",
    "name": "barometern",
    "displayName": "Barometern OT",
    "description": "Description of speicific part xxx",
    "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
  }
]

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.create

POST https://admin-api.imid.infomaker.io/v1/units.create

Create unit

Request Body

Name	Type	Description
organizationId	string	Organization id
name	string	Unit name
displayName	string	Unit display name
description	string	Description of speicific part xxx

200 Successful

{
  "id": "Unit id",
  "organizationId": "Organization id",
  "name": "barometern",
  "displayName": "Barometern OT",
  "description": "Description of speicific part xxx",
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.delete

POST https://admin-api.imid.infomaker.io/v1/units.delete

Delete unit by id

Request Body

Name	Type	Description
unitId	string	UUIDv4

204 No Content

""

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.setDescription

POST https://admin-api.imid.infomaker.io/v1/units.setDescription

Set unit description by id

Request Body

Name	Type	Description
unitId	string	UUIDv4
description	string	Description of speicific part xxx

200 Successful

{
  "description": "Description of speicific part xxx"
}

400 Bad Request

"errors.api.BHadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.setDisplayName

POST https://admin-api.imid.infomaker.io/v1/units.setDisplayName

Set unit display name by id

Request Body

Name	Type	Description
unitId	string	UUIDv4
displayName	string	Unit display name

200 Successful

{
  "displayName": "Barometern OT"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/units.setName

POST https://admin-api.imid.infomaker.io/v1/units.setName

Set unit name by id

Request Body

Name	Type	Description
unitId	string	UUIDv4
name	string	Unit name

200 Successful

{
  "name": "barometern"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"