The cleanup object
A comprehensive list of the cleanup resource's attributes and relationships
A cleanup object is returned as part of the response body of each successful list, retrieve or create API call to the /api/cleanups
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The cleanup unique identifier |
links.self |
| The cleanup endpoint URL |
attributes.resource_type |
| The type of resource being cleaned. |
attributes.status |
| The cleanup job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'. |
attributes.started_at |
| Time at which the cleanup was started. |
attributes.completed_at |
| Time at which the cleanup was completed. |
attributes.interrupted_at |
| Time at which the cleanup was interrupted. |
attributes.filters |
| The filters used to select the records to be cleaned. |
attributes.records_count |
| Indicates the number of records to be cleaned. |
attributes.errors_count |
| Indicates the number of cleanup errors, if any. |
attributes.processed_count |
| Indicates the number of records that have been cleaned. |
attributes.errors_log |
| Contains the cleanup errors, if any. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.events |
| The associated events. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated