Data Share
A single API to create services that connect all your users' objects data. Expand your potential with the Data Share ecosystem.

Data Share API Explorer

This page presents JSON/REST services exposed by Data Share to access user resources.

For more info about APIs principles and usage, please read our developer documentation (https://datashare.orange.com/dev/).

[BASE URL: /datavenue/datashare/v2, API VERSION: v2, HOST: https://api.orange.com]
    • implementation notes

      Sets a light state to targeted device(s).

      response class (status 200)
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      requestbody
      {
        "params": {
          "color": {
            "hex": "#FF5500",
            "hsl": [
              0
            ],
            "rgb": [
              0
            ]
          },
          "on": false
        },
        "target": {
          "byId": [
            0
          ],
          "byUdi": [
            "string"
          ]
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      202Accepted: when command succeeded on all targeted devices
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      207Multi Status: when command failed on at least one targeted device (with various errors on others: see response body)
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Sets a thermostat mode to targeted device(s).

      response class (status 200)
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      requestbody
      {
        "params": {
          "endDate": "2017-11-14T14:37:29.460Z",
          "temperature": 0,
          "type": "manual"
        },
        "target": {
          "byId": [
            0
          ],
          "byUdi": [
            "string"
          ]
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      202Accepted: when command succeeded on all targeted devices
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      207Multi Status: when command failed on at least one targeted device (with various errors on others: see response body)
      [
        {
          "device": {
            "id": 0,
            "links": {},
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          },
          "result": {
            "code": 0,
            "description": "The requested resource [7893] doesn't exist.",
            "message": "ResourceNotFound"
          }
        }
      ]
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Returns all connections and devices owned by a given user, possibly filtering by status and/or capability

      response class (status 200)
      [
        {
          "connectorName": "carpetcorp",
          "created": "2017-11-14T14:37:29.461Z",
          "devices": [
            {
              "battery": 0,
              "capabilities": {
                "commands": [
                  "string"
                ],
                "data": [
                  "string"
                ]
              },
              "created": "2017-11-14T14:37:29.461Z",
              "error": "NONE",
              "id": 0,
              "instance": "02:00:00:12:e8:d2",
              "lastStateChanged": "2017-11-14T14:37:29.461Z",
              "lastSync": "2017-11-14T14:37:29.461Z",
              "links": {},
              "model": "icarpet3",
              "niceName": "my connected carpet",
              "parentId": 0,
              "status": "CONNECTED",
              "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
            }
          ],
          "error": "NONE",
          "id": 0,
          "key": "AK1RT2",
          "lastStateChanged": "2017-11-14T14:37:29.461Z",
          "links": {},
          "status": "WORKING"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      ALL (default)
      ALL or  ACTIVE
      Device status filter (ACTIVE: shows only CONNECTED devices from WORKING connections; ALL: shows all)querystring
      Filter device by data typequerystring
      Filter device by commandquerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Creates a connection

      response class (status 201)
      {
        "connectorName": "carpetcorp",
        "created": "2017-11-14T14:37:29.461Z",
        "devices": [
          {
            "battery": 0,
            "capabilities": {
              "commands": [
                "string"
              ],
              "data": [
                "string"
              ]
            },
            "created": "2017-11-14T14:37:29.461Z",
            "error": "NONE",
            "id": 0,
            "instance": "02:00:00:12:e8:d2",
            "lastStateChanged": "2017-11-14T14:37:29.461Z",
            "lastSync": "2017-11-14T14:37:29.461Z",
            "links": {},
            "model": "icarpet3",
            "niceName": "my connected carpet",
            "parentId": 0,
            "status": "CONNECTED",
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        ],
        "error": "NONE",
        "id": 0,
        "key": "AK1RT2",
        "lastStateChanged": "2017-11-14T14:37:29.461Z",
        "links": {},
        "status": "WORKING"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      The required attributes to create a connectionbody
      {
        "connectorName": "string",
        "key": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Returns a connection by its id

      response class (status 200)
      {
        "connectorName": "carpetcorp",
        "created": "2017-11-14T14:37:29.461Z",
        "devices": [
          {
            "battery": 0,
            "capabilities": {
              "commands": [
                "string"
              ],
              "data": [
                "string"
              ]
            },
            "created": "2017-11-14T14:37:29.461Z",
            "error": "NONE",
            "id": 0,
            "instance": "02:00:00:12:e8:d2",
            "lastStateChanged": "2017-11-14T14:37:29.461Z",
            "lastSync": "2017-11-14T14:37:29.461Z",
            "links": {},
            "model": "icarpet3",
            "niceName": "my connected carpet",
            "parentId": 0,
            "status": "CONNECTED",
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        ],
        "error": "NONE",
        "id": 0,
        "key": "AK1RT2",
        "lastStateChanged": "2017-11-14T14:37:29.461Z",
        "links": {},
        "status": "WORKING"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      ALL (default)
      ALL or  ACTIVE
      Device status filter (ACTIVE: shows only CONNECTED devices from WORKING connections; ALL: shows all)querystring
      Filter device by data typequerystring
      Filter device by commandquerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Updates a connection by its id

      response class (status 200)
      {
        "connectorName": "carpetcorp",
        "created": "2017-11-14T14:37:29.461Z",
        "devices": [
          {
            "battery": 0,
            "capabilities": {
              "commands": [
                "string"
              ],
              "data": [
                "string"
              ]
            },
            "created": "2017-11-14T14:37:29.461Z",
            "error": "NONE",
            "id": 0,
            "instance": "02:00:00:12:e8:d2",
            "lastStateChanged": "2017-11-14T14:37:29.461Z",
            "lastSync": "2017-11-14T14:37:29.461Z",
            "links": {},
            "model": "icarpet3",
            "niceName": "my connected carpet",
            "parentId": 0,
            "status": "CONNECTED",
            "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        ],
        "error": "NONE",
        "id": 0,
        "key": "AK1RT2",
        "lastStateChanged": "2017-11-14T14:37:29.461Z",
        "links": {},
        "status": "WORKING"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      The required attributes to update a connectionbody
      {
        "reason": "NONE",
        "status": "WORKING"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Deletes a connection by its id

      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204No Content: connection was successfully deleted
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Returns devices from a given connection, possibly filtering by status and/or capability

      response class (status 200)
      [
        {
          "battery": 0,
          "capabilities": {
            "commands": [
              "string"
            ],
            "data": [
              "string"
            ]
          },
          "created": "2017-11-14T14:37:29.461Z",
          "error": "NONE",
          "id": 0,
          "instance": "02:00:00:12:e8:d2",
          "lastStateChanged": "2017-11-14T14:37:29.461Z",
          "lastSync": "2017-11-14T14:37:29.461Z",
          "links": {},
          "model": "icarpet3",
          "niceName": "my connected carpet",
          "parentId": 0,
          "status": "CONNECTED",
          "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      ALL (default)
      ALL or  ACTIVE
      Device status filter (ACTIVE: shows only CONNECTED devices from WORKING connections; ALL: shows all)querystring
      Filter device by data typequerystring
      Filter device by commandquerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Set the list of devices for a connection (replacing the current list).

      response class (status 200)
      [
        {
          "battery": 0,
          "capabilities": {
            "commands": [
              "string"
            ],
            "data": [
              "string"
            ]
          },
          "created": "2017-11-14T14:37:29.461Z",
          "error": "NONE",
          "id": 0,
          "instance": "02:00:00:12:e8:d2",
          "lastStateChanged": "2017-11-14T14:37:29.461Z",
          "lastSync": "2017-11-14T14:37:29.461Z",
          "links": {},
          "model": "icarpet3",
          "niceName": "my connected carpet",
          "parentId": 0,
          "status": "CONNECTED",
          "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      The required attributes to describe devicesbody
      [
        {
          "battery": 0,
          "error": "NONE",
          "id": {
            "instance": "string",
            "model": "string"
          },
          "niceName": "string",
          "parentId": {
            "instance": "string",
            "model": "string"
          }
        }
      ]
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Updates the list of devices for a connection by merging sent list into the existing one.

      response class (status 200)
      [
        {
          "battery": 0,
          "capabilities": {
            "commands": [
              "string"
            ],
            "data": [
              "string"
            ]
          },
          "created": "2017-11-14T14:37:29.461Z",
          "error": "NONE",
          "id": 0,
          "instance": "02:00:00:12:e8:d2",
          "lastStateChanged": "2017-11-14T14:37:29.461Z",
          "lastSync": "2017-11-14T14:37:29.461Z",
          "links": {},
          "model": "icarpet3",
          "niceName": "my connected carpet",
          "parentId": 0,
          "status": "CONNECTED",
          "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      The required attributes to describe devicesbody
      [
        {
          "battery": 0,
          "error": "NONE",
          "id": {
            "instance": "string",
            "model": "string"
          },
          "niceName": "string",
          "parentId": {
            "instance": "string",
            "model": "string"
          }
        }
      ]
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Returns a device by its internal id

      response class (status 200)
      {
        "battery": 0,
        "capabilities": {
          "commands": [
            "string"
          ],
          "data": [
            "string"
          ]
        },
        "created": "2017-11-14T14:37:29.461Z",
        "error": "NONE",
        "id": 0,
        "instance": "02:00:00:12:e8:d2",
        "lastStateChanged": "2017-11-14T14:37:29.461Z",
        "lastSync": "2017-11-14T14:37:29.461Z",
        "links": {},
        "model": "icarpet3",
        "niceName": "my connected carpet",
        "parentId": 0,
        "status": "CONNECTED",
        "udi": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      (required)
      The connection idpathlong
      (required)
      The device idpathlong
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      Possible DataShare errors:
      • 1950: ResourceAccessDenied.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • Data : read & write data from streams

    • implementation notes

      Returns the list of available stream paths for the given user.
      Those paths can be used to search data.
      The complete list of supported data stream paths can be found in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).

      response class (status 200)
      [
        "string"
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Returns an array of statistics from the given data stream. Supports filtering, sorting and pagination. See our statistics documentation (https://datashare.orange.com/dev/statistics.html).

      response class (status 200)
      [
        {
          "avg": 0,
          "count": 0,
          "date": "2017-11-14T14:37:29.465Z",
          "max": 0,
          "min": 0,
          "sum": 0
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      /indoor/air/temperature (default)
      (required)
      Requested data path (ex: /indoor/air/temperature).
      The complete list of supported data stream paths can be found in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).
      pathstring
      count or  avg or  sum or  min or  max
      Statistics fields to compute (count, avg, sum, min, max).
      The complete list of supported fields can be found in our Statistics documentation (https://datashare.orange.com/dev/statistics.html).
      queryArray[string]
      day (default)
      Time interval to compute statistics on (default: day).
      Examples: day, month, year, 2h
      More info in our Statistics documentation (https://datashare.orange.com/dev/statistics.html).
      querystring
      Time zone to use to compute time intervals (default: UTC).
      Examples: Europe/Paris, +01:00
      More info in our Statistics documentation (https://datashare.orange.com/dev/statistics.html).
      querystring
      Duration offset (positive or negative) to shift the start value of each time interval (default: none). When specified, the offset is applied in the defined time zone.
      Examples: -2h, +1M
      More info in our Statistics documentation (https://datashare.orange.com/dev/statistics.html).
      querystring
      Timestamp filter: filters values whose timestamp is within the specified date range.
      Statistics will be computed only on values matching the filter.
      Example: 2017-01-01T00:00:00.000Z,2017-02-01T00:00:00.000Z
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      Query filter
      Statistics will be computed only on values matching the filter.
      Example: {"metadata":{"source":{"eq":"brand:model@macaddr"}}}
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Computes summaries for long user activities. See the summaries documentation (https://datashare.orange.com/dev/summaries.html).

      response class (status 200)
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      /me/sleep (default)
      (required)
      Requested data path (ex: /indoor/air/temperature).
      The complete list of supported data stream paths can be found in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).
      pathstring
      Timestamp filter: filters values whose timestamp is within the specified date range.
      Statistics will be computed only on values matching the filter.
      Example: 2017-01-01T00:00:00.000Z,2017-02-01T00:00:00.000Z
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      Query filter
      Statistics will be computed only on values matching the filter.
      Example: {"metadata":{"source":{"eq":"brand:model@macaddr"}}}
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Retrieves time series data from the given stream with advanced filtering (https://datashare.orange.com/dev/filtering.html).

      response class (status 200)
      [
        {
          "created": "2017-11-14T14:37:29.466Z",
          "id": "string",
          "location": {
            "acc": 0,
            "alt": 0,
            "lat": 0,
            "lon": 0
          },
          "timestamp": "2017-11-14T14:37:29.466Z",
          "value": {
            "metadata": {},
            "value": {}
          }
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      /indoor/air/temperature (default)
      (required)
      Requested data path (ex: /indoor/air/temperature).
      The complete list of supported data stream paths can be found in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).
      pathstring
      10 (default)
      Result size (maximum number of values to return per request).
      Default: 10.
      queryinteger
      Timestamp date range: filters values whose timestamp is within the specified date range.
      Example: 2017-01-01T00:00:00.000Z,2017-02-01T00:00:00.000Z
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      Query filter
      Example: {"metadata":{"source":{"eq":"brand:model@macaddr"}}}
      More info in our Filtering data documentation (https://datashare.orange.com/dev/filtering.html).
      querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Push time series data into the given stream.
      The complete list of supported stream paths with their data model can be found in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).

      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      /indoor/air/temperature (default)
      (required)
      Target data path (ex: /indoor/air/temperature).
      The complete list of supported data stream paths can be found in our Streams and Data documentation(https://datashare.orange.com/dev/streams.html).
      pathstring
      An array of values.
      Models are detailed in our Streams and Data documentation (https://datashare.orange.com/dev/streams.html).
      body
      "string"
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      202Accepted: success
      400Bad Request.
      Possible DataShare errors:
      • 22: InvalidRequestBody.
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Retrieve all subscriptions you've registered on the given user account.

      response class (status 200)
      [
        {
          "filter": {
            "metadata": {
              "device": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
            }
          },
          "id": 0,
          "key": "sub_for_user_12345_to_temperatures",
          "path": "/indoor/air/temperature",
          "url": "https://myhost/notification/callback?from=liveobjects"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Delete all subscriptions you've registered on the given user account.

      parameters
      parametervaluedescriptionparameter typedata type
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204No Content: subscriptions where successfully deleted
      400Bad Request.
      Possible DataShare errors:
      • 27: MissingParameter.
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Retrieve a subscription you've registered on the given user account with the given key.

      response class (status 200)
      {
        "filter": {
          "metadata": {
            "device": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        },
        "id": 0,
        "key": "sub_for_user_12345_to_temperatures",
        "path": "/indoor/air/temperature",
        "url": "https://myhost/notification/callback?from=liveobjects"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The subscription keypathstring
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 27: MissingParameter.
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Subscribe to update notifications from the given data path.

      response class (status 200)
      {
        "filter": {
          "metadata": {
            "device": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        },
        "id": 0,
        "key": "sub_for_user_12345_to_temperatures",
        "path": "/indoor/air/temperature",
        "url": "https://myhost/notification/callback?from=liveobjects"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The subscription key. It's a unique key (per user) defined by yourself to identify the subscription. If you subscribe to several data paths, make sure to specify separate keys. The key will be joined to notifications.pathstring
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      The request body should contain in a json object the callback URL and the path for the subscription.body
      {
        "filter": {
          "metadata": {
            "device": "carpetcorp:icarpet3@02:00:00:12:e8:d2"
          }
        },
        "path": "/indoor/air/temperature",
        "url": "https://myhost/notification/callback?from=liveobjects"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400Bad Request.
      Possible DataShare errors:
      • 27: MissingParameter.
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      Delete a subscription you've registered on the given user account with the given key.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The subscription key to deletepathstring
      me (default)
      (required)
      The ID of the user. Use 'me' for the OAuth token owner.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204No Content: subscription was successfully deleted
      400Bad Request.
      Possible DataShare errors:
      • 27: MissingParameter.
      • 28: InvalidParameter.
      • 1901: BadRequest (see description).
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      403Forbidden.
      Possible OAuth2 errors:
      • access_denied: the resource owner or authorization server denied the request.
      • insufficient_scope: a scope is required to access the requested resource.
      {
        "error": "insufficient_scope",
        "error_description": "Insufficient scope for this resource"
      }
      404Not Found.
      Possible DataShare errors:
      • 1960: ResourceNotFound.
      {
        "code": 0,
        "description": "The requested resource [7893] doesn't exist.",
        "message": "ResourceNotFound"
      }
      defaultCommon errors
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }