Skip to main content
PATCH
Update the retention policy

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

The retention minimums to change. Send only the fields you are changing.

cte_min_years
integer | null

Minimum whole years a Critical Tracking Event is kept before it may be deleted, 0 to 32767. FSMA 204 requires at least 2; raise it when a contract asks for longer.

Required range: 0 <= x <= 32767
epcis_event_min_years
integer | null

Minimum whole years a EPCIS event (and the reference documents it names) is kept before it may be deleted, 0 to 32767. FSMA 204 requires at least 2; raise it when a contract asks for longer.

Required range: 0 <= x <= 32767
product_lot_min_years
integer | null

Minimum whole years a product lot is kept before it may be deleted, 0 to 32767. FSMA 204 requires at least 2; raise it when a contract asks for longer.

Required range: 0 <= x <= 32767
bulk_export_job_min_years
integer | null

Minimum whole years a bulk export job is kept before it may be deleted, 0 to 32767. FSMA 204 requires at least 2; raise it when a contract asks for longer.

Required range: 0 <= x <= 32767
audit_event_min_years
integer | null

Minimum whole years a audit event is kept before it may be deleted, 0 to 32767. FSMA 204 requires at least 2; raise it when a contract asks for longer.

Required range: 0 <= x <= 32767

Response

OK

The organization's minimum retention per FSMA 204 record type, in years.

cte_min_years
integer
required

Minimum whole years a Critical Tracking Event is kept before it may be deleted.

epcis_event_min_years
integer
required

Minimum whole years a EPCIS event (and the reference documents it names) is kept before it may be deleted.

product_lot_min_years
integer
required

Minimum whole years a product lot is kept before it may be deleted.

bulk_export_job_min_years
integer
required

Minimum whole years a bulk export job is kept before it may be deleted.

audit_event_min_years
integer
required

Minimum whole years a audit event is kept before it may be deleted.