fr.gouv.vitam.metadata.rest

Class MetadataResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

fr.gouv.vitam.metadata.rest.MetadataResource

@Path(value="/metadata/v1")
public class MetadataResource
extends ApplicationStatusResource

Units resource REST API

Field Summary

Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

STATUS_URL, TENANTS_URL

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	changeIndexes(SwitchIndexParameters switchIndexParameters) Switch indexes
javax.ws.rs.core.Response	computedInheritedRulesCalculation(com.fasterxml.jackson.databind.JsonNode dslQuery)
javax.ws.rs.core.Response	createAccessionRegisterSymbolic()
javax.ws.rs.core.Response	deleteObjectGroups(List<String> ids)
javax.ws.rs.core.Response	deleteUnits(List<String> ids)
javax.ws.rs.core.Response	getObjectGroupById(com.fasterxml.jackson.databind.JsonNode selectRequest, String objectGroupId) Get ObjectGroup
javax.ws.rs.core.Response	getUnitById(com.fasterxml.jackson.databind.JsonNode selectRequest, String unitId)
javax.ws.rs.core.Response	insertObjectGroup(com.fasterxml.jackson.databind.JsonNode insertRequest) Create unit with json request
javax.ws.rs.core.Response	insertObjectGroupBulk(List<com.fasterxml.jackson.databind.JsonNode> insertRequests) Create unit with json request
javax.ws.rs.core.Response	insertUnitBulk(BulkUnitInsertRequest request) Insert unit with json request
javax.ws.rs.core.Response	refreshObjectGroup() Refresh ObjectGroup index
javax.ws.rs.core.Response	refreshUnit() Refresh Unit index
javax.ws.rs.core.Response	reindex(IndexParameters indexParameters) Reindex a collection
javax.ws.rs.core.Response	selectAccessionRegisterOnObjectGroupByOperationId(String operationId)
javax.ws.rs.core.Response	selectAccessionRegisterOnUnitByOperationId(String operationId)
javax.ws.rs.core.Response	selectObjectgroups(com.fasterxml.jackson.databind.JsonNode request) Select objectgroups with json request
javax.ws.rs.core.Response	selectUnit(com.fasterxml.jackson.databind.JsonNode request) Select unit with json request
javax.ws.rs.core.Response	selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode selectRequest) Select units with inherited rules
javax.ws.rs.core.Response	updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode updateRequest, String objectGroupId) Get ObjectGroup
javax.ws.rs.core.Response	updateUnitBulk(com.fasterxml.jackson.databind.JsonNode updateQuery) Update unit with json request
javax.ws.rs.core.Response	updateUnitById(com.fasterxml.jackson.databind.JsonNode updateRequest, String unitId) Update unit by query and path parameter unit_id
javax.ws.rs.core.Response	updateUnitsRulesBulk(BatchRulesUpdateInfo batchRulesUpdateInfo) Update unit rules with json request

Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

getServerTenants, status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

insertUnitBulk

@Path(value="units/bulk")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response insertUnitBulk(BulkUnitInsertRequest request)

Insert unit with json request

Parameters:

request - the bulk insert request

Returns:

Response

updateUnitBulk

@Path(value="units/updatebulk")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitBulk(com.fasterxml.jackson.databind.JsonNode updateQuery)

Update unit with json request

Parameters:

updateQuery - the insert request in JsonNode format

Returns:

Response

updateUnitsRulesBulk

@Path(value="units/updaterulesbulk")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitsRulesBulk(BatchRulesUpdateInfo batchRulesUpdateInfo)

Update unit rules with json request

Parameters:

batchRulesUpdateInfo - the update rule request

Returns:

Response

selectUnit

@Path(value="units")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response selectUnit(com.fasterxml.jackson.databind.JsonNode request)
                                                                                                                                          throws VitamDBException

Select unit with json request

Parameters:

request - the request in JsonNode format

Returns:

Response

Throws:

VitamDBException

refreshUnit

@Path(value="units")
 @PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response refreshUnit()

Refresh Unit index

Returns:

Response

selectObjectgroups

@Path(value="objectgroups")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response selectObjectgroups(com.fasterxml.jackson.databind.JsonNode request)

Select objectgroups with json request

Parameters:

request - the request in JsonNode format

Returns:

Response

refreshObjectGroup

@Path(value="objectgroups")
 @PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response refreshObjectGroup()

Refresh ObjectGroup index

Returns:

Response

getUnitById

@Path(value="units/{id_unit}")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitById(com.fasterxml.jackson.databind.JsonNode selectRequest,
                                                                                                                                                            @PathParam(value="id_unit")
                                                                                                                                                            String unitId)

Parameters:

selectRequest - the select request in JsonNode format

unitId - the unit id to get

Returns:

Response will be contains an json filled by unit result

updateUnitById

@Path(value="units/{id_unit}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitById(com.fasterxml.jackson.databind.JsonNode updateRequest,
                                                                                                                                                               @PathParam(value="id_unit")
                                                                                                                                                               String unitId)

Update unit by query and path parameter unit_id

Parameters:

updateRequest - the update request

unitId - the id of unit to be update

Returns:

Response will be contains an json filled by unit result

computedInheritedRulesCalculation

@Path(value="/units/computedInheritedRules")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response computedInheritedRulesCalculation(com.fasterxml.jackson.databind.JsonNode dslQuery)

insertObjectGroup

@Path(value="objectgroups")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response insertObjectGroup(com.fasterxml.jackson.databind.JsonNode insertRequest)

Create unit with json request

Parameters:

insertRequest - the insert query

Returns:

the Response

insertObjectGroupBulk

@Path(value="objectgroups/bulk")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response insertObjectGroupBulk(List<com.fasterxml.jackson.databind.JsonNode> insertRequests)

Create unit with json request

Parameters:

insertRequests - the insert query

Returns:

the Response

getObjectGroupById

@Path(value="objectgroups/{id_og}")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupById(com.fasterxml.jackson.databind.JsonNode selectRequest,
                                                                                                                                                                        @PathParam(value="id_og")
                                                                                                                                                                        String objectGroupId)

Get ObjectGroup

Parameters:

selectRequest - the request

objectGroupId - the objectGroup ID to get

Returns:

a response with the select query and the required object group (can be empty)

updateObjectGroupById

@Path(value="objectgroups/{id_og}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode updateRequest,
                                                                                                                                                                           @PathParam(value="id_og")
                                                                                                                                                                           String objectGroupId)

Get ObjectGroup

Parameters:

updateRequest - the query to update the objectgroup

objectGroupId - the objectGroup ID to get

Returns:

a response with the select query and the required object group (can be empty)

selectAccessionRegisterOnUnitByOperationId

@Path(value="accession-registers/units/{operationId}")
 @Produces(value="application/json")
 @GET
public javax.ws.rs.core.Response selectAccessionRegisterOnUnitByOperationId(@PathParam(value="operationId")
                                                                                                                                                                              String operationId)

createAccessionRegisterSymbolic

@POST
 @Path(value="accession-registers/symbolic")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createAccessionRegisterSymbolic()

selectAccessionRegisterOnObjectGroupByOperationId

@Path(value="accession-registers/objects/{operationId}")
 @Produces(value="application/json")
 @GET
public javax.ws.rs.core.Response selectAccessionRegisterOnObjectGroupByOperationId(@PathParam(value="operationId")
                                                                                                                                                                                       String operationId)

reindex

@Path(value="/reindex")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/alias")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response changeIndexes(SwitchIndexParameters switchIndexParameters)

Switch indexes

Parameters:

switchIndexParameters -

Returns:

Response

selectUnitsWithInheritedRules

@Path(value="unitsWithInheritedRules")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode selectRequest)

Select units with inherited rules

Parameters:

selectRequest - the select request in JsonNode format

Returns:

Response will be contains an json filled by unit result

deleteObjectGroups

@DELETE
 @Path(value="objectGroups/bulkDelete")
public javax.ws.rs.core.Response deleteObjectGroups(List<String> ids)

deleteUnits

@DELETE
 @Path(value="units/bulkDelete")
public javax.ws.rs.core.Response deleteUnits(List<String> ids)