Cancel

Location /api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/cancelled
This resource represents the cancelled object status

Request Headers (Applies to all methods)

Authorization
header
Required: Yes

POST

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/buckets/{bucketID}/objects/{objectID}/body/uploads/{uploadID}/status/cancelled

Description

Set the status of the object body to "cancelled"

Note

This request requires empty body.

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
Responses
204

Content-Type (None)

The object data has been cancelled 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.
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.