Consent Requests

Trigger Consent Request Cleanup

Changed on

Triggers the consent request cleanup that otherwise runs as a scheduled daily job, and waits for it to finish. Only accessible to administrators. The run is guarded by the same cluster-wide advisory lock as the scheduled job, so a conflict is reported if a cleanup is already running. By default, the same two-day window as the scheduled job is used; an explicit window can be passed to catch up on days that were missed, e.g. after an outage.

post/api/agreement/v1/consent-requests/cleanup

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Admin)

Query parameters

fromInclusivestring date
Example:2022-03-10

First day of the window to clean up (inclusive). Defaults to two days ago.

toInclusivestring date
Example:2022-03-10

Last day of the window to clean up (inclusive). Defaults to yesterday.

Response

OK

fromInclusivestring date
toInclusivestring date
terminatedConsentRequestCountinteger

Number of consent requests that were terminated during this run

durationMsinteger

Duration of the cleanup run in milliseconds

Example response

{
  "fromInclusive": "2022-03-10",
  "toInclusive": "2022-03-10",
  "terminatedConsentRequestCount": 8,
  "durationMs": 1234
}

Changes

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status