Retrieve factory maintenance config by factory ID
get
/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/factories/{factory-id}
This operation returns information about a factory maintenance config that is specified by factory ID.
Request
Path Parameters
-
factory-id: string
The unique identifier of the factory.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : FactoryMaintenanceConfiguration_receive
Type:
Show Source
object
-
factoryId:
string
The factory id of the factory maintenance config.
-
highProbabilityThreshold:
number
The High Probability threshold for machine failure.
-
id:
string
The unique identifier of the factory maintenance config.
-
lastModifiedBy:
string
The name of the user who last modified the definition of the factory maintenance config.
-
lastModifiedTime:
integer
The time when the factory maintenance config definition was last updated as milliseconds since the epoch.
-
lastModifiedTimeAsString:
integer
The time when the factory maintenance config definition was last updated as an ISO-8601 formatted string.
-
lowProbabilityThreshold:
number
The Low Probability threshold for machine failure.
-
machineTypes:
array machineTypes
The maintenance schedule limits for factory per day.
-
maximumMaintenanceScheduleLimits:
array maximumMaintenanceScheduleLimits
The machine types that need machine failure prediction
-
numberOfDays:
integer
The number of maintenance days of the factory maintenance config.
-
organizationId:
string
The organization identifier for the factory maintenance config
-
registeredBy:
string
The name of the user who registered this factory maintenance config.
-
registrationTime:
integer
The time when the factory maintenance config was registered with the app as an epoch milliseconds.
-
registrationTimeAsString:
integer
The time when the factory maintenance config was registered with the app as an ISO-8601 formatted string.
Nested Schema : machineTypes
Type:
array
The maintenance schedule limits for factory per day.
Show Source
Nested Schema : maximumMaintenanceScheduleLimits
Type:
array
The machine types that need machine failure prediction
Show Source
401 Response
Unauthorized. The request requires user authentication.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
406 Response
Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/factories/{factory-id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"factoryId":"6739212160e9-5275",
"highProbabilityThreshold":0.0,
"id":"10fe1ba4584e-123",
"lastModifiedBy":"The name of the user who last modified the definition of the factory maintenance config.",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"lowProbabilityThreshold":0.0,
"machineTypes":[
"machineTypes_1",
"machineTypes_2",
"machineTypes_3"
],
"maximumMaintenanceScheduleLimits":[
"maximumMaintenanceScheduleLimits_1",
"maximumMaintenanceScheduleLimits_2",
"maximumMaintenanceScheduleLimits_3"
],
"numberOfDays":12345,
"organizationId":"67222068d5-5a1d",
"registeredBy":"The name of the user who registered this factory maintenance config.",
"registrationTime":1469184297746,
"registrationTimeAsString":1469184297746
}
Complete cURL Example
The following example shows a complete cURL command that you can use to perform the described operation:
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/factories/9895eeb105a-475c
Note that in the request,
https://iotserver
will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is
https://myinstance-myidentitydomain.iot.us.oraclecloud.com
and the default port is 443.