RURequest a demo

API reference

Approvals

Approval of changes by a second employee.

List approvals

GET/v1/approvals

Scopes
approvals:read

Filters combine with AND. A cursor is bound to the filter it was issued for; another filter with that cursor is 400. Invalid filter value is 400 schema_validation_failed.

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno
resource_typequeryOnly approvals of this resource type.enum: policy, model_release, trust_store, legal_profile, country_profile, legal_hold_release, review_task, decisionno
resource_idqueryOnly approvals of this resource.string (uuid)no

Responses

  • 200ApprovalList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Request an approval

POST/v1/approvals

Scopes
approvals:request
Required header
Idempotency-Key

Request bodyApprovalCreate

FieldTypeRequired
resource_typeenum: policy, model_release, trust_store, legal_profile, country_profile, legal_hold_release, review_task, decisionyes
resource_idstring (uuid)yes
resource_versionintegeryes
resource_sha256stringyes
evidence_idspolicy: completed simulations of this policy version without failures; legal_hold_release: exactly [id of the legal hold]; review_task: the evidence of the proposed resolution (same as review_resolution.evidence_ids). legal_profile: exactly [id of the legal profile version]; resource_id is the version, resource_version its number and resource_sha256 its digest; the decision of another identity sends the version to the platform owner.array of string (uuid)yes
reasonstringyes
review_resolutionReviewResolutionProposalno

Responses

  • 201Approval
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Decide an approval

POST/v1/approvals/{approval_id}/decision

Scopes
approvals:decide
Required header
Idempotency-Key
Required header
If-Match

Parameters

FieldTypeRequired
approval_idpathstring (uuid)yes

Request bodyApprovalDecision

FieldTypeRequired
decisionenum: approve, denyyes
reasonstringyes
resource_sha256stringyes

Responses

  • 200Approval
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503