EndpointsCogents

Delete cogent record

DELETE/v2/cogents/{cogent_id}/c/{collection}/{key}

Deletes a live record as its next revision and drops its publication, if it had one. Its history stays readable, and a later put brings it back, unpublished.

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

cogent_id*Cogent Id

Cogent ID (its player ID).

Match^ply_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
collection*Collection

Collection name.

key*Key

Record key. It may contain /.

Query Parameters

idempotency_key*Idempotency Key

Caller-chosen key for this write, unique within the caller's credential. A retry with the same key and the same write returns the original result; the same key with another write is refused. Keys starting with permit: are the server's.

Length1 <= length <= 200
base_rev?|

The revision this delete was made against; a stale one is refused.

message?|

Why, kept with the revision.

Header Parameters

x-cogent-agent?|

Which agent is writing, recorded with the write: hub, or a part of one such as hub/foreman.

curl -X DELETE "https://softmax.com/api/observatory/v2/cogents/string/c/string/string?idempotency_key=string"
{  "collection": "string",  "key": "string",  "rev": 0,  "at": "2019-08-24T14:15:22Z",  "author": {    "role": "coach",    "agent": "string"  },  "message": "string",  "deleted": true}