REST API for Oracle IoT Connected Worker Cloud Service

All REST Endpoints

Certificate Type - Certificate

The Certificate Type-Certificate Associations API lets you manage and maintain the certificate type-certificate associations in your Oracle IoT Connected Worker Cloud Service instance.

Get certificate type - certificate associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificateTypes/{certificateTypeId}/certificates
Get details of a certificate type - certificate association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificateTypes/{certificateTypeId}/certificates/{certificateId}

Certificate Types

The Certificate Types API lets you manage and maintain the certificate types in your Oracle IoT Connected Worker Cloud Service instance.

Get certificate types.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificateTypes
Get details of a certificate type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificateTypes/{certificateTypeId}

Certificates

The Certificates API lets you manage and maintain the certificates in your Oracle IoT Connected Worker Cloud Service instance.

Get certificates.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificates
Get details of a certificate.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/certificates/{certificateId}

Employee - Alerts

The Employee Alerts API lets you manage and maintain the employee alerts in your Oracle IoT Connected Worker Cloud Service instance.

Get an employee alert.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/alerts/{alertId}
Get employee alerts.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/alerts
Get the status of the alert.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/alerts/{alertId}/status

Employee - Certificates

The Employee-Certificates API lets you manage and maintain associations between employee and certificates in your Oracle IoT Connected Worker Cloud Service instance.

Download the image of an employee certificate scan.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/certificates/{certificateId}/scan
Get details of an employee - certificate association.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/certificates/{certificateId}
Get employee - certificate associations.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/certificates

Employee - Checked State

The Checked State API lets you manage and maintain the checked state and checked work shift in your Oracle IoT Connected Worker Cloud Service instance.

Get associated work shift of an employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/checkedState/workShift
Get checked state of an employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/checkedState

Employee - Device Provisionings

The Device Provisioning API lets you manage and maintain the device provisioning for Oracle IoT Connected Worker Cloud Service instance.

Get device provisioning.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/deviceProvisionings/{provisioningId}
Get device provisionings.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/deviceProvisionings
Get latest device provisioning.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/deviceProvisionings/latest

Employee - Logged-in Devices

The Employee-Device Association API lets you manage and maintain the employee-device associations in your Oracle IoT Connected Worker Cloud Service instance.

Get devices that an employee is currently logged in.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/loggedInDevices
Get logged-in device of an employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/loggedInDevices/{deviceId}

Employee - Messages

The Chat Messages API lets you manage and maintain the chat messages in your Oracle IoT Connected Worker Cloud Service instance.

Get a chat message.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/messages/{messageId}
Get incoming chat messages.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/messages

Employee Wearable Type - Sensor Attribute - Devices

The Employee Wearable Type-Sensor Attribute-Devices Sensor Association API lets you manage and maintain the associations among Employee Wearable Type-Sensor Attribute-Devices in your Oracle IoT Connected Worker Cloud Service instance.

Get an employee sensor device association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}/sensorAttributes/{sensorAttributeId}/devices/{deviceId}
Get an employee sensor device association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes/{typeId}/sensorAttributes/{sensorAttributeId}/devices/{deviceId}
Get employee sensor device associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}/sensorAttributes/{sensorAttributeId}/devices
Get employee sensor device associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes/{typeId}/sensorAttributes/{sensorAttributeId}/devices

Employee Wearable Type - Sensor Attributes

The Sensor Attributes API lets you manage and maintain the sensor attributes for employee wearable type in your Oracle IoT Connected Worker Cloud Service instance.

Get a specific sensor attribute within employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}/sensorAttributes/{sensorAttributeId}
Get a specific sensor attribute within employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes/{typeId}/sensorAttributes/{sensorAttributeId}
Get sensor attributes within employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}/sensorAttributes
Get sensor attributes within employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes/{typeId}/sensorAttributes

Employee Wearable Types

The Employee Wearable Types API lets you manage and maintain the employee types in your Oracle IoT Connected Worker Cloud Service instance.

Get a specific employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes/{typeId}
Get a specific employee wearable type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes/{typeId}
Get employee wearable types.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeTypes
Get employee wearable types.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/employeeWearableTypes

Employees

The Employees API lets you manage and maintain the employees and their entities in your Oracle IoT Connected Worker Cloud Service instance. Employees are users having a CW role and are associated with at least one project.

