← Back to schema index

CommitBeneficiaryImportResource

Minimal JSON:API resource with the job ID and the new status after commit.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringJSON:API resource type. Always `beneficiary_import`.
id*stringNumeric job ID expressed as a string.
attributes*objectJob attributes returned after commit (transition status).
status*stringNew status after enqueuing the commit. The only possible value is `committing`.

Used in operations

  • POST /v1/beneficiaries/imports/{id}/commit

Referenced by schemas