| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /units | Retrieve a unit by path. |
| get | GET /units/{webId} | Retrieve a unit. |
| update | PATCH /units/{webId} | Update a unit. |
| delete | DELETE /units/{webId} | Delete a unit. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve a unit by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the unit.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve a unit.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the unit.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update(String webId, PIUnit unitDTO)
Update a unit.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the unit.. | [required] |
| unitDTO | PIUnit | A partial unit containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete a unit.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the unit.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]