Get an employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}
Get available static roles.: Method: get
Path: /connectedWorker/clientapi/v2/employees/roles
Get current location(s) of an employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/{employeeId}/locations
Get currently logged-in employee.: Method: get
Path: /connectedWorker/clientapi/v2/employees/myself
Get employees.: Method: get
Path: /connectedWorker/clientapi/v2/employees

Endpoints

The Endpoints API lets you manage and maintain the endpoints in your Oracle IoT Connected Worker Cloud Service instance. Read operations on this API can be performed by user having IoTCWProjectManager role or higher. Other operations can be performed by users having IoTCWAdministrator role.

Get details of an endpoint.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/endpoints/{endpointId}
Get endpoints.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/endpoints

Global configurations

The Global configurations API lets you manage and maintain the configuration of your Oracle IoT Connected Worker Cloud Service instance.

Get details of a global configuration by key.: Method: get
Path: /connectedWorker/clientapi/v2/configurations/{key}
Get Global configurations.: Method: get
Path: /connectedWorker/clientapi/v2/configurations

Incident - Comments

The Incident Comments API lets you manage and maintain the comments for incident in your Oracle IoT Connected Worker Cloud Service instance.

Get an incident comment.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/comments/{commentId}
Get incident comments.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/comments

Incident - Occurrences

The Incident Occurrences API lets you view the occurrences of incident in your Oracle IoT Connected Worker Cloud Service instance.

Get an incident occurrence.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/occurrences/{occurrenceId}
Get incident occurrences.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/occurrences

Incidents

The Incidents API lets you manage and maintain the incidents in your Oracle IoT Connected Worker Cloud Service instance.

Get an incident.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}
Get employees affected by the given incident.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/employees
Get incidents.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents
Get locations affected by the given incident.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/locations
Get projects affected by the given incident.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/incidents/{incidentId}/projects

Jobs

The Jobs API lets you view the jobs in your Oracle IoT Connected Worker Cloud Service instance. Read operations can be performed by users having IoTCWSupervisor role or higher.

Get jobs.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/jobs
Returns specific job.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/jobs/{jobId}

Location Type - Sensor Attributes

The Sensor Attributes API lets you manage and maintain the sensor attributes for location type in your Oracle IoT Connected Worker Cloud Service instance.

Get a specific sensor attribute within location type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/locationTypes/{typeId}/sensorAttributes/{sensorAttributeId}
Get sensor attributes within location type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/locationTypes/{typeId}/sensorAttributes

Location Types

The Location Types API lets you manage and maintain the location types in your Oracle IoT Connected Worker Cloud Service instance.

Get a specific location type.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/locationTypes/{typeId}
Get location types.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/locationTypes

Organization - Configurations

The Organization Configurations API lets you manage and maintain the organization specific configuration in Oracle IoT Connected Worker Cloud Service instance. Note that these configurations are Connected Worker specific.

Get a specific configuration information of an organization.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/configurations/{key}
Get organization configurations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/configurations

Organizations

The Organizations API lets you manage and maintain the organizations and organization aware entities in your Oracle IoT Connected Worker Cloud Service instance. Note that CUD operations done using this API affects all vertical applications.

Get details of an organization.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}
Get organizations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs

Positionings

The Positionings API lets you manage and maintain the positioning technologies in your Oracle IoT Connected Worker Cloud Service instance. Read operations on this API can be performed by user having IoTCWProjectManager role or higher. Other operations can be performed by users having IoTCWAdministrator role.

Get details of a positioning technology.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/positionings/{positioningId}
Get positioning technologies.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/positionings

Project - Asset Integration - Certificate Types

The Asset Integration-Certificate Type Associations API lets you manage and maintain the Asset integration-Certificate type associations in your Oracle IoT Connected Worker Cloud Service instance.

Get certificate type associated with the integration with Asset Monitoring Cloud Service.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations/{assetIntegrationId}/certificateTypes/{certificateTypeId}
Get certificate types associated with the integration with Asset Monitoring Cloud Service: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations/{assetIntegrationId}/certificateTypes

Project - Asset Integrations

The Asset Type Integration API lets you manage and maintain integrations with Asset Monitoring Cloud Service in your Oracle IoT Connected Worker Cloud Service.

