Jump to

• Request
• Response
• Examples

Retrieve factory maintenance config by config ID

get

/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/{config-id}

This operation returns information about a factory maintenance config that is specified by its ID.

Request

Path Parameters

• config-id: string
  The unique identifier of the factory maintenance config.

Query Parameters

• expand(optional): string
  The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Body ()

Root Schema : FactoryMaintenanceConfiguration_receive

Type: object

Show Source

• 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.

{
    "properties":{
        "factoryId":{
            "description":"The factory id of the factory maintenance config.",
            "type":"string"
        },
        "highProbabilityThreshold":{
            "description":"The High Probability threshold for machine failure.",
            "type":"number"
        },
        "id":{
            "description":"The unique identifier of the factory maintenance config.",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"The name of the user who last modified the definition of the factory maintenance config.",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"The time when the factory maintenance config definition was last updated as milliseconds since the epoch.",
            "type":"integer"
        },
        "lastModifiedTimeAsString":{
            "description":"The time when the factory maintenance config definition was last updated as an ISO-8601 formatted string.",
            "type":"integer"
        },
        "lowProbabilityThreshold":{
            "description":"The Low Probability threshold for machine failure.",
            "type":"number"
        },
        "machineTypes":{
            "description":"The maintenance schedule limits for factory per day.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "maximumMaintenanceScheduleLimits":{
            "description":"The machine types that need machine failure prediction",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "numberOfDays":{
            "description":"The number of maintenance days of the factory maintenance config.",
            "type":"integer"
        },
        "organizationId":{
            "description":"The organization identifier for the factory maintenance config",
            "type":"string"
        },
        "registeredBy":{
            "description":"The name of the user who registered this factory maintenance config.",
            "type":"string"
        },
        "registrationTime":{
            "description":"The time when the factory maintenance config was registered with the app as an epoch milliseconds.",
            "type":"integer"
        },
        "registrationTimeAsString":{
            "description":"The time when the factory maintenance config was registered with the app as an ISO-8601 formatted string.",
            "type":"integer"
        }
    },
    "required":[
        "id",
        "factoryId",
        "numberOfDays",
        "maximumMaintenanceScheduleLimits",
        "machineTypes",
        "highProbabilityThreshold",
        "lowProbabilityThreshold",
        "organizationId",
        "registrationTime",
        "registrationTimeAsString",
        "registeredBy",
        "lastModifiedTime",
        "lastModifiedTimeAsString",
        "lastModifiedBy"
    ],
    "type":"object"
}

Nested Schema : machineTypes

Type: array

The maintenance schedule limits for factory per day.

Show Source

• Array of: string

{
    "description":"The maintenance schedule limits for factory per day.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : maximumMaintenanceScheduleLimits

Type: array

The machine types that need machine failure prediction

Show Source

• Array of: string

{
    "description":"The machine types that need machine failure prediction",
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

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.

Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs/{config-id} 

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "factoryId":"15eb78213824-7547",
    "highProbabilityThreshold":0.0,
    "id":"b4312de1444-7ce2",
    "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":"4678499e63db-5479",
    "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/34b729a01803-5427 

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.

Back to Top