Sign in

v1

latestOpenAPI 3.0.1LGPLv32026-07-17264159234.9 KB
v2 disposal holds

Apply disposal hold to selected AIPs

post/api/v2/disposal/holds/{id}/associate

Path parameters

idstring required

Disposal hold id

Query parameters

overrideboolean

Lift all disposal holds associated and apply the selected disposal hold

Request body

@typestring required

Response

Job created

idstring
namestring
usernamestring
startDatestring date-time
endDatestring date-time
state'CREATED' | 'STARTED' | 'COMPLETED' | 'FAILED_DURING_CREATION' | 'FAILED_TO_COMPLETE' | 'STOPPED' | 'STOPPING' | 'TO_BE_CLEANED' | 'PENDING_APPROVAL' | 'REJECTED' | 'SCHEDULED'
stateDetailsstring
instanceIdstring
instanceNamestring
pluginstring
pluginType'INGEST' | 'INTERNAL' | 'SIP_TO_AIP' | 'AIP_TO_SIP' | 'AIP_TO_AIP' | 'MISC' | 'MULTI'
pluginParametersobject
outcomeObjectsClassstring
attachmentsListstring[]
fieldsobject
priority'URGENT' | 'HIGH' | 'MEDIUM' | 'LOW'
parallelism'LIMITED' | 'NORMAL'
stoppingboolean
inFinalStateboolean