Skip to main content
Version: 1.13.0

Launch process batches and monitor executions

Version: 1.0.0

License:

/processplugins/config

GET

Parameters
NameLocated inDescriptionRequiredSchema
processNameLikequeryNostring
Responses
CodeDescription
200default response
500default response

POST

Responses
CodeDescription
200default response
500default response

/processplugins/config/{processBusinessId}

GET

Parameters
NameLocated inDescriptionRequiredSchema
processBusinessIdpathYesstring (uuid)
Responses
CodeDescription
200default response
500default response

PUT

Parameters
NameLocated inDescriptionRequiredSchema
processBusinessIdpathYesstring (uuid)
Responses
CodeDescription
200default response
500default response

DELETE

Parameters
NameLocated inDescriptionRequiredSchema
processBusinessIdpathYesstring (uuid)
Responses
CodeDescription
200default response
500default response

/processplugins/config/{processBusinessId}/userRole

PUT

Parameters
NameLocated inDescriptionRequiredSchema
processBusinessIdpathYesstring (uuid)
userRolequeryYesstring
Responses
CodeDescription
200default response
500default response

/processplugins/fordatasets

POST

Responses
CodeDescription
200default response
500default response

/processplugins/linkprocessdataset/{datasetIpId}

GET

Parameters
NameLocated inDescriptionRequiredSchema
datasetIpIdpathYesstring
Responses
CodeDescription
200default response
500default response

PUT

Parameters
NameLocated inDescriptionRequiredSchema
datasetIpIdpathYesstring
Responses
CodeDescription
200default response
500default response

/processplugins/metadata

GET

Responses
CodeDescription
200default response
500default response

/monitoring/executions

GET

Parameters
NameLocated inDescriptionRequiredSchema
tenantqueryYesstring
statusqueryYes[ string ]
userEmailqueryNostring
processBusinessIdqueryNostring
fromqueryNostring
toqueryNostring
pagequeryNointeger
sizequeryNointeger
assemblerqueryYesobject
Responses
CodeDescription
200default response
500default response

/batch

POST

Responses
CodeDescription
200default response
500default response

/process

GET

Responses
CodeDescription
200default response
500default response

/process/{processBusinessId}

GET

Parameters
NameLocated inDescriptionRequiredSchema
processBusinessIdpathYesstring (uuid)
Responses
CodeDescription
200default response
500default response

Models

ErrorStructure

NameTypeDescriptionRequired
errorIdstring (uuid)No
messagestringNo
timedateTimeISO formatted UTC date-time
Example: "2020-12-31T00:00:00Z"
No

EntityModelProcessPluginConfigurationRightsDTO

NameTypeDescriptionRequired
pluginConfigurationobjectNo
rightsobjectNo
links[ object ]No

IPluginParam

NameTypeDescriptionRequired
dynamicbooleanNo
namestringNo
valueobjectNo
typestringEnum: "STRING", "BYTE", "SHORT", "INTEGER", "LONG", "FLOAT", "DOUBLE", "BOOLEAN", "MAP", "COLLECTION", "POJO", "PLUGIN"No
NameTypeDescriptionRequired
relstringNo
hrefstringNo
hreflangstringNo
mediastringNo
titlestringNo
typestringNo
deprecationstringNo
profilestringNo
namestringNo

PluginConfiguration

NameTypeDescriptionRequired
idlongNo
metaDataobjectNo
pluginIdstringNo
labelstringYes
businessIdstringNo
versionstringNo
priorityOrderintegerYes
activebooleanNo
parameters[ object ]No
iconUrlstring (url)No
interfaceNames[ string ]No
isActivebooleanNo
pluginClassNamestringNo
identifiablebooleanNo

PluginMetaData

NameTypeDescriptionRequired
pluginClassNamestringNo
interfaceNames[ string ]No
authorstringNo
pluginIdstringNo
versionstringNo
descriptionstringNo
markdownstringNo
urlstringNo
contactstringNo
ownerstringNo
licensestringNo
parameters[ object ]No
licencestringNo

PluginParamDescriptor

NameTypeDescriptionRequired
namestringNo
keyLabelstringNo
labelstringNo
descriptionstringNo
markdownstringNo
parameterizedSubTypes[ string ]No
typestringEnum: "STRING", "BYTE", "SHORT", "INTEGER", "LONG", "FLOAT", "DOUBLE", "BOOLEAN", "MAP", "COLLECTION", "POJO", "PLUGIN"No
pluginTypestringNo
defaultValuestringNo
optionalbooleanNo
sensitivebooleanNo
unconfigurablebooleanNo
sensiblebooleanNo

