Package fr.gouv.vitam.logbook.rest
Class LogbookResource
- java.lang.Object
-
- fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
-
- fr.gouv.vitam.logbook.rest.LogbookResource
-
@Path("/logbook/v1") public class LogbookResource extends ApplicationStatusResource
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CODE_VITAM
-
Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
STATUS_URL, TENANTS_URL
-
-
Constructor Summary
Constructors Constructor Description LogbookResource(LogbookConfiguration configuration, OntologyLoader ontologyLoader, ElasticsearchLogbookIndexManager indexManager)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description javax.ws.rs.core.Response
bulkCreateObjectGroup(java.lang.String idOp, java.lang.String array)
Lifecycle ObjectGroup Bulk Createjavax.ws.rs.core.Response
bulkCreateOperation(com.fasterxml.jackson.databind.JsonNode query)
Bulk Create Operationjavax.ws.rs.core.Response
bulkCreateUnit(java.lang.String idOp, java.lang.String array)
Lifecycle Unit Bulk Createjavax.ws.rs.core.Response
changeIndexes(SwitchIndexParameters switchIndexParameters)
Switch indexesjavax.ws.rs.core.Response
checkLifecycleTraceabilityStatus(java.lang.String operationId)
Runs unit lifecycle traceabilityjavax.ws.rs.core.Response
commitObjectGroupLifeCyclesByOperation(java.lang.String operationId, java.lang.String objGrpId)
Deprecated.javax.ws.rs.core.Response
commitUnitLifeCyclesByOperation(java.lang.String operationId, java.lang.String unitLcId)
Deprecated.javax.ws.rs.core.Response
createLifeCycleObjectGroupBulk(java.lang.String idOp, java.util.List<LogbookLifeCycleObjectGroupModel> logbookLifeCycleModels)
Lifecycle Unit Bulk Createjavax.ws.rs.core.Response
createLifeCycleUnitBulk(java.lang.String idOp, java.util.List<LogbookLifeCycleUnitModel> logbookLifeCycleModels)
Lifecycle Unit Bulk Createjavax.ws.rs.core.Response
createObjectGroupLifeCyclesByOperation(java.lang.String operationId, java.lang.String objGrpId, LogbookLifeCycleObjectGroupParameters parameters)
Create object Group Life Cyclejavax.ws.rs.core.Response
createOperation(java.lang.String operationId, LogbookOperationParameters operation)
Create or Select a new operationjavax.ws.rs.core.Response
createUnitLifeCyclesByOperation(java.lang.String operationId, java.lang.String unitLcId, LogbookLifeCycleUnitParameters parameters)
Create Unit Life Cyclejavax.ws.rs.core.Response
deleteObjectGroupLifeCyclesByOperation(java.lang.String operationId, java.lang.String objGrpId)
Delete object Group Life Cyclejavax.ws.rs.core.Response
deleteObjectGroups(java.util.List<java.lang.String> objectGroupIds)
javax.ws.rs.core.Response
deleteUnitLifeCyclesByOperation(java.lang.String operationId, java.lang.String unitLcId)
Delete Unit Life Cyclejavax.ws.rs.core.Response
deleteUnits(java.util.List<java.lang.String> unitsIdentifier)
javax.ws.rs.core.Response
exportRawObjectGroupLifecyclesByLastPersistedDate(RawLifecycleByLastPersistedDateRequest request)
Export raw object group life cycles by requestjavax.ws.rs.core.Response
exportRawUnitLifecyclesByLastPersistedDate(RawLifecycleByLastPersistedDateRequest request)
Export raw unit life cycles by requestjavax.ws.rs.core.Response
generateOperationTraceabilities(java.lang.String xTenantId, java.util.List<java.lang.Integer> tenants)
Run traceability secure operation for logbookjavax.ws.rs.core.Response
getLastOperationByType(java.lang.String operationType)
javax.ws.rs.core.Response
getObjectGroupLifeCycleById(java.lang.String objectGroupLifeCycleId, java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl)
Gets the object group life cycle based on its id and using the passed DSL queryjavax.ws.rs.core.Response
getObjectGroupLifeCycles(java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl)
Gets the object group life cycles based on the passed DSL queryjavax.ws.rs.core.Response
getObjectGroupLifeCyclesByOperation(java.lang.String operationId, java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode query)
GET multiple Unit Life Cyclesjavax.ws.rs.core.Response
getObjectGroupLifeCycleStatus(java.lang.String objectGroupLifeCycleId)
Gets the objectGroup life cycle status based on its idjavax.ws.rs.core.Response
getOperation(java.lang.String id, com.fasterxml.jackson.databind.JsonNode queryDsl, boolean sliced, boolean crossTenant)
Selects an operation by id and queryDSLjavax.ws.rs.core.Response
getRawObjectGroupLifeCycleById(java.lang.String id)
Gets a list of raw object group lifeCycles by idjavax.ws.rs.core.Response
getRawObjectGroupLifeCycleByIds(java.util.List<java.lang.String> ids)
Gets a list of raw object group lifeCycles by idsjavax.ws.rs.core.Response
getRawUnitLifeCycleById(java.lang.String id)
Gets a list of raw unit lifeCycles by idjavax.ws.rs.core.Response
getRawUnitLifeCycleByIds(java.util.List<java.lang.String> ids)
Gets a list of raw unit lifeCycles by idsjavax.ws.rs.core.Response
getUnitLifeCycleById(java.lang.String unitLifeCycleId, java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl)
gets the unit life cycle based on its idjavax.ws.rs.core.Response
getUnitLifeCycles(com.fasterxml.jackson.databind.JsonNode queryDsl, java.lang.String evtStatus)
Gets a list of unit lifeCycles using a queryDsljavax.ws.rs.core.Response
getUnitLifeCyclesByOperation(java.lang.String operationId, java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode query)
GET multiple Unit Life Cyclesjavax.ws.rs.core.Response
getUnitLifeCycleStatus(java.lang.String unitLifeCycleId)
Gets the unit life cycle status based on its idjavax.ws.rs.core.Response
launchTraceabilityAudit(AuditLogbookOptions options)
javax.ws.rs.core.Response
reindex(IndexParameters indexParameters)
Reindex a collectionjavax.ws.rs.core.Response
rollBackObjectGroupLifeCyclesByOperation(java.lang.String operationId)
Deletes all temporary ObjectGroup lifeCycles created during a given operationjavax.ws.rs.core.Response
rollBackUnitLifeCyclesByOperation(java.lang.String operationId)
Deletes all temporary Unit lifeCycles created during a given operationjavax.ws.rs.core.Response
selectOperation(com.fasterxml.jackson.databind.JsonNode query, boolean sliced, boolean crossTenant)
Select a list of operationsjavax.ws.rs.core.Response
traceabilityLfcObjectGroup(java.lang.String xTenantId)
Runs object group lifecycle traceabilityjavax.ws.rs.core.Response
traceabilityLfcUnit(java.lang.String xTenantId)
Runs unit lifecycle traceabilityjavax.ws.rs.core.Response
updateBulkObjectGroup(java.lang.String idOp, java.lang.String arrayNodeLifecycle)
Update Lifecycle ObjectGroup With Bulk Modejavax.ws.rs.core.Response
updateBulkUnit(java.lang.String idOp, java.lang.String arrayNodeLifecycle)
Update Lifecycle With Bulk Modejavax.ws.rs.core.Response
updateObjectGroupLifeCyclesByOperation(java.lang.String operationId, java.lang.String objGrpId, java.lang.String evtStatus, LogbookLifeCycleObjectGroupParameters parameters)
Update object Group Life Cyclejavax.ws.rs.core.Response
updateOperation(java.lang.String operationId, LogbookOperationParameters operation)
Append a new item on the given operationjavax.ws.rs.core.Response
updateOperationBulk(java.lang.String arrayNodeOperations)
Update Operation With Bulk Modejavax.ws.rs.core.Response
updateUnitLifeCyclesGOTByOperation(java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
javax.ws.rs.core.Response
updateUnitLifeCyclesGOTTemporaryByOperation(java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
javax.ws.rs.core.Response
updateUnitLifeCyclesUnitByOperation(java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
javax.ws.rs.core.Response
updateUnitLifeCyclesUnitTemporaryByOperation(java.lang.String operationId, java.lang.String unitLcId, java.lang.String evtStatus, LogbookLifeCycleUnitParameters parameters)
Update Unit Life Cyclejavax.ws.rs.core.Response
updateUnitLifeCyclesUnitTemporaryByOperation(java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
-
Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
getServerTenants, status
-
-
-
-
Field Detail
-
CODE_VITAM
public static final java.lang.String CODE_VITAM
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LogbookResource
public LogbookResource(LogbookConfiguration configuration, OntologyLoader ontologyLoader, ElasticsearchLogbookIndexManager indexManager)
Constructor- Parameters:
configuration
- of type LogbookConfigurationontologyLoader
-indexManager
-
-
-
Method Detail
-
getOperation
@GET @Path("/operations/{id_op}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getOperation(@PathParam("id_op") java.lang.String id, com.fasterxml.jackson.databind.JsonNode queryDsl, @HeaderParam("X-Sliced-Operations") boolean sliced, @HeaderParam("X-Cross-Tenant") boolean crossTenant)
Selects an operation by id and queryDSL- Parameters:
id
- operation IDqueryDsl
- the queryDsl containing the ID- Returns:
- the response with a specific HTTP status
-
createOperation
@POST @Path("/operations/{id_op}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createOperation(@PathParam("id_op") java.lang.String operationId, LogbookOperationParameters operation)
Create or Select a new operation- Parameters:
operationId
- path param, the operation idoperation
- the json serialized as a LogbookOperationParameters.- Returns:
- the response with a specific HTTP status
-
updateOperation
@PUT @Path("/operations/{id_op}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateOperation(@PathParam("id_op") java.lang.String operationId, LogbookOperationParameters operation)
Append a new item on the given operation- Parameters:
operationId
- the operation idoperation
- the json serialized as a LogbookOperationParameters.- Returns:
- the response with a specific HTTP status
-
generateOperationTraceabilities
@POST @Path("/operations/traceability") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response generateOperationTraceabilities(@HeaderParam("X-Tenant-Id") java.lang.String xTenantId, java.util.List<java.lang.Integer> tenants)
Run traceability secure operation for logbook- Parameters:
xTenantId
- the tenant id- Returns:
- the response with a specific HTTP status
-
bulkCreateOperation
@POST @Path("/operations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response bulkCreateOperation(com.fasterxml.jackson.databind.JsonNode query)
Bulk Create Operation- Parameters:
query
- as JsonNode or Operations Logbooks as ArrayNode- Returns:
- Response of SELECT query with POST method or CREATED
-
selectOperation
@GET @Path("/operations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response selectOperation(com.fasterxml.jackson.databind.JsonNode query, @HeaderParam("X-Sliced-Operations") boolean sliced, @HeaderParam("X-Cross-Tenant") boolean crossTenant)
Select a list of operations- Parameters:
query
- DSL as JsonNodesliced
- true if sliced operationscrossTenant
- true to inclure admin tenant operations- Returns:
- Response containt the list of loglook operation
-
updateOperationBulk
@PUT @Path("/operations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateOperationBulk(java.lang.String arrayNodeOperations)
Update Operation With Bulk Mode- Parameters:
arrayNodeOperations
- as ArrayNode of operations to add to existing Operation Logbook entry- Returns:
- Response with a status of OK if updated
-
getLastOperationByType
@GET @Path("/lastOperationByType") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getLastOperationByType(java.lang.String operationType)
-
getUnitLifeCyclesByOperation
@GET @Path("/operations/{id_op}/unitlifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getUnitLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode query)
GET multiple Unit Life Cycles- Parameters:
operationId
- the operation idevtStatus
- the evenement status (commited / not_commited)query
- as JsonNode- Returns:
- the response with a specific HTTP status
-
createUnitLifeCyclesByOperation
@POST @Path("/operations/{id_op}/unitlifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createUnitLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String unitLcId, LogbookLifeCycleUnitParameters parameters)
Create Unit Life Cycle- Parameters:
operationId
- the operation idunitLcId
- the life cycle idparameters
- the json serialized as a LogbookLifeCycleUnitParameters.- Returns:
- the response with a specific HTTP status
-
updateUnitLifeCyclesUnitTemporaryByOperation
@POST @Path("/operations/{id_op}/bulklifecycles/unit/temporary") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateUnitLifeCyclesUnitTemporaryByOperation(@PathParam("id_op") java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
-
updateUnitLifeCyclesGOTTemporaryByOperation
@POST @Path("/operations/{id_op}/bulklifecycles/got/temporary") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateUnitLifeCyclesGOTTemporaryByOperation(@PathParam("id_op") java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
-
updateUnitLifeCyclesUnitByOperation
@POST @Path("/operations/{id_op}/bulklifecycles/unit") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateUnitLifeCyclesUnitByOperation(@PathParam("id_op") java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
-
updateUnitLifeCyclesGOTByOperation
@POST @Path("/operations/{id_op}/bulklifecycles/got") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateUnitLifeCyclesGOTByOperation(@PathParam("id_op") java.lang.String operationId, java.util.List<LogbookLifeCycleParametersBulk> logbookLifeCycleParametersBulk)
-
updateUnitLifeCyclesUnitTemporaryByOperation
@PUT @Path("/operations/{id_op}/unitlifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateUnitLifeCyclesUnitTemporaryByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String unitLcId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, LogbookLifeCycleUnitParameters parameters)
Update Unit Life Cycle- Parameters:
operationId
- the operation idunitLcId
- the life cycle idevtStatus
- the operation type : Update or Commit the lifeCycleparameters
- the json serialized as a LogbookLifeCycleUnitParameters.- Returns:
- the response with a specific HTTP status
-
deleteUnitLifeCyclesByOperation
@DELETE @Path("/operations/{id_op}/unitlifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response deleteUnitLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String unitLcId)
Delete Unit Life Cycle- Parameters:
operationId
- the operation idunitLcId
- the life cycle id- Returns:
- the response with a specific HTTP status
-
commitUnitLifeCyclesByOperation
@Deprecated @PUT @Path("/operations/{id_op}/unitlifecycles/{id_lc}/commit") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response commitUnitLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String unitLcId)
Deprecated.Commit Unit Life Cycle- Parameters:
operationId
- the operation idunitLcId
- the life cycle id- Returns:
- the response with a specific HTTP status
-
bulkCreateUnit
@POST @Path("/operations/{id_op}/unitlifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response bulkCreateUnit(@PathParam("id_op") java.lang.String idOp, java.lang.String array)
Lifecycle Unit Bulk Create- Parameters:
idOp
- the operation idarray
- Lifecycle Unit Logbooks as ArrayNode- Returns:
- Response of CREATED
-
createLifeCycleObjectGroupBulk
@PUT @Path("/operations/{id_op}/lifecycles/objectgroup/bulk") @Consumes("application/json") public javax.ws.rs.core.Response createLifeCycleObjectGroupBulk(@PathParam("id_op") java.lang.String idOp, java.util.List<LogbookLifeCycleObjectGroupModel> logbookLifeCycleModels)
Lifecycle Unit Bulk Create- Parameters:
idOp
- the operation idlogbookLifeCycleModels
- Lifecycle Unit Logbooks as ArrayNode- Returns:
- Response of CREATED
-
createLifeCycleUnitBulk
@PUT @Path("/operations/{id_op}/lifecycles/unit/bulk") @Consumes("application/json") public javax.ws.rs.core.Response createLifeCycleUnitBulk(@PathParam("id_op") java.lang.String idOp, java.util.List<LogbookLifeCycleUnitModel> logbookLifeCycleModels)
Lifecycle Unit Bulk Create- Parameters:
idOp
- the operation idlogbookLifeCycleModels
- Lifecycle Unit Logbooks as ArrayNode- Returns:
- Response of CREATED
-
updateBulkUnit
@PUT @Path("/operations/{id_op}/unitlifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateBulkUnit(@PathParam("id_op") java.lang.String idOp, java.lang.String arrayNodeLifecycle)
Update Lifecycle With Bulk Mode- Parameters:
idOp
- the operation idarrayNodeLifecycle
- as ArrayNode of operations to add to existing Lifecycle Logbook entry- Returns:
- Response with a status of OK if updated
-
getUnitLifeCycleById
@GET @Path("/unitlifecycles/{id_lc}") @Produces("application/json") public javax.ws.rs.core.Response getUnitLifeCycleById(@PathParam("id_lc") java.lang.String unitLifeCycleId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) throws VitamDBException
gets the unit life cycle based on its id- Parameters:
unitLifeCycleId
- the unit life cycle idevtStatus
- the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESSqueryDsl
- the query to get unit lfc- Returns:
- the unit life cycle
- Throws:
VitamDBException
-
getUnitLifeCycleStatus
@HEAD @Path("/unitlifecycles/{id_lc}") public javax.ws.rs.core.Response getUnitLifeCycleStatus(@PathParam("id_lc") java.lang.String unitLifeCycleId)
Gets the unit life cycle status based on its id- Parameters:
unitLifeCycleId
- the unit life cycle id- Returns:
- the unit life cycle status : Committed or In process
-
getUnitLifeCycles
@GET @Path("/unitlifecycles") @Produces("application/json") @Consumes("application/json") public javax.ws.rs.core.Response getUnitLifeCycles(com.fasterxml.jackson.databind.JsonNode queryDsl, @HeaderParam("X-Event-Status") java.lang.String evtStatus) throws VitamDBException
Gets a list of unit lifeCycles using a queryDsl- Parameters:
queryDsl
- a DSL queryevtStatus
- the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS- Returns:
- a list of unit lifeCycles
- Throws:
VitamDBException
-
exportRawUnitLifecyclesByLastPersistedDate
@POST @Path("/raw/unitlifecycles/bylastpersisteddate") @Produces("application/octet-stream") @Consumes("application/json") public javax.ws.rs.core.Response exportRawUnitLifecyclesByLastPersistedDate(RawLifecycleByLastPersistedDateRequest request)
Export raw unit life cycles by request- Parameters:
request
- the request- Returns:
- a streamed list of unit lifeCycles
-
getRawUnitLifeCycleById
@GET @Path("/raw/unitlifecycles/byid/{id}") @Produces("application/json") @Consumes("application/json") public javax.ws.rs.core.Response getRawUnitLifeCycleById(@PathParam("id") java.lang.String id)
Gets a list of raw unit lifeCycles by id- Parameters:
id
- the id to retrieve- Returns:
- a the unit lifecycle in raw format
-
getRawUnitLifeCycleByIds
@GET @Path("/raw/unitlifecycles/byids") @Produces("application/json") @Consumes("application/json") public javax.ws.rs.core.Response getRawUnitLifeCycleByIds(java.util.List<java.lang.String> ids)
Gets a list of raw unit lifeCycles by ids- Parameters:
ids
- the ids to retrieve- Returns:
- a the unit lifecycle in raw format
-
getObjectGroupLifeCyclesByOperation
@GET @Path("/operations/{id_op}/objectgrouplifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode query)
GET multiple Unit Life Cycles- Parameters:
operationId
- the operation idevtStatus
- the evenement status (commited / not_commited)query
- as JsonNode- Returns:
- the response with a specific HTTP status
-
createObjectGroupLifeCyclesByOperation
@POST @Path("/operations/{id_op}/objectgrouplifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String objGrpId, LogbookLifeCycleObjectGroupParameters parameters)
Create object Group Life Cycle- Parameters:
operationId
- the operation idobjGrpId
- the life cycle idparameters
- the json serialized as a LogbookLifeCycleObjectGroupParameters.- Returns:
- the response with a specific HTTP status
-
updateObjectGroupLifeCyclesByOperation
@PUT @Path("/operations/{id_op}/objectgrouplifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String objGrpId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, LogbookLifeCycleObjectGroupParameters parameters)
Update object Group Life Cycle- Parameters:
operationId
- the operation idobjGrpId
- the life cycle idevtStatus
- the operation type : Update or Commit the lifeCycleparameters
- the json serialized as a LogbookLifeCycleObjectGroupParameters.- Returns:
- the response with a specific HTTP status
-
deleteObjectGroupLifeCyclesByOperation
@DELETE @Path("/operations/{id_op}/objectgrouplifecycles/{id_lc}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response deleteObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String objGrpId)
Delete object Group Life Cycle- Parameters:
operationId
- the operation idobjGrpId
- the life cycle id- Returns:
- the response with a specific HTTP status
-
commitObjectGroupLifeCyclesByOperation
@Deprecated @PUT @Path("/operations/{id_op}/objectgrouplifecycles/{id_lc}/commit") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response commitObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId, @PathParam("id_lc") java.lang.String objGrpId)
Deprecated.Commit object Group Life Cycle- Parameters:
operationId
- the operation idobjGrpId
- the life cycle id- Returns:
- the response with a specific HTTP status
-
bulkCreateObjectGroup
@POST @Path("/operations/{id_op}/objectgrouplifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response bulkCreateObjectGroup(@PathParam("id_op") java.lang.String idOp, java.lang.String array)
Lifecycle ObjectGroup Bulk Create- Parameters:
idOp
- the operation idarray
- Lifecycle ObjectGroup Logbooks as ArrayNode- Returns:
- Response of CREATED
-
updateBulkObjectGroup
@PUT @Path("/operations/{id_op}/objectgrouplifecycles") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateBulkObjectGroup(@PathParam("id_op") java.lang.String idOp, java.lang.String arrayNodeLifecycle)
Update Lifecycle ObjectGroup With Bulk Mode- Parameters:
idOp
- the operation idarrayNodeLifecycle
- as ArrayNode of operations to add to existing Lifecycle Logbook entry- Returns:
- Response with a status of OK if updated
-
getObjectGroupLifeCycleById
@GET @Path("/objectgrouplifecycles/{id_lc}") @Produces("application/json") public javax.ws.rs.core.Response getObjectGroupLifeCycleById(@PathParam("id_lc") java.lang.String objectGroupLifeCycleId, @HeaderParam("X-Event-Status") java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) throws VitamDBException
Gets the object group life cycle based on its id and using the passed DSL query- Parameters:
objectGroupLifeCycleId
- the object group life cycle idevtStatus
- the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESSqueryDsl
- the DSL query- Returns:
- a Response that contains the object group life cycle
- Throws:
VitamDBException
-
getObjectGroupLifeCycles
@GET @Path("/objectgrouplifecycles") @Produces("application/json") public javax.ws.rs.core.Response getObjectGroupLifeCycles(@HeaderParam("X-Event-Status") java.lang.String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) throws VitamDBException
Gets the object group life cycles based on the passed DSL query- Parameters:
evtStatus
- the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESSqueryDsl
- the DSL query- Returns:
- a Response that contains the object group life cycle
- Throws:
VitamDBException
-
getObjectGroupLifeCycleStatus
@HEAD @Path("/objectgrouplifecycles/{id_lc}") public javax.ws.rs.core.Response getObjectGroupLifeCycleStatus(@PathParam("id_lc") java.lang.String objectGroupLifeCycleId)
Gets the objectGroup life cycle status based on its id- Parameters:
objectGroupLifeCycleId
- the object group cycle id- Returns:
- the object group cycle status : Committed or In process
-
exportRawObjectGroupLifecyclesByLastPersistedDate
@POST @Path("/raw/objectgrouplifecycles/bylastpersisteddate") @Produces("application/octet-stream") @Consumes("application/json") public javax.ws.rs.core.Response exportRawObjectGroupLifecyclesByLastPersistedDate(RawLifecycleByLastPersistedDateRequest request)
Export raw object group life cycles by request- Parameters:
request
- the request- Returns:
- a streamed list of unit lifeCycles
-
getRawObjectGroupLifeCycleById
@GET @Path("/raw/objectgrouplifecycles/byid/{id}") @Produces("application/json") @Consumes("application/json") public javax.ws.rs.core.Response getRawObjectGroupLifeCycleById(@PathParam("id") java.lang.String id)
Gets a list of raw object group lifeCycles by id- Parameters:
id
- the id to retrieve- Returns:
- a the object group lifecycle in raw format
-
getRawObjectGroupLifeCycleByIds
@GET @Path("/raw/objectgrouplifecycles/byids") @Produces("application/json") @Consumes("application/json") public javax.ws.rs.core.Response getRawObjectGroupLifeCycleByIds(java.util.List<java.lang.String> ids)
Gets a list of raw object group lifeCycles by ids- Parameters:
ids
- the id to retrieve- Returns:
- a the object group lifecycle in raw format
-
rollBackUnitLifeCyclesByOperation
@DELETE @Path("/operations/{id_op}/unitlifecycles") public javax.ws.rs.core.Response rollBackUnitLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId)
Deletes all temporary Unit lifeCycles created during a given operation- Parameters:
operationId
- the operation id- Returns:
- a Response that contains the result of deletion operation
-
rollBackObjectGroupLifeCyclesByOperation
@DELETE @Path("/operations/{id_op}/objectgrouplifecycles") public javax.ws.rs.core.Response rollBackObjectGroupLifeCyclesByOperation(@PathParam("id_op") java.lang.String operationId)
Deletes all temporary ObjectGroup lifeCycles created during a given operation- Parameters:
operationId
- the operation id- Returns:
- a Response that contains the result of deletion operation
-
traceabilityLfcUnit
@POST @Path("/lifecycles/units/traceability") @Produces("application/json") public javax.ws.rs.core.Response traceabilityLfcUnit(@HeaderParam("X-Tenant-Id") java.lang.String xTenantId)
Runs unit lifecycle traceability- Parameters:
xTenantId
- the tenant id- Returns:
- the response with a specific HTTP status
-
traceabilityLfcObjectGroup
@POST @Path("/lifecycles/objectgroups/traceability") @Produces("application/json") public javax.ws.rs.core.Response traceabilityLfcObjectGroup(@HeaderParam("X-Tenant-Id") java.lang.String xTenantId)
Runs object group lifecycle traceability- Parameters:
xTenantId
- the tenant id- Returns:
- the response with a specific HTTP status
-
checkLifecycleTraceabilityStatus
@GET @Path("/lifecycles/traceability/check/{id}") @Produces("application/json") public javax.ws.rs.core.Response checkLifecycleTraceabilityStatus(@PathParam("id") java.lang.String operationId)
Runs unit lifecycle traceability- Parameters:
operationId
- the process id- Returns:
- the response with a specific HTTP status
-
reindex
@Path("/reindex") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response reindex(IndexParameters indexParameters)
Reindex a collection- Parameters:
indexParameters
- parameters specifying what to reindex- Returns:
- Response
-
changeIndexes
@Path("/alias") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response changeIndexes(SwitchIndexParameters switchIndexParameters)
Switch indexes- Parameters:
switchIndexParameters
-- Returns:
- Response
-
launchTraceabilityAudit
@Path("/auditTraceability") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response launchTraceabilityAudit(AuditLogbookOptions options)
-
deleteObjectGroups
@DELETE @Path("/objectgrouplifecycles/bulkDelete") @Produces("application/json") public javax.ws.rs.core.Response deleteObjectGroups(java.util.List<java.lang.String> objectGroupIds)
-
deleteUnits
@DELETE @Produces("application/json") @Path("/lifeCycleUnits/bulkDelete") public javax.ws.rs.core.Response deleteUnits(java.util.List<java.lang.String> unitsIdentifier)
-
-