REST API for Oracle Internet of Things Cloud Service

Create a New Device

post

/iot/api/v2/devices

Request

Supported Media Types

application/json

Root Schema : DeviceImpl_create

Type: object

Show Source

description(optional): string

Property description was not set
deviceUID: string

Property description was not set
endpointName(optional): string

Property description was not set
manufacturer(optional): string

Property description was not set
modelNumber(optional): string

Property description was not set
serialNumber(optional): string

Property description was not set

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "deviceUID":{
            "description":"Property description was not set",
            "type":"string"
        },
        "endpointName":{
            "description":"Property description was not set",
            "type":"string"
        },
        "manufacturer":{
            "description":"Property description was not set",
            "type":"string"
        },
        "modelNumber":{
            "description":"Property description was not set",
            "type":"string"
        },
        "serialNumber":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "deviceUID"
    ],
    "type":"object"
}

Response

Supported Media Types

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

201 Response

Successfully processed.

Root Schema : DeviceImpl_receive

Type: object

Show Source

childrenDevices: object childrenDevices

Property description was not set
connectivityStatus: object ConnectivityStatus_receive
created: integer

Property description was not set
createdAsLong: integer

Property description was not set
description: string

Property description was not set
deviceModels: array deviceModels

Property description was not set
deviceType: string

One of [UNKNOWN, GATEWAY, DIRECTLY_CONNECTED_DEVICE, INDIRECTLY_CONNECTED_DEVICE].
deviceUID: string

Property description was not set
directlyConnectedOwner: object directlyConnectedOwner
enabled: boolean

Property description was not set
endpointId: string

Property description was not set
endpointName: string

Property description was not set
enrollmentTime: integer

Property description was not set
enrollmentTimeAsLong: integer

Property description was not set
hardwareRevision: string

Property description was not set
lastHeardTime: integer

Property description was not set
lifecycleState: string

One of [REGISTERED, ACTIVATED, ENABLED, DISABLED, DECOMMISSIONED, UNKNOWN].
location: object location
logs: object Logs_receive
manufacturer: string

Property description was not set
metadata: object metadata

Property description was not set
modelNumber: string

Property description was not set
partnerName: string

Property description was not set
resources: object resources

Property description was not set
serialNumber: string

Property description was not set
sharedSecret: string

Property description was not set
softwareRevision: string

Property description was not set
softwareVersion: string

Property description was not set

{
    "properties":{
        "childrenDevices":{
            "description":"Property description was not set",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "connectivityStatus":{
            "$ref":"#/definitions/ConnectivityStatus_receive"
        },
        "created":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "createdAsLong":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "deviceModels":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelModel_receive"
            },
            "type":"array"
        },
        "deviceType":{
            "description":"One of [UNKNOWN, GATEWAY, DIRECTLY_CONNECTED_DEVICE, INDIRECTLY_CONNECTED_DEVICE].",
            "type":"string"
        },
        "deviceUID":{
            "description":"Property description was not set",
            "type":"string"
        },
        "directlyConnectedOwner":{
            "description":"",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "enabled":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "endpointId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "endpointName":{
            "description":"Property description was not set",
            "type":"string"
        },
        "enrollmentTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "enrollmentTimeAsLong":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "hardwareRevision":{
            "description":"Property description was not set",
            "type":"string"
        },
        "lastHeardTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "lifecycleState":{
            "description":"One of [REGISTERED, ACTIVATED, ENABLED, DISABLED, DECOMMISSIONED, UNKNOWN].",
            "type":"string"
        },
        "location":{
            "description":"",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "logs":{
            "$ref":"#/definitions/Logs_receive"
        },
        "manufacturer":{
            "description":"Property description was not set",
            "type":"string"
        },
        "metadata":{
            "description":"Property description was not set",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "modelNumber":{
            "description":"Property description was not set",
            "type":"string"
        },
        "partnerName":{
            "description":"Property description was not set",
            "type":"string"
        },
        "resources":{
            "description":"Property description was not set",
            "properties":{
                "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"
                }
            },
            "type":"object"
        },
        "serialNumber":{
            "description":"Property description was not set",
            "type":"string"
        },
        "sharedSecret":{
            "description":"Property description was not set",
            "type":"string"
        },
        "softwareRevision":{
            "description":"Property description was not set",
            "type":"string"
        },
        "softwareVersion":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "serialNumber",
        "endpointId",
        "manufacturer",
        "modelNumber",
        "hardwareRevision",
        "softwareRevision",
        "deviceUID",
        "softwareVersion",
        "deviceModels",
        "childrenDevices",
        "deviceType",
        "logs",
        "resources",
        "location",
        "enabled",
        "metadata",
        "endpointName",
        "sharedSecret",
        "enrollmentTime",
        "lifecycleState",
        "partnerName",
        "directlyConnectedOwner",
        "lastHeardTime",
        "createdAsLong",
        "enrollmentTimeAsLong",
        "connectivityStatus",
        "created",
        "description"
    ],
    "type":"object"
}

