NextGen APIs

Integration API Suite

Assets Domain

GET /integration/assets/r1/assets : Integration API to get all details about an Asset with its Address

POST /integration/assets/r1/assets: Integration API to create or update an Asset

GET /integration/assets/r1/accounts: Integration API to get all details about an Account with its Address

POST /integration/assets/r1/accounts: Integration API to create or update an Account

Work Orders Domain

GET /integration/work-orders/r1/work-orders: Integration API to get all details about a Work Order with all its Operations

POST /integration/work-orders/r1/work-orders: Integration API to create a new Work Order on a Account or on an Asset, depends on input object. If Account does not exist in internal configuration, system creates it. Otherwise, system creates a default account.

PATCH /integration/work-orders/r1/work-orders: Integration API to update a Work Order and/or its Operations

Workforce Domain

POST /integration/workforce/r1/resources: Integration API to insert or update a Resource with his addresses

POST /integration/workforce/r1/resource-skills: Integration API to create or update the relationship between a Resource and its Skills

PATCH /integration/workforce/r1/work-shift-types/{workShiftTypeCode}: Integration API to update a Workshift type

POST /integration/workforce/r1/work-shift-types: Integration API to create a new Workshift type

DELETE /integration/workforce/r1/work-shift-exceptions: Integration API to delete in batch Work Shift Exception records, filtered by resource’s identificationNumber, work shift exception’s type code, startDate and endDate input parameters

POST /integration/workforce/r1/work-shift-exceptions: Integration API to create in batch Work Shift Exception records associating them to the Resource retrieved by the identificationNumber in input

PATCH /integration/workforce/r1/work-shift-exceptions: Integration API to update in batch Work Shift Exception records associated to the Resource retrieved by the identificationNumber in input

POST /integration/workforce/r1/work-shifts: Integration API to create a new Work Shift

PATCH /integration/workforce/r1/work-shifts: Integration API to update the required Work Shift

DELETE /integration/workforce/r1/work-shifts: Integration API to delete the required Work Shift

POST /integration/workforce/r1/work-shift-exception-types: Integration API to create a new Work Shift Exception Type

Configurations Domain

POST /integration/configurations/r1/characteristics: Integration API to create or update a Characteristic for Asset

POST /integration/configurations/r1/asset-characteristics-value: Integration API to create or update an Asset Characteristic value

POST /integration/configurations/r1/asset-type-characteristics: Integration API to create or update an Asset Type characteristic

Scheduling Domain

POST /integration/scheduling/manual/r1/scheduling/activities-assignments: Integration API to assign a single work order operation to a scheduling resource

Inventory Domain

POST /integration/inventory/r1/materials: Integration API to create or update material’s registry

DELETE /integration/inventory/r1/materials/{code}: Integration API to delete the required material’s registry