Input objects
LockCompanyRetentionPeriodCommandRequestInput
Sets the retention period of a kind of process and locks it. A locked period can never be changed or removed again, so check the values before calling. The period must not be 0 years, 0 months and 0 days. - Request
input
LockCompanyRetentionPeriodCommandRequestInputFields
companyId
ID!
required
The ID of the company.
processId
String!
required
The identifier of the kind of process. The set of identifiers is fixed by the application and listed by the query for retention periods; it is empty while the retention function is not active.
years
Int!
required
Years of the period, 0 or more.
months
Int!
required
Months of the period, 0 or more.
days
Int!
required
Days of the period, 0 or more.
idempotencyKey
String
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?