Location
/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/data
This resource represents object data to upload
Request Headers (Applies to all methods)
Authorization
header
Required: Yes
Content-Type
header
Required: No
Content-Range
header
Required: Yes
PUT
/api/apps/{appID}/things/{thingID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/data
Description
Upload the object data.
Note
This request requires empty body.
Name
Required?
type
Description
Authorization
Yes
string
Authorization header. OAuth2 Bearer token
Content-Type
No
string
The object type (if available) or application/json
Content-Range
Yes
string
The object body chunk range size.
It must follow the pattern:
^bytes=(\\d+)-(\\d+)/(\\d+)$
Responses
204
Content-Type (None)
The object data has been uploaded successfully.
Note
This response has no contents.
404
Content-Type application/vnd.kii.ObjectNotFoundException+json
The object was not found.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "OBJECT_NOT_FOUND". |
message | string | The error message. |
objectScope | ObjectScope | The scope of the object. |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
bucketID | string | The ID of the bucket. |
objectID | string | The ID of the object that was not found. |
404
Content-Type application/vnd.kii.BucketNotFoundException+json
The bucket was not found.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "BUCKET_NOT_FOUND". |
message | string | The error message. |
objectScope | ObjectScope | The scope of the bucket. |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
bucketID | string | The ID of the bucket. |
416
Content-Type application/vnd.kii.ObjectBodyRangeNotSatisfiableException+json
The object body range was not satisfiable.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "OBJECT_BODY_RANGE_NOT_SATISFIABLE". |
message | string | The error message. |
objectScope | ObjectScope | The scope of the object. |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
bucketID | string | The ID of the bucket. |
objectID | string | The ID of the object. |
from | long | Object body chunk starts from. |
to | long | Object body chunk ends to. |
total | long | The total size of object body chunk. |
404
Content-Type application/vnd.kii.ObjectBodyUploadNotFoundException+json
The upload was not found.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "OBJECT_BODY_UPLOAD_NOT_FOUND". |
message | string | The error message. |
objectScope | ObjectScope | The scope of the object. |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
bucketID | string | The ID of the bucket. |
objectID | string | The ID of the object for which the upload was associated. |
uploadID | string | The uploadID that was not found. |
412
Content-Type application/vnd.kii.ObjectBodyIntegrityNotAssuredException+json
The object body integrity was not assured.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "OBJECT_BODY_INTEGRITY_NOT_ASSURED". |
message | string | The error message. |
objectScope | ObjectScope | The scope of the object. |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
bucketID | string | The ID of the bucket. |
objectID | string | The ID of the object. |