Migrating from Stems One API v1.2

The intent of this Migration Guide document is to help existing businesses seamlessly port their integrations with Stems One API v1.2 to Stems One API v1.3.

Stems One API v1.3 introduces breaking changes on Hazard sections.
We also created new endpoints to manage associates in the system.

1. Breaking Changes

Please check changes described below and update your integration accordingly.

Endpoint Breaking Change Version Introduced
GET /hazards Previous implementation is now moved to GET /hazards/approvaldata. Please refer to the new endpoint below for breaking changes on existing functionality.

GET /hazards endpoint is reused to retrieve approved hazard data only. Please check the API reference for the new parameters and response data. 		v1.3.0
GET /hazards/approvaldata The response data is modified to allow action data retrieval. Existing actions field is now used for actual action data. It was used for suggested action data. A new suggestedActions field is introduced to hold suggested action data. v1.3.0
GET /hazards/{id} This endpoint is now moved to GET /hazards/{id}/approvalData. v1.3.0
POST /hazards Previous implementation is now moved to POST /hazards/approval. Please refer to the new endpoint below for breaking changes on existing functionality.

POST /hazards endpoint is reused to submit new hazard data without approval process. Please check the API reference for the new request and response data. 		v1.3.0
POST /hazards/approval The response data is modified to allow consistency with request data. The following Field is renamed on response data:

  • date is renamed to reportedDate


After the introduction of multiple hazard types on previous version, the request data has unused fields which are now removed. The following fields are removed:

  • typeId
  • subTypeId
 v1.3.0
PUT /hazards Previous implementation is now moved to PUT /hazards/approval.

Existing PUT /hazards endpoint is reused to update hazard data without approval process. Please check the API reference for the new request and response data. 		v1.3.0
PUT /hazards/approval The request is changed to allow consistency with POST /hazards/approval data. The following Field is renamed on response data:

  • date is renamed to reportedDate
 v1.3.0

2. Extended Endpoints

Below are endpoints which had new fields/parameters in their request/response data in this version.

Endpoint Description Version Introduced
GET /events/approvalData action field was added in response data v1.3.0
GET /users new parameters orgStructureRelationshipIds and eventManagerOnly are added v1.3.0

3. New Endpoints

Below are new endpoints created.

Endpoint Version Introduced
GET /associate/details v1.3.0
POST /associate v1.3.0
PUT /associate v1.3.0
DELETE /associate/{id} v1.3.0
PUT /associate/{id}/restore v1.3.0
GET /associate/jobtitles v1.3.0
POST /associate/jobtitle v1.3.0
PUT /associate/jobtitle/{id} v1.3.0
DELETE /associate/jobtitle/{id} v1.3.0
PUT /associate/jobtitle/{id}/restore v1.3.0
GET /hazards/approvalData v1.3.0
GET /hazards/{id}/approvalData v1.3.0
POST /hazards/approval v1.3.0
PUT /hazards/approval v1.3.0
GET /events/includerequireapproval v1.3.1
POST /events/requireapproval v1.3.1
- PUT /events/{id}/requireapproval v1.3.1
GET /hazards/includerequireapproval v1.3.1
POST /hazards/requireapproval v1.3.1
PUT /hazards/{id}/requireapproval v1.3.1