REST API for Oracle IoT Production Monitoring Cloud Service

All REST Endpoints

API Versions

API for getting REST API information in production monitoring application

View Available API Versions: Method: get
Path: /productionMonitoring/clientapi/
View Information about Version 2 of the API: Method: get
Path: /productionMonitoring/clientapi/v2/

Factories

API for managing factories in production monitoring application

Create factory: Method: post
Path: /productionMonitoring/clientapi/v2/factories
Delete factory by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}
Replace factory by ID: Method: put
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}
Retrieve all factories: Method: get
Path: /productionMonitoring/clientapi/v2/factories
Retrieve factory by ID: Method: get
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}
Retrieve factory count: Method: get
Path: /productionMonitoring/clientapi/v2/factories/count
Retrieve factory metrics by ID: Method: get
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}/metrics
Retrieve Out-of-Box Factory Dashboard metrics: Method: get
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}/dashboard
Update factory by ID: Method: post
Path: /productionMonitoring/clientapi/v2/factories/{factory-id}

Factory Maintenances

API for managing production maintenances in production monitoring application

Retrieve all factory maintenance configs: Method: get
Path: /productionMonitoring/clientapi/v2/factoryMaintenanceConfigs
Retrieve factory maintenance config by config ID: Method: get
Path: /productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/{config-id}
Retrieve factory maintenance config by factory ID: Method: get
Path: /productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/factories/{factory-id}
Retrieve factory maintenance config count: Method: get
Path: /productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/count

Incidents

The Incidents API lets you manage the incidents in the Oracle IoT Production Monitoring Cloud application.

Add comments to incident: Method: post
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}/comments
Delete incident by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}
Get Incidents Count: Method: get
Path: /productionMonitoring/clientapi/v2/incidents/count
Retrieve all incidents: Method: get
Path: /productionMonitoring/clientapi/v2/incidents
Retrieve count of incident occurrences by ID: Method: get
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count
Retrieve incident by ID: Method: get
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}
Retrieve incident occurrences by incident ID: Method: get
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}/occurrences
Update incident by ID: Method: post
Path: /productionMonitoring/clientapi/v2/incidents/{incident-id}

Machine Types

API for managing machine types in production monitoring application

Create machine type: Method: post
Path: /productionMonitoring/clientapi/v2/machineTypes
Delete machine type by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/machineTypes/{type-id}
Replace machine type by ID: Method: put
Path: /productionMonitoring/clientapi/v2/machineTypes/{type-id}
Retrieve all machine types: Method: get
Path: /productionMonitoring/clientapi/v2/machineTypes
Retrieve machine type by ID: Method: get
Path: /productionMonitoring/clientapi/v2/machineTypes/{type-id}
Retrieve machine type count: Method: get
Path: /productionMonitoring/clientapi/v2/machineTypes/count
Update machine type by ID: Method: post
Path: /productionMonitoring/clientapi/v2/machineTypes/{type-id}

Machines

API for managing machines in production monitoring application

Create machine: Method: post
Path: /productionMonitoring/clientapi/v2/machines
Delete machine by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}
Replace machine by ID: Method: put
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}
Retrieve all machines: Method: get
Path: /productionMonitoring/clientapi/v2/machines
Retrieve machine by ID: Method: get
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}
Retrieve machine contextual data for sensor graph: Method: get
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}/contextData
Retrieve machine count: Method: get
Path: /productionMonitoring/clientapi/v2/machines/count
Retrieve machine incidents by ID: Method: get
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}/incidents
Retrieve machine metrics by ID: Method: get
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}/metrics
Update machine by ID: Method: post
Path: /productionMonitoring/clientapi/v2/machines/{machine-id}

Operator Types

API for managing operator types in production monitoring application

Create operator type: Method: post
Path: /productionMonitoring/clientapi/v2/operatorTypes
Delete operator type by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/operatorTypes/{type-id}
Get all operator types: Method: get
Path: /productionMonitoring/clientapi/v2/operatorTypes
Replace operator type by ID: Method: put
Path: /productionMonitoring/clientapi/v2/operatorTypes/{type-id}
Retrieve operator type by ID: Method: get
Path: /productionMonitoring/clientapi/v2/operatorTypes/{type-id}
Retrieve operator type count: Method: get
Path: /productionMonitoring/clientapi/v2/operatorTypes/count
Update operator type by ID: Method: post
Path: /productionMonitoring/clientapi/v2/operatorTypes/{type-id}

Operators

API for managing operators in production monitoring application