Get details of an integration with Asset Monitoring Cloud Service.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations/{assetIntegrationId}
Get integrations with Asset Monitoring Cloud Service.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations
Get locations created by the integration with Asset Monitoring Cloud Service.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/assetIntegrations/{assetIntegrationId}/locations

Project - Certificate Types

The Project-Certificate types Associations API lets you manage and maintain the project-certificate types associations in your Oracle IoT Connected Worker Cloud Service instance.

Get details of a project - certificate type association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/certificateTypes/{certificateTypeId}
Get project - certificate type associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/certificateTypes

Project - Configurations

The Project Configurations API lets you manage and maintain the project specific configurations in your Oracle IoT Connected Worker Cloud Service instance.

Get a specific configuration of a project.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/configurations/{key}
Get configurations of a project.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/configurations

Project - Hazard - Comments

The Hazard Comments API lets you manage and maintain the comments for hazard in your Oracle IoT Connected Worker Cloud Service instance.

Get a hazard comment.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/comments/{commentId}
Get comments for hazard.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/comments

Project - Hazards

The Hazards API lets you manage and maintain hazards in your Oracle IoT Connected Worker Cloud Service instance. Note that Hazard or HazardLocation can be resolved only by employee with role IoTCWSupervisor or higher.

Get a hazard location.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/locations/{locationId}
Get hazard details.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}
Get hazard locations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/locations
Get hazards.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards
Get the status of a hazard location.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/locations/{locationId}/status
Get the status of a hazard.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/hazards/{hazardId}/status

Project - Location - Certificate Types

The Location - Certificate types API lets you manage and maintain the associations between Location and Certificate types in your Oracle IoT Connected Worker Cloud Service instance.

Get details of a location - certificate type association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/certificateTypes/{certificateTypeId}
Get location - certificate type associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/certificateTypes

Project - Location - Sensor Data Providers

The Location - Location type - Sensor Data Provider Association API lets you manage and maintain the location - location type - data providers associations in your Oracle IoT Connected Worker Cloud Service instance.

Get location - location type - sensor data provider associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/sensorTypeProviders
Get the specific location - location type - sensor data provider association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/sensorTypeProviders/{locationTypeId}/sensorAttributes/{sensorAttributeId}

Project - Location Plans

The Location Plans API lets you manage and maintain location plans in your Oracle IoT Connected Worker Cloud Service instance. Note that read operations can be performed by any user assigned to the project that the location plan belongs to.

Download an image of a location plan.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locationPlans/{locationPlanId}/image
Get location plans.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locationPlans
Get the location plan defined in a project.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locationPlans/{locationPlanId}

Project - Locations

The Locations API lets you manage and maintain the locations in your Oracle IoT Connected Worker Cloud Service instance. Note that read operations can be performed by any user assigned to the project. The returned response contains only location(s), that are accessible by the user.

Get incidents for a specific location.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/incidents
Get the children locations of a location.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}/children
Get the location details.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations/{locationId}
Get top level locations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locations

Project - Positionings

The Project-Positionings Associations API lets you manage and maintain the project-positioning associations in your Oracle IoT Connected Worker Cloud Service instance.

Get details of project - positioning technology associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/positionings/{positioningId}
Get project - positioning technology associations.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/positionings

Project - Work Shifts

The Project-WorkShifts Associations API lets you manage and maintain the project-workShifts associations in your Oracle IoT Connected Worker Cloud Service instance.

Get details of a project - work shift association.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/workShifts/{workShiftId}
Get work shifts associated with the project.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/workShifts

Project Assignments

The Project-Employee Associations API lets you manage and maintain the project-employee associations in your Oracle IoT Connected Worker Cloud Service instance.

Get details about project assignment.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/employees/{employeeId}
Get project assignments.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/employees

Projects

The Projects API lets you manage and maintain the projects and project aware entities in your Oracle IoT Connected Worker Cloud Service instance. Read operations on this API can be performed by any authenticated user. The response contains only the project(s), that are accessible to the user. If an user invokes a read operation on a project that he doesn't have access to, then the response with code 403 is returned.

Download the image of a project logo.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/logo
Get details of a project.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}
Get projects.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/projects

Work Shifts

The Work Shifts API lets you manage and maintain the work shifts in your Oracle IoT Connected Worker Cloud Service instance.

Get details of a work shift.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/workShifts/{workShiftId}
Get work shifts.: Method: get
Path: /connectedWorker/clientapi/v2/orgs/{orgId}/workShifts