Nested Schema : childrenDevices

Type: object

Property description was not set

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"Property description was not set",
    "properties":{
        "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"
        }
    },
    "type":"object"
}

Nested Schema : ConnectivityStatus_receive

Type: object

Show Source

lastHeardEpochTime: integer

Property description was not set
onlineSinceEpochTime: integer

Property description was not set
onlineSinceTime: integer

Property description was not set
status: string

One of [NEVER_HEARD_FROM, OFFLINE, ONLINE].

{
    "properties":{
        "lastHeardEpochTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "onlineSinceEpochTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "onlineSinceTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "status":{
            "description":"One of [NEVER_HEARD_FROM, OFFLINE, ONLINE].",
            "type":"string"
        }
    },
    "required":[
        "lastHeardEpochTime",
        "onlineSinceTime",
        "onlineSinceEpochTime",
        "status"
    ],
    "type":"object"
}

Nested Schema : deviceModels

Type: array

Property description was not set

Show Source

Array of: object DeviceModelModel_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/DeviceModelModel_receive"
    },
    "type":"array"
}

Nested Schema : directlyConnectedOwner

Type: object

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"",
    "properties":{
        "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"
        }
    },
    "type":"object"
}

Nested Schema : location

Type: object

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"",
    "properties":{
        "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"
        }
    },
    "type":"object"
}

Nested Schema : Logs_receive

Type: object

Show Source

logCount: integer

Property description was not set
logs: object LogBuffer_receive
logType: string

One of [ACTIVATION].

{
    "properties":{
        "logCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "logType":{
            "description":"One of [ACTIVATION].",
            "type":"string"
        },
        "logs":{
            "$ref":"#/definitions/LogBuffer_receive"
        }
    },
    "required":[
        "logType",
        "logCount",
        "logs"
    ],
    "type":"object"
}

Nested Schema : metadata

Type: object

Property description was not set

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"Property description was not set",
    "properties":{
        "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"
        }
    },
    "type":"object"
}

Nested Schema : resources

Type: object

Property description was not set

Show Source

links(optional): array links

The set of API navigation links.

{
    "description":"Property description was not set",
    "properties":{
        "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"
        }
    },
    "type":"object"
}

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

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

Nested Schema : DeviceModelModel_receive

Type: object

Show Source

actions: array actions

Property description was not set
attributes: array attributes

Property description was not set
created: integer

Property description was not set
createdAsDate: integer

Property description was not set
description: string

Property description was not set
draft: boolean

Property description was not set
formatObjects: array formatObjects

Property description was not set
lastModified: integer

Property description was not set
lastModifiedAsDate: integer

Property description was not set
name: string

Property description was not set
system: boolean

Property description was not set
uRN: string

Property description was not set
userLastModified: string

Property description was not set

{
    "properties":{
        "actions":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelActionModel_receive"
            },
            "type":"array"
        },
        "attributes":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelAttributeModel_receive"
            },
            "type":"array"
        },
        "created":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "createdAsDate":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "draft":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "formatObjects":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/MessageFormatModel_receive"
            },
            "type":"array"
        },
        "lastModified":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "lastModifiedAsDate":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "system":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "uRN":{
            "description":"Property description was not set",
            "type":"string"
        },
        "userLastModified":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "createdAsDate",
        "formatObjects",
        "lastModifiedAsDate",
        "uRN",
        "draft",
        "userLastModified",
        "created",
        "system",
        "lastModified",
        "name",
        "actions",
        "attributes",
        "description"
    ],
    "type":"object"
}

