GDPR configuration endpoints

Get GDPR config

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Gdpr configuration was found & you were allowed to access it. The result is in the body.

application/json

GdprConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Gdpr configuration not found

application/json

get/api/configurations/gdpr

GET /api/configurations/gdpr HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Update GDPR config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

GdprConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

Responses

200

Gdpr configuration was written successfully

application/json

GdprConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64RequiredExample: 42

actorAnonymizationbooleanOptional

If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect

Default: trueExample: true

deletionTimeAfterRetentionnumber · min: 1Optional

Number of days since anonymization until deletion is triggered

Example: 30

idstringOptional

retentionTimenumber · min: 1Required

Number of days after that anonymization is triggered.

Example: 30

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Gdpr configuration not found

application/json

put/api/configurations/gdpr

PUT /api/configurations/gdpr HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

{
  "actorAnonymization": true,
  "deletionTimeAfterRetention": 30,
  "id": "text",
  "retentionTime": 30,
  "version": 42,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}