Using Document API

After you subscribe to Loftware Cloud API in the Developer Portal and connect your subscription, you can start to consume Document API. See more in Subscribing to Loftware Cloud APIs and creating subscription keys.

There are four calls in Document API:

• POST sends data to a server to create/update a resource.

• PUT requests that the target resource updates its state.

• ​​GET​​ requests data from a specified resource.

• DELETE deletes data or objects from the specified source.

There are more than 40 operations in Document API. The most commonly used are:

• Lists the files and folder based on search criteria and other parameters starting in a root folder to find your files and folders and list them.
• Checks the file in to check in labels or Checks the file out to check out labels.
• Get available steps for the document to get/change workflow states.
• Marks the files as deleted to delete files.

When you go to Document API in the Developer Portal and click on an operation, you get a list of possible API responses below the Request parameters. The most common responses are:

• 200 OK
• 400 Bad Request
• 404 Not Found

For more detailed steps on using Document API in the Developer Portal, see:

• Finding your Files with Document API

• Creating a new file with Document API

• Checking in and Checking out Files with Document API

• Deleting Files with Document API

• Getting workflow states and changing workflow steps with Document API