Class AdminManagementExternalResource
java.lang.Object
fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
fr.gouv.vitam.access.external.rest.AdminManagementExternalResource
@Path("/admin-external/v1")
@ApplicationPath("webresources")
public class AdminManagementExternalResource
extends ApplicationStatusResource
-
Field Summary
FieldsFields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
STATUS_URL, TENANTS_URL -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.ResponsearchiveUnitProfileSchema(String archiveUnitProfileId) javax.ws.rs.core.ResponsecheckAgencies(InputStream document) check agenciesjavax.ws.rs.core.ResponsecheckDocument(InputStream document) checkFormatjavax.ws.rs.core.ResponsecheckEvidenceAudit(com.fasterxml.jackson.databind.JsonNode select) launch a traceability audit for the queryjavax.ws.rs.core.ResponsecheckOperationTraceability(com.fasterxml.jackson.databind.JsonNode query) Deprecated.javax.ws.rs.core.ResponsecheckRules(InputStream document) checkRulesjavax.ws.rs.core.ResponsecreateArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of archive unit profilesjavax.ws.rs.core.ResponsecreateArchiveUnitProfiles(InputStream document) Import archive unit profilesjavax.ws.rs.core.ResponsePosts a new logbook entry to Vitamjavax.ws.rs.core.ResponsecreateProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of profilesjavax.ws.rs.core.ResponsecreateProfiles(InputStream document) Import a profiles documentjavax.ws.rs.core.ResponsedeleteUnitExternalSchema(List<String> paths) javax.ws.rs.core.Responsejavax.ws.rs.core.Responsejavax.ws.rs.core.Responsejavax.ws.rs.core.ResponsedownloadProfileFile(String fileId) Download the profile file
The caller is responsible to close the Response after consuming the inputStream.javax.ws.rs.core.Responsejavax.ws.rs.core.ResponseDownload report stored by Administration operation (currently administration reports )javax.ws.rs.core.ResponsedownloadTraceabilityFile(String fileId) Download the traceability file
The caller is responsible to close the Response after consuming the inputStream.javax.ws.rs.core.ResponseexportProbativeValue(ProbativeValueRequest probativeValueRequest) launch probative value requestjavax.ws.rs.core.ResponsefindAccessContracts(com.fasterxml.jackson.databind.JsonNode select) findAccessContracts using get methodjavax.ws.rs.core.ResponsefindAccessContractsByID(String documentId) findAccessContractsByIDjavax.ws.rs.core.ResponsefindAccessionRegisterDetail(String originatingAgency, com.fasterxml.jackson.databind.JsonNode select) findAccessionRegisterDetailjavax.ws.rs.core.ResponsefindAgencies(com.fasterxml.jackson.databind.JsonNode select) findContexts using get methodjavax.ws.rs.core.ResponsefindAgencyByID(String documentId) findRuleByIDjavax.ws.rs.core.ResponsefindArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode select) find archive unit Profiles using get methodjavax.ws.rs.core.ResponsefindArchiveUnitProfilesByID(String documentId) find archive unit profiles by idjavax.ws.rs.core.ResponsefindContextById(String documentId) findContextByIdjavax.ws.rs.core.ResponsefindContexts(com.fasterxml.jackson.databind.JsonNode select) findContexts using get methodjavax.ws.rs.core.ResponsefindFormatByID(String documentId) findFormatByIDjavax.ws.rs.core.ResponsefindGriffin(com.fasterxml.jackson.databind.JsonNode select) javax.ws.rs.core.ResponsefindGriffinByID(String documentId) javax.ws.rs.core.ResponsefindIngestContracts(com.fasterxml.jackson.databind.JsonNode select) findIngestContracts using get methodjavax.ws.rs.core.ResponsefindIngestContractsByID(String documentId) findIngestContractsByIDjavax.ws.rs.core.ResponsefindJobs()javax.ws.rs.core.ResponsefindManagementContracts(com.fasterxml.jackson.databind.JsonNode select) findManagementContracts using get methodjavax.ws.rs.core.ResponsefindManagementContractsByID(String documentId) findManagementContractsByIDjavax.ws.rs.core.ResponsefindOntologies(com.fasterxml.jackson.databind.JsonNode select) find ontologies using get methodjavax.ws.rs.core.ResponsefindOntologiesByID(String documentId) find an ontology by idjavax.ws.rs.core.ResponsefindPreservationByID(String documentId) javax.ws.rs.core.ResponsefindPreservationScenarios(com.fasterxml.jackson.databind.JsonNode select) javax.ws.rs.core.ResponsefindProfiles(com.fasterxml.jackson.databind.JsonNode select) findProfiles using get methodjavax.ws.rs.core.ResponsefindProfilesByID(String documentId) findProfilesByIDjavax.ws.rs.core.ResponsefindRuleByID(String documentId) findRuleByIDjavax.ws.rs.core.ResponsefindSecurityProfileByIdentifier(String identifier) Find security profile by identifierjavax.ws.rs.core.ResponsefindSecurityProfiles(com.fasterxml.jackson.databind.JsonNode select) Find security profiles using get methodjavax.ws.rs.core.ResponseforcePause(ProcessPause info) Pause the processes specified by ProcessPause infojavax.ws.rs.core.ResponsegetAccessionRegister(com.fasterxml.jackson.databind.JsonNode select) getAccessionRegister using get methodjavax.ws.rs.core.ResponsegetAccessionRegisterDetails(com.fasterxml.jackson.databind.JsonNode select) getAccessionRegisterDetails using get methodjavax.ws.rs.core.ResponsegetAccessionRegisterSymbolic(com.fasterxml.jackson.databind.JsonNode select) Retrieve accession register symbolicjavax.ws.rs.core.ResponsegetFormats(com.fasterxml.jackson.databind.JsonNode select) getFormats using get methodjavax.ws.rs.core.Responseget the workflow statusjavax.ws.rs.core.Responsejavax.ws.rs.core.ResponsegetRules(com.fasterxml.jackson.databind.JsonNode select) getRules using get methodjavax.ws.rs.core.ResponsegetWorkflowDefinitions(javax.ws.rs.core.HttpHeaders headers) javax.ws.rs.core.Responsejavax.ws.rs.core.ResponseimportAccessContracts(com.fasterxml.jackson.databind.JsonNode contract) Import a set of access contracts.javax.ws.rs.core.ResponseimportAgenciesFile(javax.ws.rs.core.HttpHeaders headers, InputStream document) Import a agencies documentjavax.ws.rs.core.ResponseimportContexts(com.fasterxml.jackson.databind.JsonNode select) Import a set of contextsjavax.ws.rs.core.ResponseimportFormat(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, InputStream document) Import a formatjavax.ws.rs.core.ResponseimportGriffin(com.fasterxml.jackson.databind.JsonNode griffins) javax.ws.rs.core.ResponseimportIngestContracts(com.fasterxml.jackson.databind.JsonNode select) Import a set of ingest contracts.javax.ws.rs.core.ResponseimportManagementContracts(com.fasterxml.jackson.databind.JsonNode contract) Import a set of management contracts.javax.ws.rs.core.ResponseimportOntologies(boolean forceUpdate, com.fasterxml.jackson.databind.JsonNode ontologies) Import a set of ontologiesjavax.ws.rs.core.ResponseimportPreservationScenario(com.fasterxml.jackson.databind.JsonNode preservationScenarios) javax.ws.rs.core.ResponseimportProfileFile(javax.ws.rs.core.UriInfo uriInfo, String profileMetadataId, InputStream profileFile) Import a Profile file document (xsd or rng, ...)javax.ws.rs.core.ResponseimportRulesFile(javax.ws.rs.core.HttpHeaders headers, InputStream document) Import a rules documentjavax.ws.rs.core.ResponseimportSecurityProfiles(com.fasterxml.jackson.databind.JsonNode document) Import security profile documentsjavax.ws.rs.core.ResponseimportUnitExternalSchema(com.fasterxml.jackson.databind.JsonNode externalSchema) javax.ws.rs.core.ResponseinterruptWorkFlowExecution(String id, boolean force) Interrupt the process of an operation identified by Id.javax.ws.rs.core.ResponselaunchAudit(AuditOptions options) launch Auditjavax.ws.rs.core.Responselaunch Auditjavax.ws.rs.core.ResponselinkedCheckOperationTraceability(com.fasterxml.jackson.databind.JsonNode query) Checks a list of traceability operationjavax.ws.rs.core.ResponselistOperationsDetails(javax.ws.rs.core.HttpHeaders headers, ProcessQuery query) javax.ws.rs.core.ResponseList secured resource end pointsjavax.ws.rs.core.Responsejavax.ws.rs.core.ResponserectificationAudit(String operationId) launch a rectification audit for the operationjavax.ws.rs.core.ResponseremoveForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause infojavax.ws.rs.core.Responsejavax.ws.rs.core.ResponseupdateAccessContract(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update access contractjavax.ws.rs.core.ResponseupdateArchiveUnitProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update archive unit profilejavax.ws.rs.core.ResponseupdateContext(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update contextjavax.ws.rs.core.ResponseupdateIngestContract(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update ingest contractjavax.ws.rs.core.ResponseupdateManagementContract(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update management contractjavax.ws.rs.core.ResponseupdateProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update profilejavax.ws.rs.core.ResponseupdateSecurityProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update a security profilejavax.ws.rs.core.ResponseupdateWorkFlowStatus(javax.ws.rs.core.HttpHeaders headers, String id) Update the status of an operation.Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
getServerTenants, status
-
Field Details
-
UNIT_SCHEMA
- See Also:
-
ARCHIVE_UNIT_PROFILE_SCHEMA
- See Also:
-
OBJECTGROUP_SCHEMA
- See Also:
-
-
Method Details
-
listResourceEndpoints
@Path("/") @OPTIONS @Produces("application/json") public javax.ws.rs.core.Response listResourceEndpoints()List secured resource end points -
checkDocument
@Path("/formatsfilecheck") @POST @Consumes("application/octet-stream") @Produces("application/octet-stream") public javax.ws.rs.core.Response checkDocument(InputStream document) checkFormat- Parameters:
document- the document to check- Returns:
- Response
-
checkRules
@Path("/rulesfilecheck") @POST @Consumes("application/octet-stream") @Produces("application/octet-stream") public javax.ws.rs.core.Response checkRules(InputStream document) checkRules- Parameters:
document- the document to check- Returns:
- Response
-
checkAgencies
@Path("/agenciesfilecheck") @POST @Consumes("application/octet-stream") @Produces("application/octet-stream") public javax.ws.rs.core.Response checkAgencies(InputStream document) check agencies- Parameters:
document-- Returns:
-
importFormat
@Path("/formats") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importFormat(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, InputStream document) Import a format- Parameters:
headers- http headersuriInfo- used to construct the created resource and send it back as location in the responsedocument- inputStream representing the data to import- Returns:
- The jaxRs Response
-
importRulesFile
@Path("/rules") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importRulesFile(@Context javax.ws.rs.core.HttpHeaders headers, InputStream document) Import a rules document- Parameters:
headers- http headersdocument- inputStream representing the data to import- Returns:
- The jaxRs Response
-
importIngestContracts
@Path("/ingestcontracts") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importIngestContracts(com.fasterxml.jackson.databind.JsonNode select) Import a set of ingest contracts.- Parameters:
select- the select query to find document- Returns:
- Response
-
importAccessContracts
@Path("/accesscontracts") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importAccessContracts(com.fasterxml.jackson.databind.JsonNode contract) Import a set of access contracts.- Parameters:
contract- the input set of contracts as json- Returns:
- Response
-
importManagementContracts
@Path("/managementcontracts") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importManagementContracts(com.fasterxml.jackson.databind.JsonNode contract) Import a set of management contracts.- Parameters:
contract- the input set of contracts as json- Returns:
- Response
-
importContexts
@Path("/contexts") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importContexts(com.fasterxml.jackson.databind.JsonNode select) Import a set of contexts- Parameters:
select- the select query to find document- Returns:
- Response
-
createProfiles
@Path("/profiles") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response createProfiles(InputStream document) Import a profiles document- Parameters:
document- inputStream representing the data to import- Returns:
- The jaxRs Response
-
createProfiles
@Path("/profiles") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of profiles- Parameters:
select- the select query to find document- Returns:
- Response
-
createArchiveUnitProfiles
@Path("/archiveunitprofiles") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response createArchiveUnitProfiles(InputStream document) Import archive unit profiles- Parameters:
document- inputStream representing the data to import- Returns:
- The jaxRs Response
-
createArchiveUnitProfiles
@Path("/archiveunitprofiles") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of archive unit profiles- Parameters:
select- the select query to find document- Returns:
- Response
-
importProfileFile
@Path("/profiles/{id:.+}") @PUT @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importProfileFile(@Context javax.ws.rs.core.UriInfo uriInfo, @PathParam("id") String profileMetadataId, InputStream profileFile) Import a Profile file document (xsd or rng, ...)- Parameters:
uriInfo- used to construct the created resource and send it back as location in the responseprofileMetadataId- id of the profile metadataprofileFile- inputStream representing the data to import- Returns:
- The jaxRs Response
-
downloadProfileFile
@GET @Path("/profiles/{id:.+}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadProfileFile(@PathParam("id") String fileId) Download the profile file
The caller is responsible to close the Response after consuming the inputStream.- Parameters:
fileId-
-
downloadTraceabilityFile
@GET @Path("/traceability/{id}/datafiles") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadTraceabilityFile(@PathParam("id") String fileId) Download the traceability file
The caller is responsible to close the Response after consuming the inputStream.- Parameters:
fileId-
-
getFormats
@Path("/formats") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getFormats(com.fasterxml.jackson.databind.JsonNode select) getFormats using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
getRules
@Path("/rules") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getRules(com.fasterxml.jackson.databind.JsonNode select) getRules using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findIngestContracts
@Path("/ingestcontracts") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findIngestContracts(com.fasterxml.jackson.databind.JsonNode select) findIngestContracts using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findAccessContracts
@Path("/accesscontracts") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findAccessContracts(com.fasterxml.jackson.databind.JsonNode select) findAccessContracts using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findManagementContracts
@Path("/managementcontracts") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findManagementContracts(com.fasterxml.jackson.databind.JsonNode select) findManagementContracts using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findProfiles
@Path("/profiles") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findProfiles(com.fasterxml.jackson.databind.JsonNode select) findProfiles using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findArchiveUnitProfiles
@Path("/archiveunitprofiles") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode select) find archive unit Profiles using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findContexts
@Path("/contexts") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findContexts(com.fasterxml.jackson.databind.JsonNode select) findContexts using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
importAgenciesFile
@Path("/agencies") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importAgenciesFile(@Context javax.ws.rs.core.HttpHeaders headers, InputStream document) Import a agencies document- Parameters:
headers- http headersdocument- inputStream representing the data to import- Returns:
- The jaxRs Response
- Throws:
InvalidParseOperationException
-
findAgencyByID
@Path("/agencies/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findAgencyByID(@PathParam("id_document") String documentId) findRuleByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findAgencies
@Path("/agencies") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findAgencies(com.fasterxml.jackson.databind.JsonNode select) throws IOException findContexts using get method- Parameters:
select- the select query to find document- Returns:
- Response
- Throws:
IOException
-
getAccessionRegister
@Path("/accessionregisters") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getAccessionRegister(com.fasterxml.jackson.databind.JsonNode select) getAccessionRegister using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
getAccessionRegisterDetails
@Path("accessionregisterdetails") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getAccessionRegisterDetails(com.fasterxml.jackson.databind.JsonNode select) getAccessionRegisterDetails using get method- Parameters:
select- the DSL select query to find documents- Returns:
- Response
-
getAccessionRegisterSymbolic
@GET @Path("accessionregisterssymbolic") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getAccessionRegisterSymbolic(com.fasterxml.jackson.databind.JsonNode select) Retrieve accession register symbolic- Parameters:
select- the select query to find document- Returns:
- an accession register symbolic
-
findFormatByID
@Path("/formats/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findFormatByID(@PathParam("id_document") String documentId) findFormatByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findRuleByID
@Path("/rules/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findRuleByID(@PathParam("id_document") String documentId) findRuleByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findIngestContractsByID
@Path("/ingestcontracts/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findIngestContractsByID(@PathParam("id_document") String documentId) findIngestContractsByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findAccessContractsByID
@Path("/accesscontracts/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findAccessContractsByID(@PathParam("id_document") String documentId) findAccessContractsByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findManagementContractsByID
@Path("/managementcontracts/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findManagementContractsByID(@PathParam("id_document") String documentId) findManagementContractsByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findProfilesByID
@Path("/profiles/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findProfilesByID(@PathParam("id_document") String documentId) findProfilesByID- Parameters:
documentId- the document id to find- Returns:
- Response
-
findArchiveUnitProfilesByID
@Path("/archiveunitprofiles/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findArchiveUnitProfilesByID(@PathParam("id_document") String documentId) find archive unit profiles by id- Parameters:
documentId- the archive unit profile ID to find- Returns:
- Response the matching archive unit profile or an error
-
findContextById
@Path("/contexts/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findContextById(@PathParam("id_document") String documentId) findContextById- Parameters:
documentId- the document id to find- Returns:
- Response
-
updateContext
@Path("/contexts/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateContext(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException, InvalidParseOperationException Update context- Parameters:
identifier-queryDsl-- Returns:
- Response
- Throws:
AdminManagementClientServerExceptionInvalidParseOperationException
-
updateProfile
@Path("/profiles/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateProfile(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException, InvalidParseOperationException Update profile- Parameters:
identifier-queryDsl-- Returns:
- Response
- Throws:
AdminManagementClientServerExceptionInvalidParseOperationException
-
updateArchiveUnitProfile
@Path("/archiveunitprofiles/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateArchiveUnitProfile(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException Update archive unit profile- Parameters:
identifier-queryDsl-- Returns:
- Response
- Throws:
AdminManagementClientServerExceptionInvalidParseOperationException
-
updateAccessContract
@Path("/accesscontracts/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateAccessContract(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException Update access contract- Parameters:
identifier-queryDsl-- Returns:
- Response
- Throws:
AdminManagementClientServerException
-
updateIngestContract
@Path("/ingestcontracts/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateIngestContract(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException Update ingest contract- Parameters:
identifier-queryDsl-- Returns:
- Response
- Throws:
AdminManagementClientServerException
-
updateManagementContract
@Path("/managementcontracts/{identifier:.+}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateManagementContract(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update management contract- Parameters:
identifier-queryDsl-- Returns:
- Response
-
findAccessionRegisterDetail
@GET @Path("/accessionregisters/{id_document}/accessionregisterdetails") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findAccessionRegisterDetail(@PathParam("id_document") String originatingAgency, com.fasterxml.jackson.databind.JsonNode select) findAccessionRegisterDetail- Parameters:
originatingAgency- the document id of accession register to getselect- the query to get document- Returns:
- Response
-
checkOperationTraceability
@POST @Path("/traceabilitychecks") @Consumes("application/json") @Produces("application/json") @Deprecated public javax.ws.rs.core.Response checkOperationTraceability(com.fasterxml.jackson.databind.JsonNode query) Deprecated.Checks a traceability operation- Parameters:
query- the DSLQuery used to find the traceability operation to validate- Returns:
- The verification report == the logbookOperation
-
linkedCheckOperationTraceability
@POST @Path("/traceability/linkedchecks") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response linkedCheckOperationTraceability(com.fasterxml.jackson.databind.JsonNode query) Checks a list of traceability operation- Parameters:
query- the DSLQuery used to find the traceability operation to validate- Returns:
- The verification report == the logbookOperation
-
launchReferentialAudit
@POST @Path("/audits/referential") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response launchReferentialAudit(AuditReferentialOptions options) launch Audit- Parameters:
options-- Returns:
- response
-
launchAudit
@POST @Path("/audits") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response launchAudit(AuditOptions options) launch Audit- Parameters:
options-- Returns:
- response
-
importSecurityProfiles
@Path("/securityprofiles") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importSecurityProfiles(com.fasterxml.jackson.databind.JsonNode document) Import security profile documents- Parameters:
document- the security profile to import- Returns:
- Response
-
exportProbativeValue
@POST @Path("/probativevalueexport") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response exportProbativeValue(ProbativeValueRequest probativeValueRequest) launch probative value request- Parameters:
probativeValueRequest- the request- Returns:
- Response
-
findSecurityProfiles
@Path("/securityprofiles") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findSecurityProfiles(com.fasterxml.jackson.databind.JsonNode select) Find security profiles using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findSecurityProfileByIdentifier
@Path("/securityprofiles/{identifier}") @GET @Produces("application/json") public javax.ws.rs.core.Response findSecurityProfileByIdentifier(@PathParam("identifier") String identifier) Find security profile by identifier- Parameters:
identifier- the identifier of the security profile to find- Returns:
- Response
-
updateSecurityProfile
@Path("/securityprofiles/{identifier}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateSecurityProfile(@PathParam("identifier") String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException Update a security profile- Parameters:
identifier- the identifier of the security profile to updatequeryDsl- query to execute- Returns:
- Response
- Throws:
AdminManagementClientServerException
-
listOperationsDetails
@GET @Path("/operations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response listOperationsDetails(@Context javax.ws.rs.core.HttpHeaders headers, ProcessQuery query) - Parameters:
headers- the http header of requestquery- the filter query- Returns:
- the list of Operations details
-
getWorkFlowExecutionStatus
@Path("operations/{id}") @HEAD @Produces("application/json") public javax.ws.rs.core.Response getWorkFlowExecutionStatus(@PathParam("id") String id) - Parameters:
id- operation identifier- Returns:
- http response
-
getOperationProcessExecutionDetails
@Path("operations/{id}") @GET @Produces("application/json") public javax.ws.rs.core.Response getOperationProcessExecutionDetails(@PathParam("id") String id) get the workflow status- Parameters:
id- operation identifier- Returns:
- http response
-
updateWorkFlowStatus
@Path("operations/{id}") @PUT @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response updateWorkFlowStatus(@Context javax.ws.rs.core.HttpHeaders headers, @PathParam("id") String id) Update the status of an operation.- Parameters:
headers- contain X-Action and X-Context-IDid- operation identifier- Returns:
- http response
-
interruptWorkFlowExecution
@Path("operations/{id}") @DELETE @Produces("application/json") public javax.ws.rs.core.Response interruptWorkFlowExecution(@PathParam("id") String id, @HeaderParam("X-Force") boolean force) Interrupt the process of an operation identified by Id.- Parameters:
id- operation identifierforce- set to true to force cancellation for non-cancellable steps- Returns:
- http response
-
getWorkflowDefinitions
@GET @Path("/workflows") @Produces("application/json") public javax.ws.rs.core.Response getWorkflowDefinitions(@Context javax.ws.rs.core.HttpHeaders headers) - Parameters:
headers- the http header of request- Returns:
- Response
-
downloadRulesReportAsStream
@GET @Path("/rulesreport/{opId}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadRulesReportAsStream(@PathParam("opId") String opId) Download report stored by Administration operation (currently administration reports )Return the report as stream asynchronously
The caller is responsible to close the Response after consuming the inputStream.- Parameters:
opId- the id of logbook operation- Returns:
- the given response with the report
-
downloadBatchReportAsStream
@GET @Path("/batchreport/{opId}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadBatchReportAsStream(@PathParam("opId") String opId) -
downloadDistributionReportAsStream
@GET @Path("/distributionreport/{opId}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadDistributionReportAsStream(@PathParam("opId") String opId) -
downloadAgenciesCsvAsStream
@GET @Path("/rulesreferential/{opId}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadAgenciesCsvAsStream(@PathParam("opId") String opId) -
downloadRulesCsvAsStream
@GET @Path("/agenciesreferential/{opId}") @Produces("application/octet-stream") public javax.ws.rs.core.Response downloadRulesCsvAsStream(@PathParam("opId") String opId) -
checkEvidenceAudit
@Path("/evidenceaudit") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response checkEvidenceAudit(com.fasterxml.jackson.databind.JsonNode select) launch a traceability audit for the query- Parameters:
select- the query select- Returns:
- Response
-
rectificationAudit
@Path("/rectificationaudit") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response rectificationAudit(String operationId) launch a rectification audit for the operation- Parameters:
operationId- the operation id- Returns:
- Response
-
importOntologies
@Path("/ontologies") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importOntologies(@HeaderParam("Force-Update") boolean forceUpdate, com.fasterxml.jackson.databind.JsonNode ontologies) Import a set of ontologies- Parameters:
ontologies- the ontologies to create- Returns:
- Response
-
findOntologies
@Path("/ontologies") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findOntologies(com.fasterxml.jackson.databind.JsonNode select) find ontologies using get method- Parameters:
select- the select query to find document- Returns:
- Response
-
findOntologiesByID
@Path("/ontologies/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findOntologiesByID(@PathParam("id_document") String documentId) find an ontology by id- Parameters:
documentId- the ontology ID to find- Returns:
- Response the ontology or an error
-
forcePause
@Path("/forcepause") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response forcePause(ProcessPause info) Pause the processes specified by ProcessPause info- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
-
removeForcePause
@Path("/removeforcepause") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response removeForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause info- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
-
importGriffin
@POST @Path("/griffin") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importGriffin(com.fasterxml.jackson.databind.JsonNode griffins) throws AdminManagementClientServerException -
findGriffin
@GET @Path("/griffin") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findGriffin(com.fasterxml.jackson.databind.JsonNode select) throws AdminManagementClientServerException -
findPreservationScenarios
@Path("/preservationScenario") @GET @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findPreservationScenarios(com.fasterxml.jackson.databind.JsonNode select) -
importPreservationScenario
@POST @Path("/preservationScenario") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importPreservationScenario(com.fasterxml.jackson.databind.JsonNode preservationScenarios) -
findGriffinByID
@Path("/griffin/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findGriffinByID(@PathParam("id_document") String documentId) -
findPreservationByID
@Path("/preservationScenario/{id_document:.+}") @GET @Produces("application/json") public javax.ws.rs.core.Response findPreservationByID(@PathParam("id_document") String documentId) -
createExternalOperation
@POST @Path("/logbookoperations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createExternalOperation(LogbookOperationParameters operation) Posts a new logbook entry to Vitam- Parameters:
operation- the LogbookOperationParameters- Returns:
- Response contains the list of logbook operations
-
findJobs
@GET @Path("jobs") @Produces("application/json") public javax.ws.rs.core.Response findJobs() -
unitSchema
@Path("/schema/unit") @GET @Produces("application/json") public javax.ws.rs.core.Response unitSchema() -
archiveUnitProfileSchema
@Path("/archiveunitprofiles/{id}/schema") @GET @Produces("application/json") public javax.ws.rs.core.Response archiveUnitProfileSchema(@PathParam("id") String archiveUnitProfileId) -
deleteUnitExternalSchema
-
importUnitExternalSchema
@Path("/schema/unit") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response importUnitExternalSchema(com.fasterxml.jackson.databind.JsonNode externalSchema) -
objectGroupSchema
@Path("/schema/objectgroup") @GET @Produces("application/json") public javax.ws.rs.core.Response objectGroupSchema() -
getPublicConfiguration
@Path("/configuration") @GET @Produces("application/json") public javax.ws.rs.core.Response getPublicConfiguration()
-