Skip to main content

DeleteDoc

DeleteDoc

This method deletes the named source code file in the specified namespace. It returns the corresponding source code file object.

Errors pertaining to the source code file will be in the status property of the source code file object.

For an example and additional details, refer to Deleting a File.

URL

DELETE https://<baseURL>/api/atelier/v1/namespace/doc/doc-name

Where <baseURL> is the base URL for your instance.

Note:

If you are deleting a CSP file [not recommended for use with InterSystems IRIS], the value of doc-name includes the / (slash) character. This is the reason that the URLMap defining DeleteDoc contains a (.*) for this parameter name instead of :docname. See Creating the URL Map for REST for details.

JSON Messages

The following is the returned content for a DELETE of source code file xyz.mac:

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "name": "xyz.mac",
    "db": "INVENTORYR",
    "ts": "",
    "cat": "RTN",
    "status": "",
    "enc": false,
    "flags": 0,
    "content": []
  }
}

HTTP Return Codes

  • HTTP 200 if OK.

  • HTTP 400 if the named resource is not a valid source code file name.

  • HTTP 404 if the source code file does not exist.

  • HTTP 423 if the resource is locked.

  • HTTP 500 if an unexpected error occurred (details will be in status error array).

FeedbackOpens in a new tab