Errors

If you encounter an error, the IoT Edge Connect API responds with an appropriate data object that explains it. This sample shows a validation error where type provides a link where you can find out more about this error type, and title provides a descriptive label for the overall problem. It also includes an optional errors array that lists potentially more than one problem detected in the request.

{
    "type": "/dcp-api/error-types/ACL_PATH_CAN_NOT_BE_NULL",
    "title": "Problems parsing JSON",
    "errorCode": "validation_failed",
    "errors": [
        {
            "type": "/dcp-api/error-types/ACL_PATH_CAN_NOT_BE_NULL",
            "title": "must not be null",
            "fieldName": "acls",
            "errorCode": "acl_path_can_not_be_null"
        }
    ]
}

For details on information contained in the error responses, refer to Error response syntax.