REST API for Oracle IoT Production Monitoring Cloud Service

Retrieve all factory maintenance configs

get

/productionMonitoring/clientapi/v2/factoryMaintenanceConfigs

This operation returns information about all the factory maintenance configs that are filtered by a query.

Request

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.
limit(optional): integer

The maximum number of entries to return to the end user.
offset(optional): integer

The number that the first record of results is starting from.
orderBy(optional): string

The ordering criteria for the returned routing task list.
q(optional): string

The query to filter routing tasks on the server. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
since(optional): integer

The starting point of the desired time interval, in milliseconds. The default is 0.
totalResults(optional): boolean

The total number of results suiting the request.
until(optional): integer

The finishing point of the desired time interval, in milliseconds. The default is 0.

Response

Supported Media Types

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

200 Response

Successfully processed.

Root Schema : FactoryMaintenanceConfiguration_receive_list

Type: object

Show Source

count: integer(int32)
hasMore: boolean
items: array items
limit: integer(int32)
links: array links

The set of API navigation links.
offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "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"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "items":{
        "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"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "description":"The set of API navigation links.",
    "items":{
        "properties":{
            "href":{
                "description":"The target resource URI",
                "example":"https://iotserver/iot/api/vX/some/API/path",
                "type":"string"
            },
            "rel":{
                "description":"Relation type",
                "example":"canonical",
                "type":"string"
            }
        },
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

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"
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "properties":{
        "href":{
            "description":"The target resource URI",
            "example":"https://iotserver/iot/api/vX/some/API/path",
            "type":"string"
        },
        "rel":{
            "description":"Relation type",
            "example":"canonical",
            "type":"string"
        }
    },
    "type":"object"
}

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.

Examples

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

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "factoryId":"467952e03c86-4840",
            "highProbabilityThreshold":0.0,
            "id":"42a13d407da6-41be",
            "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":"6afd4ab34b81-126e",
            "registeredBy":"The name of the user who registered this factory maintenance config.",
            "registrationTime":1469184297746,
            "registrationTimeAsString":1469184297746
        },
        {
            "factoryId":"66883f113126-42d3",
            "highProbabilityThreshold":0.0,
            "id":"459d34cf1fd9-34e5",
            "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":"5b2117813217-44",
            "registeredBy":"The name of the user who registered this factory maintenance config.",
            "registrationTime":1469184297746,
            "registrationTimeAsString":1469184297746
        }
    ],
    "limit":10,
    "links":[
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"self"
        },
        {
            "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
            "rel":"canonical"
        }
    ],
    "offset":0
}

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

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.