fr.gouv.vitam.access.external.rest

Class AdminManagementExternalResource

java.lang.Object

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

fr.gouv.vitam.access.external.rest.AdminManagementExternalResource

All Implemented Interfaces:

VitamResource

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

Admin Management External Resource

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
AdminManagementExternalResource(SecureEndpointRegistry secureEndpointRegistry) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	checkAgencies(InputStream document) check agencies
javax.ws.rs.core.Response	checkDocument(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) Checks a traceability operation
javax.ws.rs.core.Response	checkRules(InputStream document) checkRules
javax.ws.rs.core.Response	createArchiveUnitProfiles(InputStream document) Import archive unit profiles
javax.ws.rs.core.Response	createArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of archive unit profiles
javax.ws.rs.core.Response	createProfiles(InputStream document) Import a profiles document
javax.ws.rs.core.Response	createProfiles(com.fasterxml.jackson.databind.JsonNode select) Import a set of profiles
javax.ws.rs.core.Response	downloadAgenciesCsvAsStream(String opId)
javax.ws.rs.core.Response	downloadDistributionReportAsStream(String opId)
javax.ws.rs.core.Response	downloadProfileFile(String fileId) Download the profile file The caller is responsible to close the Response after consuming the inputStream.
javax.ws.rs.core.Response	downloadRulesCsvAsStream(String opId)
javax.ws.rs.core.Response	downloadRulesReportAsStream(String opId) Download report stored by Administration operation (currently administration reports )
javax.ws.rs.core.Response	downloadTraceabilityFile(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(String documentId) findAccessContractsByID
javax.ws.rs.core.Response	findAccessionRegisterDetail(String documentId, 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(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(String documentId) find archive unit profiles by id
javax.ws.rs.core.Response	findContextById(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(String documentId) findFormatByID
javax.ws.rs.core.Response	findIngestContracts(com.fasterxml.jackson.databind.JsonNode select) findIngestContracts using get method
javax.ws.rs.core.Response	findIngestContractsByID(String documentId) findIngestContractsByID
javax.ws.rs.core.Response	findOntologies(com.fasterxml.jackson.databind.JsonNode select) find ontologies using get method
javax.ws.rs.core.Response	findOntologiesByID(String documentId) find an ontology by id
javax.ws.rs.core.Response	findProfiles(com.fasterxml.jackson.databind.JsonNode select) findProfiles using get method
javax.ws.rs.core.Response	findProfilesByID(String documentId) findProfilesByID
javax.ws.rs.core.Response	findRuleByID(String documentId) findRuleByID
javax.ws.rs.core.Response	findSecurityProfileByIdentifier(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	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(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(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, 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, InputStream document) Import a format
javax.ws.rs.core.Response	importIngestContracts(com.fasterxml.jackson.databind.JsonNode select) Import a set of ingest 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	importProfileFile(javax.ws.rs.core.UriInfo uriInfo, String profileMetadataId, InputStream profileFile) Import a Profile file document (xsd or rng, ...)
javax.ws.rs.core.Response	importRulesFile(javax.ws.rs.core.HttpHeaders headers, 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(String id) Interrupt the process of an operation identified by Id.
javax.ws.rs.core.Response	launchAudit(com.fasterxml.jackson.databind.JsonNode options) launch Audit
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(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(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update access contract
javax.ws.rs.core.Response	updateArchiveUnitProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update archive unit profile
javax.ws.rs.core.Response	updateContext(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update context
javax.ws.rs.core.Response	updateIngestContract(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update ingest contract
javax.ws.rs.core.Response	updateProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update profile
javax.ws.rs.core.Response	updateSecurityProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Update a security profile
javax.ws.rs.core.Response	updateWorkFlowStatus(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

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminManagementExternalResource

public AdminManagementExternalResource(SecureEndpointRegistry secureEndpointRegistry)

Constructor

Parameters:

secureEndpointRegistry - endpoint list registry

Method Detail

listResourceEndpoints

@Path(value="/")
 @OPTIONS
 @Produces(value="application/json")
public javax.ws.rs.core.Response listResourceEndpoints()

List secured resource end points

checkDocument

@Path(value="/formatsfilecheck")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response checkDocument(InputStream document)

checkFormat

Parameters:

document - the document to check

Returns:

Response

checkRules

@Path(value="/rulesfilecheck")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response checkRules(InputStream document)

checkRules

Parameters:

document - the document to check

Returns:

Response

checkAgencies

@Path(value="/agenciesfilecheck")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response checkAgencies(InputStream document)

check agencies

Parameters:

document -

Returns:

importFormat

@Path(value="/formats")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="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 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(value="/rules")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="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 headers

document - inputStream representing the data to import

Returns:

The jaxRs Response

importIngestContracts

@Path(value="/ingestcontracts")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/accesscontracts")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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

importContexts

@Path(value="/contexts")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/profiles")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="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(value="/profiles")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/archiveunitprofiles")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="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(value="/archiveunitprofiles")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/profiles/{id:.+}")
 @PUT
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importProfileFile(@Context
                                                                                                                                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                                            @PathParam(value="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 response

profileMetadataId - id of the profile metadata

profileFile - inputStream representing the data to import

Returns:

The jaxRs Response

downloadProfileFile

@GET
 @Path(value="/profiles/{id:.+}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadProfileFile(@PathParam(value="id")
                                                                                                                                         String fileId)

Download the profile file

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

fileId -

downloadTraceabilityFile

@GET
 @Path(value="/traceability/{id}/datafiles")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadTraceabilityFile(@PathParam(value="id")
                                                                                                                                                         String fileId)

Download the traceability file

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

fileId -

getFormats

@Path(value="/formats")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/rules")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/ingestcontracts")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/accesscontracts")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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

findProfiles

@Path(value="/profiles")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/archiveunitprofiles")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/contexts")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/agencies")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="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 headers

document - inputStream representing the data to import

Returns:

The jaxRs Response

Throws:

InvalidParseOperationException

findAgencyByID

@Path(value="/agencies/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAgencyByID(@PathParam(value="id_document")
                                                                                                                                     String documentId)

findRuleByID

Parameters:

documentId - the document id to find

Returns:

Response

findAgencies

@Path(value="/agencies")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/accessionregisters")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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

getAccessionRegisterSymbolic

@GET
 @Path(value="accessionregisterssymbolic")
 @Consumes(value="application/json")
 @Produces(value="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(value="/formats/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findFormatByID(@PathParam(value="id_document")
                                                                                                                                    String documentId)

findFormatByID

Parameters:

documentId - the document id to find

Returns:

Response

findRuleByID

@Path(value="/rules/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findRuleByID(@PathParam(value="id_document")
                                                                                                                                String documentId)

findRuleByID

Parameters:

documentId - the document id to find

Returns:

Response

findIngestContractsByID

@Path(value="/ingestcontracts/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findIngestContractsByID(@PathParam(value="id_document")
                                                                                                                                                     String documentId)

findIngestContractsByID

Parameters:

documentId - the document id to find

Returns:

Response

findAccessContractsByID

@Path(value="/accesscontracts/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAccessContractsByID(@PathParam(value="id_document")
                                                                                                                                                     String documentId)

findAccessContractsByID

Parameters:

documentId - the document id to find

Returns:

Response

findProfilesByID

@Path(value="/profiles/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findProfilesByID(@PathParam(value="id_document")
                                                                                                                                       String documentId)

findProfilesByID

Parameters:

documentId - the document id to find

Returns:

Response

findArchiveUnitProfilesByID

@Path(value="/archiveunitprofiles/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findArchiveUnitProfilesByID(@PathParam(value="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(value="/contexts/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findContextById(@PathParam(value="id_document")
                                                                                                                                      String documentId)

findContextById

Parameters:

documentId - the document id to find

Returns:

Response

updateContext

@Path(value="/contexts/{identifier:.+}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateContext(@PathParam(value="identifier")
                                                                                                                                                                        String identifier,
                                                                                                                                                                        com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                 throws AdminManagementClientServerException,
                                                                                                                                                                        InvalidParseOperationException

Update context

Parameters:

identifier -

queryDsl -

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

updateProfile

@Path(value="/profiles/{identifier:.+}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateProfile(@PathParam(value="identifier")
                                                                                                                                                                        String identifier,
                                                                                                                                                                        com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                 throws AdminManagementClientServerException,
                                                                                                                                                                        InvalidParseOperationException

Update profile

Parameters:

identifier -

queryDsl -

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

updateArchiveUnitProfile

@Path(value="/archiveunitprofiles/{identifier:.+}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateArchiveUnitProfile(@PathParam(value="identifier")
                                                                                                                                                                                              String identifier,
                                                                                                                                                                                              com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                                       throws AdminManagementClientServerException

Update archive unit profile

Parameters:

identifier -

queryDsl -

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

updateAccessContract

@Path(value="/accesscontracts/{identifier:.+}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateAccessContract(@PathParam(value="identifier")
                                                                                                                                                                                      String identifier,
                                                                                                                                                                                      com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                               throws AdminManagementClientServerException,
                                                                                                                                                                                      InvalidParseOperationException

Update access contract

Parameters:

identifier -

queryDsl -

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

updateIngestContract

@Path(value="/ingestcontracts/{identifier:.+}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateIngestContract(@PathParam(value="identifier")
                                                                                                                                                                                      String identifier,
                                                                                                                                                                                      com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                               throws AdminManagementClientServerException,
                                                                                                                                                                                      InvalidParseOperationException

Update ingest contract

Parameters:

identifier -

queryDsl -

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

findAccessionRegisterDetail

@GET
 @Path(value="/accessionregisters/{id_document}/accessionregisterdetails")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAccessionRegisterDetail(@PathParam(value="id_document")
                                                                                                                                                                                                                       String documentId,
                                                                                                                                                                                                                       com.fasterxml.jackson.databind.JsonNode select)

findAccessionRegisterDetail

Parameters:

documentId - the document id of accession register to get

select - the query to get document

Returns:

Response

checkOperationTraceability

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

Checks a traceability operation

Parameters:

query - the DSLQuery used to find the traceability operation to validate

Returns:

The verification report == the logbookOperation

launchAudit

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

launch Audit

Parameters:

options -

Returns:

response

importSecurityProfiles

@Path(value="/securityprofiles")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/probativevalueexport")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response exportProbativeValue(ProbativeValueRequest probativeValueRequest)

launch probative value request

Parameters:

probativeValueRequest - the request

Returns:

Response

findSecurityProfiles

@Path(value="/securityprofiles")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/securityprofiles/{identifier}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findSecurityProfileByIdentifier(@PathParam(value="identifier")
                                                                                                                                                          String identifier)

Find security profile by identifier

Parameters:

identifier - the identifier of the security profile to find

Returns:

Response

updateSecurityProfile

@Path(value="/securityprofiles/{identifier}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateSecurityProfile(@PathParam(value="identifier")
                                                                                                                                                                                     String identifier,
                                                                                                                                                                                     com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                                              throws AdminManagementClientServerException,
                                                                                                                                                                                     InvalidParseOperationException

Update a security profile

Parameters:

identifier - the identifier of the security profile to update

queryDsl - query to execute

Returns:

Response

Throws:

AdminManagementClientServerException

InvalidParseOperationException

listOperationsDetails

@GET
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="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(value="operations/{id}")
 @HEAD
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWorkFlowExecutionStatus(@PathParam(value="id")
                                                                                                                                       String id)

Parameters:

id - operation identifier

Returns:

http response

getOperationProcessExecutionDetails

@Path(value="operations/{id}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOperationProcessExecutionDetails(@PathParam(value="id")
                                                                                                                                               String id)

get the workflow status

Parameters:

id - operation identifier

Returns:

http response

updateWorkFlowStatus

@Path(value="operations/{id}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateWorkFlowStatus(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="id")
                                                                                                                                                                     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(value="operations/{id}")
 @DELETE
 @Produces(value="application/json")
public javax.ws.rs.core.Response interruptWorkFlowExecution(@PathParam(value="id")
                                                                                                                                         String id)

Interrupt the process of an operation identified by Id.

Parameters:

id - operation identifier

Returns:

http response

getWorkflowDefinitions

@GET
 @Path(value="/workflows")
 @Produces(value="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(value="/rulesreport/{opId}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadRulesReportAsStream(@PathParam(value="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

downloadDistributionReportAsStream

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

downloadAgenciesCsvAsStream

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

downloadRulesCsvAsStream

@GET
 @Path(value="/agenciesreferential/{opId}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadRulesCsvAsStream(@PathParam(value="opId")
                                                                                                                                                        String opId)

checkEvidenceAudit

@Path(value="/evidenceaudit")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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 response

rectificationAudit

@Path(value="/rectificationaudit")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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 response

importOntologies

@Path(value="/ontologies")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response importOntologies(@HeaderParam(value="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(value="/ontologies")
 @GET
 @Consumes(value="application/json")
 @Produces(value="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(value="/ontologies/{id_document:.+}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findOntologiesByID(@PathParam(value="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(value="/forcepause")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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(value="/removeforcepause")
 @POST
 @Consumes(value="application/json")
 @Produces(value="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: