Jump to

• Request
• Response
• Examples

Retrieve production line by ID

get

/productionMonitoring/clientapi/v2/productionLines/{line-id}

This operation retrieves information about the specified production line.

Request

Path Parameters

• line-id: string
  The unique identifier of the production line.

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 : ProductionLine_receive

Type: object

Show Source

• description: string
  The description about the production line.
• factory: string
  The reference to the factory that the production line belongs to.
• id: string
  The unique identifier of the production line.
• machines: array machines
  The list of identifiers of machines that are part of the production line.
• name: string
  The unique name of the production line.

{
    "properties":{
        "description":{
            "description":"The description about the production line.",
            "type":"string"
        },
        "factory":{
            "description":"The reference to the factory that the production line belongs to.",
            "type":"string"
        },
        "id":{
            "description":"The unique identifier of the production line.",
            "type":"string"
        },
        "machines":{
            "description":"The list of identifiers of machines that are part of the production line.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "name":{
            "description":"The unique name of the production line.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "name",
        "description",
        "factory",
        "machines"
    ],
    "type":"object"
}

Nested Schema : machines

Type: array

The list of identifiers of machines that are part of the production line.

Show Source

• Array of: string

{
    "description":"The list of identifiers of machines that are part of the production line.",
    "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/productionLines/{line-id} 

Example of Response Body

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

{
    "description":"The description about the production line.",
    "factory":"The reference to the factory that the production line belongs to.",
    "id":"6462504e2b6f-138f",
    "machines":[
        "machines_1",
        "machines_2",
        "machines_3"
    ],
    "name":"The unique name of the production line."
} 

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/productionLines/1d7320a73d97-7f3f 

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