Survey a field scrub

POST

/api/admin/resources/field-scrub/survey

Maintainer:Not configured

OperationId:admin_survey_resource_field_scrub

Reports what the field scrub would do, without recording or changing anything: the ledger paths it would redact, the paths it keeps (today's value) or cannot reach and why, the folded property rows it would rewrite, and the events clear would append, beside the family listing with the sensitivity sweep's flags. For a charter, an erased resource, a sentinel collision or a title or origin URI whose latest event disagrees with the projection it reports the refusal the act would record (refusal, detail) and no plan, once the request and its handle are well formed. In keep mode a plan with no redacted_fields means nothing is prior, which the act answers 400; with clear, a field already cleared is answered 400 here as the act answers it. Requires a system admin. Any other caller gets 404, decided before any lookup.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

What the act would do (plan), or the refusal it would record (refusal); nothing is recorded or changed

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/admin/resources/field-scrub/survey' \
--header 'X-Temper-Surface;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clear": true,
    "family": "94e1bf30-62f3-41fa-af2a-8b8e19ac691e",
    "field": "title",
    "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee"
}'

Response Example

200 - Example 1

{
    "detail": "string",
    "families": [
        {
            "covered": true,
            "current_flagged": true,
            "events": 0,
            "family": "94e1bf30-62f3-41fa-af2a-8b8e19ac691e",
            "field": "title",
            "first_by": "c07ea116-cfe2-42de-91b0-cf50fa1e3dfe",
            "first_seen": "2019-08-24T14:15:22.123Z",
            "flagged": true,
            "live": true,
            "unset": true,
            "value_type": "string"
        }
    ],
    "plan": {
        "clears": [
            {
                "event_type": "string",
                "path": "string"
            }
        ],
        "folded_rows": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "kept": [
            {
                "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
                "paths": [
                    "string"
                ],
                "why": "string"
            }
        ],
        "redacted_fields": [
            {
                "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
                "paths": [
                    "string"
                ]
            }
        ],
        "unreachable": [
            {
                "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
                "paths": [
                    "string"
                ],
                "why": "string"
            }
        ]
    },
    "refusal": "charter_resource",
    "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee"
}

Modified at 2026-10-11 10:38:12

List a resource's scrubbable fields

List the erasure retention policy