Package fr.gouv.vitam.access.external.rest

Class AdminManagementExternalResource

  • @Path("/admin-external/v1")
@ApplicationPath("webresources")
public class AdminManagementExternalResource
extends ApplicationStatusResource

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response checkAgencies​(java.io.InputStream document)
      check agencies
      javax.ws.rs.core.Response checkDocument​(java.io.InputStream document)
      checkFormat
      javax.ws.rs.core.Response checkEvidenceAudit​(com.fasterxml.jackson.databind.JsonNode select)
      launch a traceability audit for the query
      javax.ws.rs.core.Response checkOperationTraceability​(com.fasterxml.jackson.databind.JsonNode query)
      Deprecated.
      javax.ws.rs.core.Response checkRules​(java.io.InputStream document)
      checkRules
      javax.ws.rs.core.Response createArchiveUnitProfiles​(com.fasterxml.jackson.databind.JsonNode select)
      Import a set of archive unit profiles
      javax.ws.rs.core.Response createArchiveUnitProfiles​(java.io.InputStream document)
      Import archive unit profiles
      javax.ws.rs.core.Response createExternalOperation​(LogbookOperationParameters operation)
      Posts a new logbook entry to Vitam
      javax.ws.rs.core.Response createProfiles​(com.fasterxml.jackson.databind.JsonNode select)
      Import a set of profiles
      javax.ws.rs.core.Response createProfiles​(java.io.InputStream document)
      Import a profiles document
      javax.ws.rs.core.Response downloadAgenciesCsvAsStream​(java.lang.String opId)  
      javax.ws.rs.core.Response downloadBatchReportAsStream​(java.lang.String opId)  
      javax.ws.rs.core.Response downloadDistributionReportAsStream​(java.lang.String opId)  
      javax.ws.rs.core.Response downloadProfileFile​(java.lang.String fileId)
      Download the profile file

      The caller is responsible to close the Response after consuming the inputStream.
      javax.ws.rs.core.Response downloadRulesCsvAsStream​(java.lang.String opId)  
      javax.ws.rs.core.Response downloadRulesReportAsStream​(java.lang.String opId)
      Download report stored by Administration operation (currently administration reports )
      javax.ws.rs.core.Response downloadTraceabilityFile​(java.lang.String fileId)
      Download the traceability file

      The caller is responsible to close the Response after consuming the inputStream.
      javax.ws.rs.core.Response exportProbativeValue​(ProbativeValueRequest probativeValueRequest)
      launch probative value request
      javax.ws.rs.core.Response findAccessContracts​(com.fasterxml.jackson.databind.JsonNode select)
      findAccessContracts using get method
      javax.ws.rs.core.Response findAccessContractsByID​(java.lang.String documentId)
      findAccessContractsByID
      javax.ws.rs.core.Response findAccessionRegisterDetail​(java.lang.String originatingAgency, com.fasterxml.jackson.databind.JsonNode select)
      findAccessionRegisterDetail
      javax.ws.rs.core.Response findAgencies​(com.fasterxml.jackson.databind.JsonNode select)
      findContexts using get method
      javax.ws.rs.core.Response findAgencyByID​(java.lang.String documentId)
      findRuleByID
      javax.ws.rs.core.Response findArchiveUnitProfiles​(com.fasterxml.jackson.databind.JsonNode select)
      find archive unit Profiles using get method
      javax.ws.rs.core.Response findArchiveUnitProfilesByID​(java.lang.String documentId)
      find archive unit profiles by id
      javax.ws.rs.core.Response findContextById​(java.lang.String documentId)
      findContextById
      javax.ws.rs.core.Response findContexts​(com.fasterxml.jackson.databind.JsonNode select)
      findContexts using get method
      javax.ws.rs.core.Response findFormatByID​(java.lang.String documentId)
      findFormatByID
      javax.ws.rs.core.Response findGriffin​(com.fasterxml.jackson.databind.JsonNode select)  
      javax.ws.rs.core.Response findGriffinByID​(java.lang.String documentId)  
      javax.ws.rs.core.Response findIngestContracts​(com.fasterxml.jackson.databind.JsonNode select)
      findIngestContracts using get method
      javax.ws.rs.core.Response findIngestContractsByID​(java.lang.String documentId)
      findIngestContractsByID
      javax.ws.rs.core.Response findManagementContracts​(com.fasterxml.jackson.databind.JsonNode select)
      findManagementContracts using get method
      javax.ws.rs.core.Response findManagementContractsByID​(java.lang.String documentId)
      findManagementContractsByID
      javax.ws.rs.core.Response findOntologies​(com.fasterxml.jackson.databind.JsonNode select)
      find ontologies using get method
      javax.ws.rs.core.Response findOntologiesByID​(java.lang.String documentId)
      find an ontology by id
      javax.ws.rs.core.Response findPreservationByID​(java.lang.String documentId)  
      javax.ws.rs.core.Response findPreservationScenarios​(com.fasterxml.jackson.databind.JsonNode select)  
      javax.ws.rs.core.Response findProfiles​(com.fasterxml.jackson.databind.JsonNode select)
      findProfiles using get method
      javax.ws.rs.core.Response findProfilesByID​(java.lang.String documentId)
      findProfilesByID
      javax.ws.rs.core.Response findRuleByID​(java.lang.String documentId)
      findRuleByID
      javax.ws.rs.core.Response findSecurityProfileByIdentifier​(java.lang.String identifier)
      Find security profile by identifier
      javax.ws.rs.core.Response findSecurityProfiles​(com.fasterxml.jackson.databind.JsonNode select)
      Find security profiles using get method
      javax.ws.rs.core.Response forcePause​(ProcessPause info)
      Pause the processes specified by ProcessPause info
      javax.ws.rs.core.Response getAccessionRegister​(com.fasterxml.jackson.databind.JsonNode select)
      getAccessionRegister using get method
      javax.ws.rs.core.Response getAccessionRegisterDetails​(com.fasterxml.jackson.databind.JsonNode select)
      getAccessionRegisterDetails using get method
      javax.ws.rs.core.Response getAccessionRegisterSymbolic​(com.fasterxml.jackson.databind.JsonNode select)
      Retrieve accession register symbolic
      javax.ws.rs.core.Response getFormats​(com.fasterxml.jackson.databind.JsonNode select)
      getFormats using get method
      javax.ws.rs.core.Response getOperationProcessExecutionDetails​(java.lang.String id)
      get the workflow status
      javax.ws.rs.core.Response getRules​(com.fasterxml.jackson.databind.JsonNode select)
      getRules using get method
      javax.ws.rs.core.Response getWorkflowDefinitions​(javax.ws.rs.core.HttpHeaders headers)  
      javax.ws.rs.core.Response getWorkFlowExecutionStatus​(java.lang.String id)  
      javax.ws.rs.core.Response importAccessContracts​(com.fasterxml.jackson.databind.JsonNode contract)
      Import a set of access contracts.
      javax.ws.rs.core.Response importAgenciesFile​(javax.ws.rs.core.HttpHeaders headers, java.io.InputStream document)
      Import a agencies document
      javax.ws.rs.core.Response importContexts​(com.fasterxml.jackson.databind.JsonNode select)
      Import a set of contexts
      javax.ws.rs.core.Response importFormat​(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, java.io.InputStream document)
      Import a format
      javax.ws.rs.core.Response importGriffin​(com.fasterxml.jackson.databind.JsonNode griffins)  
      javax.ws.rs.core.Response importIngestContracts​(com.fasterxml.jackson.databind.JsonNode select)
      Import a set of ingest contracts.
      javax.ws.rs.core.Response importManagementContracts​(com.fasterxml.jackson.databind.JsonNode contract)
      Import a set of management contracts.
      javax.ws.rs.core.Response importOntologies​(boolean forceUpdate, com.fasterxml.jackson.databind.JsonNode ontologies)
      Import a set of ontologies
      javax.ws.rs.core.Response importPreservationScenario​(com.fasterxml.jackson.databind.JsonNode preservationScenarios)  
      javax.ws.rs.core.Response importProfileFile​(javax.ws.rs.core.UriInfo uriInfo, java.lang.String profileMetadataId, java.io.InputStream profileFile)
      Import a Profile file document (xsd or rng, ...)
      javax.ws.rs.core.Response importRulesFile​(javax.ws.rs.core.HttpHeaders headers, java.io.InputStream document)
      Import a rules document
      javax.ws.rs.core.Response importSecurityProfiles​(com.fasterxml.jackson.databind.JsonNode document)
      Import security profile documents
      javax.ws.rs.core.Response interruptWorkFlowExecution​(java.lang.String id)
      Interrupt the process of an operation identified by Id.
      javax.ws.rs.core.Response launchAudit​(AuditOptions options)
      launch Audit
      javax.ws.rs.core.Response launchReferentialAudit​(AuditReferentialOptions options)
      launch Audit
      javax.ws.rs.core.Response linkedCheckOperationTraceability​(com.fasterxml.jackson.databind.JsonNode query)
      Checks a list of traceability operation
      javax.ws.rs.core.Response listOperationsDetails​(javax.ws.rs.core.HttpHeaders headers, ProcessQuery query)  
      javax.ws.rs.core.Response listResourceEndpoints()
      List secured resource end points
      javax.ws.rs.core.Response rectificationAudit​(java.lang.String operationId)
      launch a rectification audit for the operation
      javax.ws.rs.core.Response removeForcePause​(ProcessPause info)
      Remove the pause for the processes specified by ProcessPause info
      javax.ws.rs.core.Response updateAccessContract​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update access contract
      javax.ws.rs.core.Response updateArchiveUnitProfile​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update archive unit profile
      javax.ws.rs.core.Response updateContext​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update context
      javax.ws.rs.core.Response updateIngestContract​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update ingest contract
      javax.ws.rs.core.Response updateManagementContract​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update management contract
      javax.ws.rs.core.Response updateProfile​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update profile
      javax.ws.rs.core.Response updateSecurityProfile​(java.lang.String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl)
      Update a security profile
      javax.ws.rs.core.Response updateWorkFlowStatus​(javax.ws.rs.core.HttpHeaders headers, java.lang.String id)
      Update the status of an operation.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • 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​(java.io.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​(java.io.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​(java.io.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,
                                              java.io.InputStream document)
        Import a format
        Parameters:
        headers - http headers
        uriInfo - used to construct the created resource and send it back as location in the response
        document - 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,
                                                 java.io.InputStream document)
        Import a rules document
        Parameters:
        headers - http headers
        document - 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​(java.io.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​(java.io.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")
                                                   java.lang.String profileMetadataId,
                                                   java.io.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 response
        profileMetadataId - id of the profile metadata
        profileFile - 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")
                                                     java.lang.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")
                                                          java.lang.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,
                                                    java.io.InputStream document)
        Import a agencies document
        Parameters:
        headers - http headers
        document - 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")
                                                java.lang.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 java.io.IOException
        findContexts using get method
        Parameters:
        select - the select query to find document
        Returns:
        Response
        Throws:
        java.io.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")
                                                java.lang.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")
                                              java.lang.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")
                                                         java.lang.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")
                                                         java.lang.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")
                                                             java.lang.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")
                                                  java.lang.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")
                                                             java.lang.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")
                                                 java.lang.String documentId)
        findContextById
        Parameters:
        documentId - the document id to find
        Returns:
        Response

      • updateAccessContract

        @Path("/accesscontracts/{identifier:.+}")
@PUT
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response updateAccessContract​(@PathParam("identifier")
                                                      java.lang.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")
                                                      java.lang.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")
                                                          java.lang.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")
                                                             java.lang.String originatingAgency,
                                                             com.fasterxml.jackson.databind.JsonNode select)
        findAccessionRegisterDetail
        Parameters:
        originatingAgency - the document id of accession register to get
        select - 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")
                                                                 java.lang.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")
                                                       java.lang.String identifier,
                                                       com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                throws AdminManagementClientServerException
        Update a security profile
        Parameters:
        identifier - the identifier of the security profile to update
        queryDsl - 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 request
        query - 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")
                                                            java.lang.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")
                                                                     java.lang.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")
                                                      java.lang.String id)
        Update the status of an operation.
        Parameters:
        headers - contain X-Action and X-Context-ID
        id - operation identifier
        Returns:
        http response

      • interruptWorkFlowExecution

        @Path("operations/{id}")
@DELETE
@Produces("application/json")
public javax.ws.rs.core.Response interruptWorkFlowExecution​(@PathParam("id")
                                                            java.lang.String id)
        Interrupt the process of an operation identified by Id.
        Parameters:
        id - operation identifier
        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")
                                                             java.lang.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")
                                                             java.lang.String opId)

      • downloadDistributionReportAsStream

        @GET
@Path("/distributionreport/{opId}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response downloadDistributionReportAsStream​(@PathParam("opId")
                                                                    java.lang.String opId)

      • downloadAgenciesCsvAsStream

        @GET
@Path("/rulesreferential/{opId}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response downloadAgenciesCsvAsStream​(@PathParam("opId")
                                                             java.lang.String opId)

      • downloadRulesCsvAsStream

        @GET
@Path("/agenciesreferential/{opId}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response downloadRulesCsvAsStream​(@PathParam("opId")
                                                          java.lang.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​(java.lang.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")
                                                    java.lang.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:

      • 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")
                                                 java.lang.String documentId)

      • findPreservationByID

        @Path("/preservationScenario/{id_document:.+}")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response findPreservationByID​(@PathParam("id_document")
                                                      java.lang.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