1. REST API for Oracle IoT Production Monitoring Cloud Service
  2. Tasks
  3. Factories

Retrieve factory by ID

get

/productionMonitoring/clientapi/v2/factories/{factory-id}

This operation returns information about a factory that is specified by its ID. This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.

Request

Path Parameters
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Header Parameters
  • This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : Factory_receive
Type: object
Show Source
Nested Schema : FactoryManager_receive
Type: object
Show Source
Nested Schema : floorPlans
Type: array
The list of floor plans for the factory.
Show Source
Nested Schema : metrics
Type: object
Set of factory metrics
Show Source
Nested Schema : productionLines
Type: array
The list of identifiers of production lines that are part of this factory.
Show Source
Nested Schema : FactoryFloorPlan_receive
Type: object
Show Source
Nested Schema : image
Type: object
The reference ID for the factory floor plan image.
Show Source
Nested Schema : FloorPlanReferencePoints_receive
Type: object
Show Source

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/factories/{factory-id}

Example of Response Body

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


{
    "address":"The street address of the factory.",
    "code":"The unique code of the factory.",
    "description":"The description of the factory.",
    "extId":"5ca77f62645c-2822",
    "factoryManager":{
        "email":"The email address of the factory manager.",
        "name":"The name of the factory manager.",
        "phone":"The phone number of the factory manager."
    },
    "floorPlans":[
        {
            "externalId":"1fbb554a4529-498d",
            "id":"7af74aaa7612-7f98",
            "image":{
                "links":[
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"self"
                    },
                    {
                        "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                        "rel":"canonical"
                    }
                ]
            },
            "name":"The unique name of the factory floor plan.",
            "organizationId":"6c17c7e498d-41b1",
            "referencePoints":{
                "imageP1":"Coordinates of the first point on image.",
                "imageP2":"Coordinates of the second point on image",
                "mapP1":"Geographic coordinates of the first point",
                "mapP2":"Geographic coordinates of the second point"
            }
        }
    ],
    "geoLocation":"The geographic location of the factory specified as {latitude},{longitude}.",
    "id":"41df683640d3-2660",
    "integrationId":"2342e2f14fb-1bbc",
    "iotEnabled":false,
    "lastModifiedBy":"The name of the user who last modified the definition of the factory.",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "metrics":{
        "links":[
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "name":"The unique name of the factory.",
    "productionLines":[
        "productionLines_1",
        "productionLines_2",
        "productionLines_3"
    ],
    "registeredBy":"The name of the user who registered this factory.",
    "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/factories/3e5b39864323-320f



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