Nested Schema : actions

Type: array

Property description was not set

Show Source

Array of: object DeviceModelActionModel_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/DeviceModelActionModel_receive"
    },
    "type":"array"
}

Nested Schema : attributes

Type: array

Property description was not set

Show Source

Array of: object DeviceModelAttributeModel_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/DeviceModelAttributeModel_receive"
    },
    "type":"array"
}

Nested Schema : formatObjects

Type: array

Property description was not set

Show Source

Array of: object MessageFormatModel_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/MessageFormatModel_receive"
    },
    "type":"array"
}

Nested Schema : DeviceModelActionModel_receive

Type: object

Show Source

alias: string

Property description was not set
argType: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
arguments: array arguments

Property description was not set
description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set

{
    "properties":{
        "alias":{
            "description":"Property description was not set",
            "type":"string"
        },
        "argType":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        },
        "arguments":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelActionArgumentModel_receive"
            },
            "type":"array"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "argType",
        "range",
        "alias",
        "name",
        "description",
        "arguments"
    ],
    "type":"object"
}

Nested Schema : arguments

Type: array

Property description was not set

Show Source

Array of: object DeviceModelActionArgumentModel_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/DeviceModelActionArgumentModel_receive"
    },
    "type":"array"
}

Nested Schema : DeviceModelActionArgumentModel_receive

Type: object

Show Source

description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        }
    },
    "required":[
        "range",
        "name",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : DeviceModelAttributeModel_receive

Type: object

Show Source

alias: string

Property description was not set
description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
writable: boolean

Property description was not set

{
    "properties":{
        "alias":{
            "description":"Property description was not set",
            "type":"string"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        },
        "writable":{
            "description":"Property description was not set",
            "type":"boolean"
        }
    },
    "required":[
        "range",
        "alias",
        "writable",
        "name",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : MessageFormatModel_receive

Type: object

Show Source

description: string

Property description was not set
deviceModel: string

Property description was not set
explorationId: string

Property description was not set
name: string

Property description was not set
severity: string

Property description was not set
sourceId: string

Property description was not set
sourceType: string

One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].
type: string

One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].
uRN: string

Property description was not set
value: object MessageFormatValue_receive

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "deviceModel":{
            "description":"Property description was not set",
            "type":"string"
        },
        "explorationId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "severity":{
            "description":"Property description was not set",
            "type":"string"
        },
        "sourceId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "sourceType":{
            "description":"One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
            "type":"string"
        },
        "type":{
            "description":"One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
            "type":"string"
        },
        "uRN":{
            "description":"Property description was not set",
            "type":"string"
        },
        "value":{
            "$ref":"#/definitions/MessageFormatValue_receive"
        }
    },
    "required":[
        "deviceModel",
        "explorationId",
        "sourceId",
        "uRN",
        "sourceType",
        "severity",
        "name",
        "value",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : MessageFormatValue_receive

Type: object

Show Source

fields: array fields

Property description was not set

{
    "properties":{
        "fields":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/MessageFormatField_receive"
            },
            "type":"array"
        }
    },
    "required":[
        "fields"
    ],
    "type":"object"
}

Nested Schema : fields

Type: array

Property description was not set

Show Source

Array of: object MessageFormatField_receive

{
    "description":"Property description was not set",
    "items":{
        "$ref":"#/definitions/MessageFormatField_receive"
    },
    "type":"array"
}

Nested Schema : MessageFormatField_receive

Type: object

Show Source

name: string

Property description was not set
optional: boolean

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].

{
    "properties":{
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "optional":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        }
    },
    "required":[
        "name",
        "type",
        "optional"
    ],
    "type":"object"
}

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

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

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

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

Nested Schema : LogBuffer_receive

Type: object

Show Source

empty: boolean

Property description was not set
full: boolean

Property description was not set

{
    "properties":{
        "empty":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "full":{
            "description":"Property description was not set",
            "type":"boolean"
        }
    },
    "required":[
        "full",
        "empty"
    ],
    "type":"object"
}

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

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

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

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

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

409 Response

Conflict. The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.