James PRO icon

James PRO

Read and write data in James PRO

File → Delete

AI-generated

Summary

Deletes a specified James PRO file entity by ID or name.

Inputs

  • entityId (required) — The ID or name of the file to delete.
  • confirmDelete — Whether to include {"confirm":true} in the DELETE request body to confirm the action.
  • returnBodyOnly — Whether to return the response body directly instead of the full API envelope.

Output shape

A single item containing the API's response body for the deleted file, or a list of items if processing multiple files.

The response depends on the 'returnBodyOnly' parameter; if true, only the 'body' property of the response is returned.

Examples

Example 1: Delete a specific file by ID

Set Resource to 'File', Operation to 'Delete', and entityId to the file's ID.

Example 2: Delete a file and return the API envelope

Set Resource to 'File', Operation to 'Delete', entityId to the file's name, and returnBodyOnly to false.

Links

Discussion