SG Ground Truth

DELETE /entity/<type>/<id>

delete_entity_type_id

Retires a row at 204 with an empty body. It is not erased: the row reads 404 normally and 200 under options[return_only]=retired, and a second delete is 404.

API

Params

part value
body none

Sample requests

r = c.delete("/entity/shots/7653")
print(r.status_code, repr(r.text))
# 204 ''

The body is empty, so parsing it as JSON raises after the delete has already happened.

What the row does afterwards:

c.get("/entity/shots/7653").status_code                                       # 404
c.get("/entity/shots/7653", params={"options[return_only]": "retired"}).status_code  # 200, 4525 bytes
c.delete("/entity/shots/7653").status_code                                    # 404

Response codes

status when
204 retired. Empty body, zero bytes
404 already retired, or never existed: Entity of type [Shot] with id=7653 does not exist.

Edge cases

  • Retired, not erased. Anything counting rows has to decide which of those two it means, and the default for every read is live-only.
  • The correct spelling is options[return_only]=retired. options[retired_only]=true is accepted at 200 and silently ignored, which reads as "there are no retired rows".
  • A second delete is 404, so delete is not idempotent in its status code even though it is in its effect.

Every entry on this site is the output of a probe in probes/. The corpus is generated by running those probes against a live Flow Production Tracking site, not written from memory.

Not affiliated with or endorsed by Autodesk. Flow Production Tracking is their product; this is an independent record of how its REST API answers.