> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/navigaid/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/navigaid/services/admin-api/routes/units.md).

# Units

## /units.get

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/units.get`

Get unit by id

#### Query Parameters

| Name   | Type   | Description |
| ------ | ------ | ----------- |
| unitId | string | UUIDv4      |

{% tabs %}
{% tab title="200 Successful" %}

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

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.list

<mark style="color:blue;">`GET`</mark> `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 |

{% tabs %}
{% tab title="200 Successful" %}

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

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.create

<mark style="color:green;">`POST`</mark> `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 |

{% tabs %}
{% tab title="200 Successful" %}

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

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.delete

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/units.delete`

Delete unit by id

#### Request Body

| Name   | Type   | Description |
| ------ | ------ | ----------- |
| unitId | string | UUIDv4      |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.setDescription

<mark style="color:green;">`POST`</mark> `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 |

{% tabs %}
{% tab title="200 Successful" %}

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

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BHadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.setDisplayName

<mark style="color:green;">`POST`</mark> `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 |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "displayName": "Barometern OT"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /units.setName

<mark style="color:green;">`POST`</mark> `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   |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "name": "barometern"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}