Jump to

• Request
• Response
• Examples

Retrieve all production lines

get

/productionMonitoring/clientapi/v2/productionLines

This operation retrieves information about all production lines.

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
  Ordering criteria for the returned production line list.
• q(optional): string
  Query to filter production lines 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.

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_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":{
                    "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"
            },
            "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":{
            "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"
    },
    "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

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

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.

Back to Top

Examples

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

Example of Response Body

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

{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "description":"The description about the production line.",
            "factory":"The reference to the factory that the production line belongs to.",
            "id":"4a92604c4c93-3f77",
            "machines":[
                "machines_1",
                "machines_2",
                "machines_3"
            ],
            "name":"The unique name of the production line."
        },
        {
            "description":"The description about the production line.",
            "factory":"The reference to the factory that the production line belongs to.",
            "id":"2242324620e3-6904",
            "machines":[
                "machines_1",
                "machines_2",
                "machines_3"
            ],
            "name":"The unique name of the production line."
        }
    ],
    "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/productionLines 

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