iSheets API
iSheets API version 2 - iSheet module - API - iSheet module - Add attachment

iSheets API version 2 - iSheet module - API - iSheet module - Add attachment

OVERVIEW

 

Add attachment for image (as attachment) and external attachment type fields.

 

POST /api/3/isheet/{isheetid}/attachment

 

 

isheetid

number

The ID of the iSheet

Request body

The Media type should be set to multipart/form-data

Path Parameters
 

Parameter Name

Value

Description

isheetid

number

The ID of the iSheet

 

Form Parameters
 

Parameter Name

Value

Description

filename

String

Name of the newly created file

file

Binary file data

The parameter name should be called file and the value for it is the file to be uploaded

 

The file should be added as multipart form data. Please note that the parameters are case sensitive. 

Response

If the operation is successful, the API returns a progressive key resource object. And based on this progressive key, you can see the status of an iSheet attachment, otherwise an error object is returned with the appropriate error code.

 

To get the status of an iSheet attachment based on a progressive key

POST /api/{version}/progressivekeystatus/{progressive_key}

 

Name Type Description
progressive_key String

From here you can check the status of your progress.

When the first request to delete is sent, we will send the progressive key back in response.

 

Response

<attachment>
           <id>101</id>
</attachment>

If the operation is successful, the API returns a progressive key resource object with a status of either 'in-progress', 'done', or 'failed'. If the operation has not been successful an error object is returned with the appropriate error code

Comments


2 Comments

Last Updated: Jun 11,2023