Location
/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body/uploads
This resource represents the collection of object
uploads.
Request Headers (Applies to all methods)
Authorization
header
Required: Yes
POST
/api/apps/{appID}/users/{accountType}:{address}/buckets/{bucketID}/objects/{objectID}/body/uploads
Description
Start uploading the object body.
Security
Only the administrator can execute this action.
Content-Type application/vnd.kii.StartObjectBodyUploadRequest+json
Request to upload object body data
Name
Required?
type
Description
Authorization
Yes
string
Authorization header. OAuth2 Bearer token
Name
Required?
Type
Description
clientHash
string
The clientHash requested for the upload
Sample Request
{
"clientHash": "[string]"
}
Responses
200
Content-Type application/vnd.kii.StartObjectBodyUploadResponse+json
The upload has started.
Contents
Name | Type | Description |
---|---|---|
uploadID | string | The ID of the upload |
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. |
401
Content-Type application/vnd.kii.UnauthorizedAccessException+json
Not authorized to access this method.
Contents
Name | Type | Description |
---|---|---|
errorCode | string | Error code "UNAUTHORIZED". |
message | string | The error message. |
authenticatedAppID | string | The authenticated appID. |
authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |