Jump to

• Request
• Response

Create a Device Model and associate it with the Application

post

/iot/api/v2/apps/{app-id}/deviceModels

This resource allows to create a Device Model and associate it with an Application

Request

Supported Media Types

• application/json

Path Parameters

• app-id: string
  Unique identifier of the application

Body ()

Root Schema : DeviceModelImpl_create

Type: object

Show Source

• actions(optional): array actions
  Property description was not set
• attributes(optional): array attributes
  Property description was not set
• description(optional): string
  Property description was not set
• formatObjects(optional): array formatObjects
  Property description was not set
• formats: array formats
  Property description was not set
• name: string
  Property description was not set
• uRN: string
  Property description was not set

{
    "properties":{
        "actions":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelActionModel_create"
            },
            "type":"array"
        },
        "attributes":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelAttributeModel_create"
            },
            "type":"array"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "formatObjects":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/MessageFormatModel_create"
            },
            "type":"array"
        },
        "formats":{
            "description":"Property description was not set",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "uRN":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "uRN",
        "formats",
        "name"
    ],
    "type":"object"
}

Nested Schema : actions

Type: array

Property description was not set

Show Source

• Array of: object DeviceModelActionModel_create

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

Nested Schema : attributes

Type: array

Property description was not set

Show Source

• Array of: object DeviceModelAttributeModel_create

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

Nested Schema : formatObjects

Type: array

Property description was not set

Show Source

• Array of: object MessageFormatModel_create

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

Nested Schema : formats

Type: array

Property description was not set

Show Source

• Array of: string

{
    "description":"Property description was not set",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : DeviceModelActionModel_create

Type: object

Show Source

• alias(optional): string
  Property description was not set
• argType(optional): string
  One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
• arguments(optional): array arguments
  Property description was not set
• description(optional): string
  Property description was not set
• name: string
  Property description was not set
• range(optional): 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_create"
            },
            "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":[
        "name"
    ],
    "type":"object"
}

Nested Schema : arguments

Type: array

Property description was not set

Show Source

• Array of: object DeviceModelActionArgumentModel_create

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

Nested Schema : DeviceModelActionArgumentModel_create

Type: object

Show Source

• description(optional): string
  Property description was not set
• name: string
  Property description was not set
• range(optional): 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":[
        "name",
        "type"
    ],
    "type":"object"
}

Nested Schema : DeviceModelAttributeModel_create

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_create

Type: object

Show Source

• description: string
  Property description was not set
• deviceModel: string
  Property description was not set
• name: string
  Property description was not set
• 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_create

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "deviceModel":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "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_create"
        }
    },
    "required":[
        "deviceModel",
        "uRN",
        "name",
        "value",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : MessageFormatValue_create

Type: object

Show Source

• fields: array fields
  Property description was not set

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

Nested Schema : fields

Type: array

Property description was not set

Show Source

• Array of: object MessageFormatField_create

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

Nested Schema : MessageFormatField_create

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

Back to Top

Response

Supported Media Types

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

202 Response

Successfully processed.

Body ()

Root Schema : DeviceModelImpl_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"
}

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.

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.

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.

415 Response

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

Back to Top