Admin API Overview
The LINE WORKS Admin API is a set of APIs provided by LINE WORKS Admin system, allowing you to change the settings of domain and members and execute popup windows including organization chart and personal information setting.
Response Common
The API response is returned in JSON format.
On Success
The result of each API call is contained in "data."
- The "data" type is subdivided into String and Object<OrgSyncResult>.
- When "data" is Object<OrgSyncResult> type, there may be a partial failure (failList) even if the response is successful.
| Property | Type | Required | Description |
|---|---|---|---|
| data | String | Y | The result of API call. The response of each API is contained in this property. |
| Object<OrgSyncResult> | Y | API execution result |
OrgSyncResult includes the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| successCount | Integer | Y | The number of successes |
| successList | List | N | Contains values only if there is a success. |
| key | String | Y | An identification key for success |
| Info | Map | N | Information for success |
| failCount | Integer | Y | The number of failures |
| failList | List | N | Contains values only if there is a failure. |
| key | String | Y | An identification key for success |
| code | String | Y | Error code on failure |
| message | String | Y | Error message on failure |
| detailMessage | String | N | Use this if a detailed message is necessary. |