Skip to content
Plune Plune Docs

Everything that ever happened to one record

GET
/v1/audit/{entity}/{entityId}
 
curl --request GET \
  --url https://beta-api.plune.ai/v1/audit/test_case/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
entity
required
string
Allowed values: test_case suite run review_item project
entityId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The record’s history, newest first

Media type application/json
object
entries
required
Array<object>
object
id
required
string
projectId
string
entity
required
string
Allowed values: test_case suite run review_item project
entityId
required
string
action
required
string
Allowed values: create update delete state_change event restore
actorType
required

A bearer token WITH a session header is an agent; without one it is a token; a session cookie is a user.

string
Allowed values: user token agent
actorId
required

For a token this is the TOKEN id — when one leaks, the question is what that credential did.

string
sessionHash

Keyed with the deployment secret, so one client cannot compute another’s.

string
nullable
diff
required

Only the fields that moved. A field whose NAME says it holds a credential is masked, though the fact that it changed is still recorded.

object
key
additional properties
object
before
after
meta
required
object
restorable
required

False when the diff was truncated — the previous values were not kept in full.

boolean
truncated
boolean
restoredFrom

On a restore entry: the entry it undid.

string
reason
string
createdAt
required
string
Example 
{
  "entries": [
    {
      "entity": "test_case",
      "action": "create",
      "actorType": "user"
    }
  ]
}

401

Section titled “401 ”

No / invalid token or session

404

Section titled “404 ”

Unknown entity kind

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}