Create operator: Method: post
Path: /productionMonitoring/clientapi/v2/operators
Delete operator by id: Method: delete
Path: /productionMonitoring/clientapi/v2/operators/{operator-username}
Get all operators: Method: get
Path: /productionMonitoring/clientapi/v2/operators
Get operator by id: Method: get
Path: /productionMonitoring/clientapi/v2/operators/{operator-username}
Get operator count: Method: get
Path: /productionMonitoring/clientapi/v2/operators/count
Replace operator by id: Method: put
Path: /productionMonitoring/clientapi/v2/operators/{operator-username}
Update operator by id: Method: post
Path: /productionMonitoring/clientapi/v2/operators/{operator-username}

Production Lines

API for managing production lines in production monitoring application

Retrieve all production lines: Method: get
Path: /productionMonitoring/clientapi/v2/productionLines
Retrieve production line by ID: Method: get
Path: /productionMonitoring/clientapi/v2/productionLines/{line-id}
Retrieve production line count: Method: get
Path: /productionMonitoring/clientapi/v2/productionLines/count

Production Plans

API for managing production plans in production monitoring application

Add production output details: Method: post
Path: /productionMonitoring/clientapi/v2/productionPlans/{plan-id}/output
Delete a given production plan: Method: delete
Path: /productionMonitoring/clientapi/v2/productionPlans/{plan-id}
Delete all production plans: Method: delete
Path: /productionMonitoring/clientapi/v2/productionPlans
Retrieve all production plans: Method: get
Path: /productionMonitoring/clientapi/v2/productionPlans
Retrieve production plan count: Method: get
Path: /productionMonitoring/clientapi/v2/productionPlans/count
Retrieve production plan information: Method: get
Path: /productionMonitoring/clientapi/v2/productionPlans/{plan-id}

Products

API for managing products in production monitoring application

Create product: Method: post
Path: /productionMonitoring/clientapi/v2/products
Delete product by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/products/{product-id}
Replace product by ID: Method: put
Path: /productionMonitoring/clientapi/v2/products/{product-id}
Retrieve all products: Method: get
Path: /productionMonitoring/clientapi/v2/products
Retrieve digital birth certificate: Method: get
Path: /productionMonitoring/clientapi/v2/products/digitalBirthCertificate
Retrieve product by ID: Method: get
Path: /productionMonitoring/clientapi/v2/products/{product-id}
Retrieve product count: Method: get
Path: /productionMonitoring/clientapi/v2/products/count
Update product by ID: Method: post
Path: /productionMonitoring/clientapi/v2/products/{product-id}

Routing Tasks

API for managing routing tasks in production monitoring application

Retrieve all routing tasks: Method: get
Path: /productionMonitoring/clientapi/v2/routingTasks
Retrieve routing task by ID: Method: get
Path: /productionMonitoring/clientapi/v2/routingTasks/{task-id}
Retrieve routing task count: Method: get
Path: /productionMonitoring/clientapi/v2/routingTasks/count

Rules

API for managing rules in production monitoring application

Create rule: Method: post
Path: /productionMonitoring/clientapi/v2/rules
Delete rule by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/rules/{rule-id}
Get Rules Count: Method: get
Path: /productionMonitoring/clientapi/v2/rules/count
Retrieve all rules: Method: get
Path: /productionMonitoring/clientapi/v2/rules
Retrieve rule by ID: Method: get
Path: /productionMonitoring/clientapi/v2/rules/{rule-id}
Update rule by ID: Method: post
Path: /productionMonitoring/clientapi/v2/rules/{rule-id}

Warnings

API for managing warnings in production monitoring application

Delete warning by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/warnings/{warning-id}
Get Warnings Count: Method: get
Path: /productionMonitoring/clientapi/v2/warnings/count
Retrieve all warnings: Method: get
Path: /productionMonitoring/clientapi/v2/warnings
Retrieve warning by ID: Method: get
Path: /productionMonitoring/clientapi/v2/warnings/{warning-id}
Update warning by ID: Method: post
Path: /productionMonitoring/clientapi/v2/warnings/{warning-id}

Work Orders

API for managing work orders in production monitoring application. A work order refers to a document that conveys the authority for the production of a specific product.

Create work order: Method: post
Path: /productionMonitoring/clientapi/v2/workOrders
Delete work order by ID: Method: delete
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}
Replace work order by ID: Method: put
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}
Retrieve all operation tasks: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}/tasks
Retrieve all work order operations: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations
Retrieve all work orders: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders
Retrieve operation task by ID: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}/tasks/{task-id}
Retrieve operation task count: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}/tasks/count
Retrieve work order by ID: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}
Retrieve work order count: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/count
Retrieve work order operation by ID: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/{operation-id}
Retrieve work order operation count: Method: get
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}/operations/count
Update work order by ID: Method: post
Path: /productionMonitoring/clientapi/v2/workOrders/{workOrder-id}