ProcessPluginConfigurationRightsDTO

NameTypeDescriptionRequired
pluginConfigurationobjectNo
rightsobjectNo

Rights

NameTypeDescriptionRequired
rolestringNo
datasets[ object ]No
linkedToAllDatasetsbooleanNo

ProcessLabelDTO

NameTypeDescriptionRequired
processBusinessIdstring (uuid)No
labelstringNo

PagedResourcesAssemblerExecutionMonitoringDTO

NameTypeDescriptionRequired
forceFirstAndLastRelsbooleanNo

EntityModelExecutionMonitoringDTO

NameTypeDescriptionRequired
idstring (uuid)No
executionCorrelationIdstringNo
batchIdstring (uuid)No
batchCorrelationIdstringNo
expectedDurationnumberDuration in nanosecondsNo
inputFiles[ object ]No
steps[ object ]No
tenantstringNo
userNamestringNo
processBusinessIdstring (uuid)No
createddateTimeISO formatted UTC date-time
Example: "2020-12-31T00:00:00Z"
No
lastUpdateddateTimeISO formatted UTC date-time
Example: "2020-12-31T00:00:00Z"
No
versionintegerNo
persistedbooleanNo
processNamestringNo
links[ object ]No

PageMetadata

NameTypeDescriptionRequired
sizelongNo
totalElementslongNo
totalPageslongNo
numberlongNo

PagedModelEntityModelExecutionMonitoringDTO

NameTypeDescriptionRequired
links[ object ]No
content[ object ]No
pageobjectNo

PBatchRequest

NameTypeDescriptionRequired
correlationIdstringNo
processBusinessIdstring (uuid)No
tenantstringNo
userstringNo
userRolestringNo
parametersobjectNo
filesetsByDatasetobjectNo

PBatchResponse

NameTypeDescriptionRequired
batchIdstring (uuid)No
correlationIdstringNo

PProcessDTO

NameTypeDescriptionRequired
processIdstring (uuid)No
processNamestringNo
activebooleanNo
processInfoobjectNo
params[ object ]No

GenericResponseBody

NameTypeDescriptionRequired
messagestringNo
propertiesobjectNo

EntityModelMapStringMaintenanceInfo

NameTypeDescriptionRequired
links[ object ]No

ModuleImportReport

NameTypeDescriptionRequired
moduleInformationobjectNo
importErrors[ string ]No
onlyErrorsbooleanNo

ModuleInformation

NameTypeDescriptionRequired
idstringYes
namestringYes
descriptionstringNo
versionstringYes
authorstringYes
legalOwnerstringNo
documentationstringNo

ModuleRestartReport

NameTypeDescriptionRequired
moduleInformationobjectNo
messages[ string ]No

ModuleReadinessReportObject

NameTypeDescriptionRequired
readybooleanNo
reasons[ string ]No
specificationsobjectNo

EntityModelPluginConfiguration

NameTypeDescriptionRequired
idlongNo
metaDataobjectNo
pluginIdstringNo
labelstringNo
businessIdstringNo
versionstringNo
priorityOrderintegerNo
activebooleanNo
parameters[ object ]No
iconUrlstring (url)No
interfaceNames[ string ]No
isActivebooleanNo
pluginClassNamestringNo
identifiablebooleanNo
links[ object ]No

EntityModelPluginMetaData

NameTypeDescriptionRequired
pluginClassNamestringNo
interfaceNames[ string ]No
authorstringNo
pluginIdstringNo
versionstringNo
descriptionstringNo
markdownstringNo
urlstringNo
contactstringNo
ownerstringNo
licensestringNo
parameters[ object ]No
licencestringNo
links[ object ]No

EntityModelString

NameTypeDescriptionRequired
contentstringNo
links[ object ]No

ResourceAccess

NameTypeDescriptionRequired
ResourceAccessobject

ResourceMapping

NameTypeDescriptionRequired
resourceAccessobjectNo
fullPathstringNo
controllerSimpleNamestringNo
methodstringEnum: "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"No
autorizedRoles[ object ]No
resourceMappingIdstringNo

RoleAuthority

NameTypeDescriptionRequired
authorizedIpAdresses[ string ]No
roleNamestringNo
authoritystringNo