Darshan Hiranandani : How do I update an existing file in Caspio using the REST API?

[darshanhiranandani]

Hi 

I hope you're doing well!

I need to update an existing file in Caspio using the REST API, but I'm a bit unsure about the process. Could you please help me with the steps or point me in the right direction?

Specifically, I'm looking for guidance on:

1. The correct endpoint to use for updating a file.
2. The required parameters or data format for the update request.
3. Any specific headers or authentication needed for the API call.

If you have any examples or documentation that could assist, that would be greatly appreciated!

Thanks a lot for your help!

Best,
Darshan Hiranandani

[nyunyiboy]

Hello there! Caspio releases a new feature called "integrations"! Refer below: 

Caspio Extensions is a new plug-and-play capability that connects your Caspio account to third-party services, enabling various functionalities. We are very excited about the roadmap of Extensions and in future releases, we will open it up for our partners and even customers to create their extensions.

Source: https://howto.caspio.com/release-notes/caspio-52-0/#:~:text=Introducing Caspio Extensions

[nyunyiboy]

Just want to add in the previous comment above,  you may check the article for AI integration: https://howto.caspio.com/integration/extensions/

[CoopperBackpack]

Hello @darshanhiranandani,

Please note that Swagger UI is a kind of Caspio REST API documentation and you can always check available methods and additional details there  

https://howto.caspio.com/integration/web-services-api/swagger-ui/

 

1) The endpoint to update a file is:

Method: PUT

Request URL:  https://accountID.caspio.com/rest/v2/files
OR                        https://accountID.caspio.com/rest/v2/files?externalKey={folder_external_key}

This is information from Swagger UI:

So, for example, if the file is stored in the root folder, please use this request URL https://accountID.caspio.com/rest/v2/files

If the file is stored in some Folder, you need to know the external key of that Folder. For that please use another request. It is a GET request.

Then the request URL should be https://accountID.caspio.com/rest/v2/files?externalKey={folder_external_key}

 

2) Parameters are needed if the file is stored in the folder
For example:

https://accountIDcaspio.com/rest/v2/files?externalKey=8c600532-f165-434c-9bd2-e8aa02f5481a

Here 8c600532-f165-434c-9bd2-e8aa02f5481a is the external key of the Folder.

3) Headers.

Each request should include an Authentication Header. This article explains how to get the access token:

https://howto.caspio.com/integration/web-services-api/authenticating-rest/ 

Every request have to include the following header parameter:

Parameter name:  Authorization
Parameter value: Bearer <access token value>

You must replace <access token value> with your access token.

The second important Header is Content-Type. Its value should be multipart/form-data.

[CoopperBackpack]

Let me provide an example of updating the File via Postman. 

1) For example, I want to update the file named 'user' stored in the Icons folder

2) First, I need to get the external key of this folder.

So, I send a GET request, and from the request I receive the external key = 8c600532-f165-434c-9bd2-e8aa02f5481a

 

3) The next step is to update the file.

Please note that if the file is attached to some record it should be updated with the field that has the same name and extension.

If the file has a different name or/and extension, it will be added as a new file and then it should be attached to the record manually (in the Table directly or via the DataPage).

 

 

 

 

Result: