Create a data retention rule

post https://api.dastra.eu/v1/ws/{workspaceId}/DataRetentionRules

Path Params

workspaceId

string

required

Body Params

customFields

object | null

dataFields

array of objects | null

List of data fields related to the datasets

dataFields

subjectCategories

array of objects | null

Related subject categories concerned by this dataset
e.g. Employees,...

subjectCategories

tags

array of objects | null

tags

dataProcessings

array of objects | null

dataProcessings

uuid

ref

string | null

Internal reference

label

string

required

length between 1 and 400

The name of the dataset

description

string | null

The description og the dataset

dateCreation

date-time

Date creation (readonly)

dateUpdate

date-time | null

Date update (readonly)

baseActiveOverride

boolean

Must be set to true if you want to override the default base active retention policy of the data processing

intermediateArchivingOverride

boolean

Must be set to true if you want to override the default intermediate archiving retention policy of the data processing

destructionOverride

boolean

Must be set to true if you want to override the default destruction policy of the data processing

baseActiveDescription

string | null

The base active retention policy description of the rule
The base active is the default retention rule during the initial step of the data lifecycle
e.g. 5 years after the end of the contract

baseActiveLegalBasis

string | null

The base active retention policy legal basis

baseActiveRetentionDuration

int64 | null

Active base duration in minutes

intermediateArchivingLegalBasis

string | null

Intermediate archiving legal basis

intermediateArchivingDescription

string | null

Intermediate archiving rule description

intermediateArchivingRetentionDuration

int64 | null

Intermediate archiving retention duration (in minutes)

destructionDescription

string | null

Description of the permanent destruction process of the personal data

destructionLegalBasis

string | null

Description of the legal basis for the destruction process

dataSetSource

string

sourceDescription

string | null

Source description

assetId

uuid | null

source

string

Response

Response body

object

customFields

object | null

Custom field values : a key/value dictionary. Use the custom field variable name as key.
As following :
"customFields": {
"my_custom_field": "My custom value"
}

Has additional fields

tags

array of objects | null

tags

object

uuid

label

string

required

length between 1 and 80

type

string

Type of tags

DataProcessing DataSubjectRequest DataBreach Task Actor SecurityMeasure Asset Risk DataRetentionRule AuditTemplate AiSystem Contract AiModel

color

string | null

creator

object

int32

displayName

string | null

familyName

string | null

givenName

string | null

active

boolean

color

string | null

avatarUrl

string | null

tenantId

int32

readonly

boolean

purposes

array of uuids | null

purposes

dataProcessings

array of objects | null

dataProcessings

object

uuid

label

string | null

ref

string | null

description

string | null

riskLevel

int32 | null

workspaceId

int32

archived

boolean

dateUpdate

date-time

dateCreation

date-time

areaId

int32 | null

processingType

string

Default Vendor

dataFields

array of objects | null

List of data fields related to the datasets

dataFields

object

uuid

Data field unique identifier

customFields

object | null

Custom field values : a key/value dictionary. Use the custom field variable name as key.
As following :
"customFields": {
"my_custom_field": "My custom value"
}

Has additional fields

ref

string | null

Internal reference

archivingPolicy

string | null

Specific archiving policy
It is possible to set this information only when editing the dataset

required

boolean

Wether the field is required in the dataset or not.
It is possible to set this information only when editing the dataset

label

string

required

length between 1 and 150

Name of the field. It musts be as generic as possible
e.g. Email Address, Phone Number

definition

string | null

Base description of the field

technicalDefinition

string | null

Technical description of the field

sensitiveDataFieldLegalJustification

string

ExplicitConsent NecessaryPurpose VitalInterest PoliticalLegitimateActivity ManifestlyPublic DefenseOfLegalClaims SubstantialPublicInterest Medicine PublicHealth StatisticResearch Other

sensitiveDataFieldLegalJustificationDescription

string | null

Sensitive data field justification

sensitiveData

boolean

True if the data are considered as sensitive

personalDataCategory

string

CivilStatus PersonalLife ProfessionalLife EconomicFinancialData ConnectionData GeoLocationData InternetData EthnicalData PoliticalOpinions ReligiousBeliefs TradeUnionMembership GeneticData BiometricData HealthData SexualOrientations CriminalConvictions CriminalData Other NIR FamilySituation RiskAssessment ContractManagement AssessmentOfDamages CommercialOperations BankDetails

dataType

string

String Number UniqueIdentifier Date Object Document Matrix Geolocation

dateCreation

date-time

dateUpdate

date-time | null

creator

object

workflowStepId

int32

workflowStep

object

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

asset

object

uuid

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

ref

string | null

Internal reference specific to the customer

label

string

required

length between 1 and 255

Name of the asset
e.g. Microsoft Teams, Github, Amazon S3...

editor

object

editorId

uuid | null

The publisher identifier (write)

address

string | null

countryCode

string | null

The country where is located the asset
2 characters ISO format
e.g. FR,UK,...

zipCode

string | null

Zip code

city

string | null

privacyPolicyUrl

string | null

Asset privacy policy url

type

string

Software Building Network Material Data People Process Algorithm

description

string | null

Description of the asset

logoUrl

string | null

Logo url / must be a valid .png or .jpg format url

applicationState

string

InProduction InDevelopment Stopped

state

string

Draft Active

applicationType

string

Software WebApp Saas Module Other

hostingType

string

InHouse OutSourced

developmentType

string

InHouse OutSourced

maintenanceType

string

InHouse OutSourced

supportType

string

InHouse OutSourced

tags

array of objects | null

tags

object

uuid

label

string

required

length between 1 and 80

type

string

Type of tags

DataProcessing DataSubjectRequest DataBreach Task Actor SecurityMeasure Asset Risk DataRetentionRule AuditTemplate AiSystem Contract AiModel

color

string | null

readonly

boolean

Set to true if it is merged with a master relationship

dateCreation

date-time

dateUpdate

date-time | null

creator

object

creatorId

int32 | null

owner

object

ownerId

int32 | null

workflowStepId

int32

customFields

object | null

Custom field values

Has additional fields

reviewDate

date-time | null

Date of the last review to calculate the freshness

nextReviewDate

date-time | null

Overrides the global policy review date

subjectCategories

array of objects | null

Related subject categories concerned by this dataset
e.g. Employees,...

subjectCategories

object

uuid

label

string

required

length between 1 and 250

ref

string | null

Internal reference

dateCreation

date-time

dateUpdate

date-time | null

creatorUserId

int32 | null

creatorUser

object

description

string | null

minorConcerned

boolean

workflowStepId

int32

workflowStep

object

uuid

ref

string | null

Internal reference

label

string

required

length between 1 and 400

The name of the dataset

description

string | null

The description og the dataset

dateCreation

date-time

Date creation (readonly)

dateUpdate

date-time | null

Date update (readonly)

baseActiveOverride

boolean

Must be set to true if you want to override the default base active retention policy of the data processing

intermediateArchivingOverride

boolean

Must be set to true if you want to override the default intermediate archiving retention policy of the data processing

destructionOverride

boolean

Must be set to true if you want to override the default destruction policy of the data processing

baseActiveDescription

string | null

The base active retention policy description of the rule
The base active is the default retention rule during the initial step of the data lifecycle
e.g. 5 years after the end of the contract

baseActiveLegalBasis

string | null

The base active retention policy legal basis

baseActiveRetentionDuration

int64 | null

Active base duration in minutes

intermediateArchivingLegalBasis

string | null

Intermediate archiving legal basis

intermediateArchivingDescription

string | null

Intermediate archiving rule description

intermediateArchivingRetentionDuration

int64 | null

Intermediate archiving retention duration (in minutes)

destructionDescription

string | null

Description of the permanent destruction process of the personal data

destructionLegalBasis

string | null

Description of the legal basis for the destruction process

dataSetSource

string

Direct Indirect DirectAndIndirect

sourceDescription

string | null

Source description

assetId

uuid | null

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.dastra.eu/v1/ws/workspaceId/DataRetentionRules \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK