Overview
Tags
-
Git : Manage git repositories
-
FunctionRs
-
OntologyRs
-
FilesRs
-
CacheRs
-
CommunicationRs
-
EmailTemplateRs
-
MeveoInstanceRs
-
MavenConfigurationRs
-
CustomEntityCategoryRs
-
CustomEntityInstanceRs
-
CustomFieldTemplateRs
-
CustomRelationshipTemplateRs
-
Custom table
-
EntityCustomizationRs
-
Graph query
-
Neo4j persistence
-
ChartRs
-
MeasurableQuantityRs
-
FilteredListRs
-
ReportExtractRs
-
GitRepositoryRs
-
UserHierarchyLevelRs
-
CalendarRs
-
CountryIsoRs
-
CountryRs
-
CurrencyIsoRs
-
CurrencyRs
-
FilterRs
-
LanguageIsoRs
-
LanguageRs
-
MailerConfigurationRs
-
PermissionRs
-
ProviderRs
-
RoleRs
-
ScriptInstanceRs
-
UserRs
-
ImportExportRs
-
JobInstanceRs
-
JobRs
-
TimerEntityRs
-
ModulePatchesRs
-
ModuleRs
-
Neo4jConfigurationRs
-
JobTriggerRs
-
NotificationRs
-
WebHookNotificationRs
-
PersistenceRs
-
SqlConfigurationRs
-
BinaryStorageConfigurationRs
-
FileSystemRs
-
Repository
-
EndpointRs
-
WorkflowRs
Resources
FunctionRs
Get samples function by code
GET /function/sample/code/{code}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
< Sample > array |
GET /function
Test function
POST /function/{code}/test
OntologyRs
FilesRs
Upload file
POST /admin/files/upload
Create directory from where to list files
POST /admin/files/createDir
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
Directory from where to list files |
string |
Zip directory
POST /admin/files/zipDirectory
Rename folder
PUT /admin/files/renameFolder
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
FormData |
oldFolder |
Old folder |
string |
FormData |
newFolder |
New folder |
string |
Download file
GET /admin/files/downloadFile
Suppress directory
POST /admin/files/suppressDirectory
Suppress file
POST /admin/files/suppressFile
List directory from where to list files
GET /admin/files
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
dir |
Directory from where to list files |
string |
CacheRs
CommunicationRs
EmailTemplateRs
Create new or update an existing email template
POST /communication/emailTemplate/createOrUpdate
Remove an email template
DELETE /communication/emailTemplate/{code}
Find an email template
GET /communication/emailTemplate
Update email template information
PUT /communication/emailTemplate
Create an email template
POST /communication/emailTemplate
MeveoInstanceRs
Create or update meveo instance information
POST /communication/meveoInstance/createOrUpdate
PUT /communication/meveoInstance/{code}/syncRepositories
Remove meveo instance information
DELETE /communication/meveoInstance/{code}
Find meveo instance information
GET /communication/meveoInstance
Update meveo instance information
PUT /communication/meveoInstance
Create meveo instance information
POST /communication/meveoInstance
MavenConfigurationRs
List of remote repositories
GET /mavenConfiguration/remoteRepository
Create or update remote repository
POST /mavenConfiguration/remoteRepository
Get maven configuration
GET /mavenConfiguration
Create or update maven configuration
POST /mavenConfiguration
Upload a new artifact
POST /mavenConfiguration/upload
CustomEntityCategoryRs
Create or update custom entity category information
POST /customEntityCategory/entity/createOrUpdate
Remove custom entity category information by code
DELETE /customEntityCategory/entity/{customEntityCategoryCode}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
customEntityCategoryCode |
Code of the custom entity category |
string |
|
Query |
deleteRelatedTemplates |
Whether to delete the related templates |
boolean |
|
Update custom entity category information
PUT /customEntityCategory/entity
Create a new custom entity category
POST /customEntityCategory/entity
Find custom entity category information
GET /customEntityCategory/entity/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the custom entity category |
string |
CustomEntityInstanceRs
Create or update code of the custom entity template
POST /customEntityInstance/{customEntityTemplateCode}/createOrUpdate
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Body |
body |
Custom entity instance information |
Find custom entity template by code
GET /customEntityInstance/{customEntityTemplateCode}/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Path |
code |
Code of the custom entity instance |
string |
Delete custom entity template by code
DELETE /customEntityInstance/{customEntityTemplateCode}/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Path |
code |
Code of the custom entity instance |
string |
Update code of the custom entity template
PUT /customEntityInstance/{customEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Body |
body |
Custom entity instance information |
Create code of the custom entity template
POST /customEntityInstance/{customEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Body |
body |
Custom entity instance information |
CustomFieldTemplateRs
Create or update custom field template information
POST /customFieldTemplate/createOrUpdate
Remove custom field template information
DELETE /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customFieldTemplateCode |
Code of the custom field template |
string |
Path |
appliesTo |
applies to |
string |
Find custom field template information
GET /customFieldTemplate
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
customFieldTemplateCode |
Code of the custom field template |
string |
Query |
appliesTo |
applies to |
string |
Update existing custom field definition
PUT /customFieldTemplate
CustomRelationshipTemplateRs
Find custom relationship template information
GET /customRelationshipTemplate/relationship/{customCustomRelationshipTemplateCode}/{startCustomEntityTemplateCode}/{endCustomEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customCustomRelationshipTemplateCode |
Code of the custom relationship template |
string |
Remove custom relationship template information
DELETE /customRelationshipTemplate/relationship/{customCustomRelationshipTemplateCode}/{startCustomEntityTemplateCode}/{endCustomEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customCustomRelationshipTemplateCode |
Code of the custom relationship template |
string |
Create or update custom relationship template information
POST /customRelationshipTemplate/crt/createOrUpdate
List custom relationship template information
GET /customRelationshipTemplate/relationship/list
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
customCustomRelationshipTemplateCode |
Code of the custom relationship template |
string |
Update custom relationship template information
PUT /customRelationshipTemplate/relationship
Custom Table
List of custom table
POST /customTable/list/{customTableCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customTableCode |
Code of the custom table |
string |
Body |
body |
Paging and search criteria |
EntityCustomizationRs
Find entity custom action information
GET /entityCustomization/action
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
actionCode |
Code of the entity action |
string |
Query |
appliesTo |
Entity that action applies to |
string |
Update entity custom action information
PUT /entityCustomization/action
Create entity custom action information
POST /entityCustomization/action
Find custom field template information
GET /entityCustomization/field
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
customFieldTemplateCode |
Code of the custom field template |
string |
Query |
appliesTo |
Entity custom field applies to |
string |
Update custom field template information
PUT /entityCustomization/field
Create custom field template information
POST /entityCustomization/field
Find custom entity template information
GET /entityCustomization/entity/{customEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Remove custom entity template information
DELETE /entityCustomization/entity/{customEntityTemplateCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customEntityTemplateCode |
Code of the custom entity template |
string |
Update custom entity template information
PUT /entityCustomization/entity
Create custom entity template information
POST /entityCustomization/entity
List custom field template applies to the type of entity
GET /entityCustomization/entity/listELFiltered
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
appliesTo |
The custom field template applies to the type of entity |
string |
Query |
entityCode |
Code of the entity |
string |
Information of entity customization
PUT /entityCustomization/customize
Find entity customized information
GET /entityCustomization/customize/{customizedEntityClass}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customizedEntityClass |
Standard meveo entity class name |
string |
List custom field template by code
GET /entityCustomization/listBusinessEntityForCFVByCode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
code |
Code of the custom field template |
string |
Query |
wildcode |
Code filter |
string |
Remove custom field template information
DELETE /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
customFieldTemplateCode |
Code of the custom field template |
string |
Path |
appliesTo |
Entity custom field applies to |
string |
Create or update custom entity template information
POST /entityCustomization/cet/createOrUpdate
List custom entity template information
GET /entityCustomization/entity/list
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
customEntityTemplateCode |
Code of the custom entity template |
string |
Create or update custom field template information
POST /entityCustomization/field/createOrUpdate
Delete entity custom action information
DELETE /entityCustomization/action/{actionCode}/{appliesTo}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
actionCode |
Code of the entity action |
string |
Path |
appliesTo |
Entity that action applies to |
string |
Create or update entity custom action information
POST /entityCustomization/action/createOrUpdate
Create customized entity template information
POST /entityCustomization/entity/createOrUpdate
Execute
POST /entityCustomization/entity/action/execute/{actionCode}/{appliesTo}/{entityCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
actionCode |
Code of the action |
string |
Path |
appliesTo |
The action applies to the entity |
string |
Path |
entityCode |
Code of the entity |
string |
Graph Query
Execute query of graphql in get
GET /graphql/{neo4jConfiguration}
Execute query of graphql in post
POST /graphql/{neo4jConfiguration}
Neo4j Persistence
Persist entity data to be persisted
POST /neo4j/persist/entities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
neo4jConfiguration |
string |
|
Body |
body |
Data to be persisted |
< PersistenceDto > array |
Delete data to be persisted
DELETE /neo4j/persist
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
neo4jConfiguration |
string |
|
Body |
body |
Data to be persisted |
< PersistenceDto > array |
ChartRs
Create or update char
POST /chart/createOrUpdate
Update an existing bar chart
PUT /chart/bar
Create a new bar chart
POST /chart/bar
Update an existing pie chart
PUT /chart/pie
Create pie chart
POST /chart/pie
Update an existing line chart
PUT /chart/line
Create line chart
POST /chart/line
Update an existing chart
PUT /chart
Create chart information
POST /chart
MeasurableQuantityRs
Find measurable quantity by date and period
GET /measurableQuantity/findMVByDateAndPeriod
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
code |
Code of mesurable value |
string |
Query |
fromDate |
From date |
string (date-time) |
Query |
toDate |
To date |
string (date-time) |
Query |
period |
Period in which mesurable value is calculated |
enum (DAILY, WEEKLY, MONTHLY, YEARLY) |
Query |
mqCode |
Code of the measureable quantity |
string |
Remove measurable quantity by code
DELETE /measurableQuantity/{code}
Find measurable quantity by code
GET /measurableQuantity
Update measurable quantity
PUT /measurableQuantity
Create measurable quantity
POST /measurableQuantity
FilteredListRs
List filter
POST /filteredList/listByFilter
Search filter
GET /filteredList/fullSearch
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
query |
Query |
string |
Query |
category |
Search by category |
string |
Query |
from |
Starting record |
integer (int32) |
Query |
size |
Number of records per page |
integer (int32) |
Query |
sortField |
Sort the results of field |
string |
Query |
sortOrder |
Sort ASC or DESC order of the results |
enum (ASC, DESC) |
Search filter by field
GET /filteredList/searchByField
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
classnamesOrCetCodes |
Entity classes to match |
< string > array(multi) |
Query |
from |
Starting record |
integer (int32) |
Query |
size |
Number of records per page |
integer (int32) |
Query |
sortField |
Sort the results of field |
string |
Query |
sortOrder |
Sort ASC or DESC order of the results |
enum (ASC, DESC) |
Search filter by classnames or cet code
GET /filteredList/search
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
classnamesOrCetCodes |
Entity classes to match |
< string > array(multi) |
Query |
query |
Query |
string |
Query |
from |
Starting record |
integer (int32) |
Query |
size |
Number of records per page |
integer (int32) |
Query |
sortField |
Sort the results of field |
string |
Query |
sortOrder |
Sort ASC or DESC order of the results |
enum (ASC, DESC) |
ReportExtractRs
Create or update report extract
POST /finance/reportExtracts/createOrUpdate
Run report extract
POST /finance/reportExtracts/run
Find report extract by code
GET /finance/reportExtracts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
reportExtractCode |
Code of the report extract |
string |
Create report extract
POST /finance/reportExtracts
Remove report extract by code
DELETE /finance/reportExtracts
GitRepositoryRs
List all existing repositories
GET /git/repositories
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
< GitRepositoryDto > array |
Create a new repository
POST /git/repositories
Pull changes from remote origin
POST /git/repositories/{code}/pull
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the repository |
string |
FormData |
username |
Username to use during pull |
string |
FormData |
password |
Password to use during pull |
string |
Create a branch
POST /git/repositories/{code}/branches/{branch}
Delete a branch
DELETE /git/repositories/{code}/branches/{branch}
Checkout a branch
POST /git/repositories/{code}/branches/{branch}/checkout
Retrieve one repository by code
GET /git/repositories/{code}
Upload a repository
PUT /git/repositories/{code}
Update an existing repository
POST /git/repositories/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
Repository information |
|
Path |
code |
Code of the repository |
string |
Commit content of a repository
POST /git/repositories/{code}/commit
Push the commit to remote origin
POST /git/repositories/{code}/push
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the repository |
string |
FormData |
username |
Username to use during push |
string |
FormData |
password |
Password to use during push |
string |
Merge one branch into another
POST /git/repositories/{code}/branches/merge
UserHierarchyLevelRs
Create or update user hierarchy level
POST /hierarchy/userGroupLevel/createOrUpdate
List get user hierarchy level
GET /hierarchy/userGroupLevel/list
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
query |
Query to search criteria |
string |
|
Query |
fields |
Data retrieval options/fieldnames |
string |
|
Query |
offset |
Offset from record number |
integer (int32) |
|
Query |
limit |
Number of records to retrieve |
integer (int32) |
|
Query |
sortBy |
Sort by a field |
string |
|
Query |
sortOrder |
Sort order |
enum (ASCENDING, DESCENDING) |
|
List post user hierarchy level
POST /hierarchy/userGroupLevel/list
Remove user hierarchy level by code
DELETE /hierarchy/userGroupLevel/{hierarchyLevelCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
hierarchyLevelCode |
Code of the user hierarchy level |
string |
Find user hierarchy level by code
GET /hierarchy/userGroupLevel
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
hierarchyLevelCode |
Code of the user hierarchy level |
string |
Update user hierarchy level
PUT /hierarchy/userGroupLevel
CalendarRs
Create or update calendar information
POST /calendar/createOrUpdate
Remove calendar information
DELETE /calendar/{calendarCode}
Find calendar information
GET /calendar
Update calendar information
PUT /calendar
Create calendar information
POST /calendar
CountryIsoRs
Create or update country iso information
POST /countryIso/createOrUpdate
Remove country iso information
DELETE /countryIso/{countryCode}
Find country iso information
GET /countryIso
Update country iso information
PUT /countryIso
Create country iso information
POST /countryIso
CountryRs
Create or update country information
POST /country/createOrUpdate
Remove country information
DELETE /country/{countryCode}/{currencyCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
countryCode |
Code of the country |
string |
Path |
currencyCode |
Code of the currency |
string |
Find country information
GET /country
Update country information
PUT /country
CurrencyIsoRs
Create or update currency iso information
POST /currencyIso/createOrUpdate
Remove currency iso information
DELETE /currencyIso/{currencyCode}
List all currencies
GET /currencyIso
Update currency iso information
PUT /currencyIso
CurrencyRs
Create or update currency information
POST /currency/createOrUpdate
Remove currency information
DELETE /currency/{currencyCode}
Find currency information
GET /currency
Update currency information
PUT /currency
FilterRs
Create or update filter
POST /filter/createOrUpdate
LanguageIsoRs
Create or update language iso
POST /languageIso/createOrUpdate
Remove language iso by code
DELETE /languageIso/{languageCode}
Update language iso
PUT /languageIso
LanguageRs
Create or update language
POST /language/createOrUpdate
Remove language by code
DELETE /language/{languageCode}
Update language
PUT /language
MailerConfigurationRs
PermissionRs
Add to white list information
PUT /permission/whitelist
Remove from white list by permission and id and role
DELETE /permission/whitelist
Add to black list information
PUT /permission/blacklist
Remove from black list by permission and id and role
DELETE /permission/blacklist
ProviderRs
Create or update provider
POST /provider/createOrUpdate
Remove tenant provider by code
DELETE /provider/{providerCode}
Update provider cf
PUT /provider/updateProviderCF
Find provider cf by code
GET /provider/findProviderCF
Create tenant provider
POST /provider/createTenant
List tenants
GET /provider/listTenants
Update provider
PUT /provider
RoleRs
Create or update role
POST /role/createOrUpdate
List external roles
GET /role/external
List get role
GET /role/list
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
query |
Query to search criteria |
string |
|
Query |
fields |
Data retrieval options/fieldnames |
string |
|
Query |
offset |
Offset from record number |
integer (int32) |
|
Query |
limit |
Number of records to retrieve |
integer (int32) |
|
Query |
sortBy |
Sort by a field |
string |
|
Query |
sortOrder |
Sort order |
enum (ASCENDING, DESCENDING) |
|
List post role
POST /role/list
Remove role by roleName
DELETE /role/{roleName}/{provider}
Update role
PUT /role
ScriptInstanceRs
Create or update script instance
POST /scriptInstance/createOrUpdate
Remove script instance by code
DELETE /scriptInstance/{scriptInstanceCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
scriptInstanceCode |
Code of the script instance |
string |
Find script instance by code
GET /scriptInstance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
scriptInstanceCode |
Code of the script instance |
string |
Update script instance
PUT /scriptInstance
UserRs
Create or update user
POST /user/createOrUpdate
Update external user
PUT /user/external
Create external user
POST /user/external
Remove external user by username
DELETE /user/external/{username}
Generate SH key by username
POST /user/ssh/generate
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
username |
Username to connect |
string |
Body |
body |
Pass phrase |
string |
List get user
GET /user/list
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
query |
Query to search criteria |
string |
|
Query |
fields |
Data retrieval options/fieldnames |
string |
|
Query |
offset |
Offset from record number |
integer (int32) |
|
Query |
limit |
Number of records to retrieve |
integer (int32) |
|
Query |
sortBy |
Sort by a field |
string |
|
Query |
sortOrder |
Sort order |
enum (ASCENDING, DESCENDING) |
|
List post user
POST /user/list
Remove user by username
DELETE /user/{username}
Update user
PUT /user
ImportExportRs
Import data
POST /importExport/importData
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
File containing a list of object for import |
JobInstanceRs
Create or update job instance
POST /jobInstance/createOrUpdate
Remove job instance by code
DELETE /jobInstance/{jobInstanceCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobInstanceCode |
Code of the job instance |
string |
Update job instance
POST /jobInstance/update
Find job instance by code
GET /jobInstance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
jobInstanceCode |
Code of the job instance |
string |
JobRs
Create or update job
POST /job/createOrUpdate
Find job execution result by code
GET /job/jobReport
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
code |
Code of the job instance to match |
string |
Query |
id |
A job execution result id |
integer (int64) |
Find timer entity by code
GET /job/timer
Update timer entity
PUT /job/timer
Create timer entity
POST /job/timer
Create or update timer entity
POST /job/timer/createOrUpdate
Remove timer entity by code
DELETE /job/timer/{timerCode}
Remove job by code
DELETE /job/{jobInstanceCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
jobInstanceCode |
Code of the job instance |
string |
Find job by code
GET /job
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
jobInstanceCode |
Code of the job instance |
string |
Update job
PUT /job
Execute job
POST /job/execute
Create job
POST /job/create
TimerEntityRs
Create or update time entity
POST /timerEntity/createOrUpdate
Update time entity
POST /timerEntity/update
Find time entity by code
GET /timerEntity/{timerEntityCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
timerEntityCode |
Code of the timer entity |
string |
Create time entity
POST /timerEntity/create
GET /timerEntity
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
< TimerEntityDto > array |
ModulePatchesRs
GET /module/patches
ModuleRs
Create or update meveo module
POST /module/createOrUpdate
Import from a zip
POST /module/importZip
Add to module
POST /module/{code}/items/add
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the module to modify |
string |
FormData |
itemCode |
Code of the item to add |
string |
FormData |
itemType |
Type of the item to add |
string |
Remove from module
POST /module/{code}/items/remove
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the module to modify |
string |
FormData |
itemCode |
Code of the item to remove |
string |
FormData |
itemType |
Type of the item to remove |
string |
Add file to module
POST /module/{code}/file/add
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the module to modify |
string |
FormData |
path |
Path of file/folder to add |
string |
Remove from module
POST /module/{code}/file/remove
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the module to modify |
string |
FormData |
path |
Path of file/folder to remove |
string |
Fork meveo module by code
PUT /module/fork/{code}
release meveo module by code
POST /module/release/{code}/{nextVersion}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the module |
string |
Path |
nextVersion |
next version meveo module |
string |
Export to a file
GET /module/export
Instance meveo module
PUT /module/install
Uninstall meveo module
GET /module/uninstall
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
code |
Code of the meveo module |
string |
|
Query |
remove |
Whether to remove elements |
boolean |
|
Get meveo module by code
GET /module
Update meveo module
PUT /module
Create meveo module
POST /module
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Body |
body |
Meveo module information |
||
Query |
development |
Whether to development meveo module |
boolean |
|
Remove meveo module by code
DELETE /module/{code}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
code |
Code of the module |
string |
|
Query |
deleteFiles |
Delete the module files |
boolean |
|
List meveo module
GET /module/list
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
codesOnly |
Whether to codes only for list of modules |
boolean |
Query |
active |
Meveo module filters information |
boolean |
Query |
downloaded |
Meveo module filters information |
boolean |
Query |
itemCode |
Meveo module filters information |
string |
Query |
itemType |
Meveo module filters information |
string |
Enable meveo module
GET /module/enable
Neo4jConfigurationRs
Create or update neo4j configuration
POST /neo4j/configurations/createOrUpdate
Find neo4j configuration by code
GET /neo4j/configurations/{code}
Remove neo4j configuration by code
DELETE /neo4j/configurations/{code}
list of binary storages
GET /neo4j/configurations
Update neo4j configuration
PUT /neo4j/configurations
JobTriggerRs
Create or update job trigger
POST /notification/jobTrigger/createOrUpdate
Remove job trigger by code
DELETE /notification/jobTrigger/{notificationCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
notificationCode |
Code of the job trigger |
string |
Find job trigger by code
GET /notification/jobTrigger
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
notificationCode |
Code of the job trigger |
string |
Update job trigger
PUT /notification/jobTrigger
NotificationRs
Create or update notification
POST /notification/createOrUpdate
GET /notification/listNotificationHistory
GET /notification/listInboundRequest
Remove notification by code
DELETE /notification/{notificationCode}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
notificationCode |
Code of the notification |
string |
Find notification by code
GET /notification
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
notificationCode |
Code of the notification |
string |
Update notification
PUT /notification
WebHookNotificationRs
Create or update web hook notification
POST /notification/webhook/createOrUpdate
Remove web hook notification by code
DELETE /notification/webhook/{notificationCode}
Find web hook notification by code
GET /notification/webhook
Update web hook notification
PUT /notification/webhook
PersistenceRs
List persistence
POST /{repository}/persistence
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
successful operation |
< PersistedItem > array |
List data for a given CET
POST /{repository}/persistence/{cetCode}/examples
Get persistence
GET /{repository}/persistence/{cetCode}/{uuid}
Update persistence
PUT /{repository}/persistence/{cetCode}/{uuid}
Delete persistence by cet code
DELETE /{repository}/persistence/{cetCode}/{uuid}
List data for a given CET
POST /{repository}/persistence/{cetCode}/list
SqlConfigurationRs
Create new or update an existing sqlConfiguration
POST /sql/configurations/createOrUpdate
Search for sqlConfiguration with a given code
GET /sql/configurations/{code}
Removes an existing sqlConfiguration with a given code
DELETE /sql/configurations/{code}
List sql configuration
GET /sql/configurations
Update an existing sqlConfiguration
PUT /sql/configurations
Create a new sqlConfiguration
POST /sql/configurations
Initializes custom tables for the given configuration
POST /sql/configurations/{code}/initialize
BinaryStorageConfigurationRs
Create or update binary storage
POST /storages/binaries/createOrUpdate
Find binary storage by code
GET /storages/binaries/{code}
Remove binary storage by code
DELETE /storages/binaries/{code}
List of binary storages
GET /storages/binaries
Update binary storage
PUT /storages/binaries
Create binary storage
POST /storages/binaries
FileSystemRs
Find binary by index and code repository and code cet and uuid and code cft
GET /fileSystem/binaries/{repositoryCode}/{cetCode}/{uuid}/{cftCode}
Repository
Create or update repository
POST /storages/repositories/createOrUpdate
Find repository by code
GET /storages/repositories/{code}
Remove repository by code
DELETE /storages/repositories/{code}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
code |
Code of the repository |
string |
Query |
forceDelete |
Whether to delete the children of the repository |
boolean |
List of repositorys
GET /storages/repositories
Update repository
PUT /storages/repositories
Create repository
POST /storages/repositories
EndpointRs
WorkflowRs
Create or update workflow
POST /admin/workflow/createOrUpdate
Find workflow by entity
GET /admin/workflow/findByEntity
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseEntityName |
Name of the base entity |
string |
Find history workflow by code and from status and to status
GET /admin/workflow/history
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
entityInstanceCode |
Code of the entity instance |
string |
Query |
workflowCode |
Code of the workflow |
string |
Query |
fromStatus |
From status |
string |
Query |
toStatus |
To status |
string |
Remove workflow by code
DELETE /admin/workflow/{code}
Find workflow by code
GET /admin/workflow
Update workflow
PUT /admin/workflow
Create workflow
POST /admin/workflow
Execute workflow
POST /admin/workflow/execute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseEntityName |
Name of the base entity |
string |
Query |
entityInstanceCode |
Code of the entity instance |
string |
Query |
workflowCode |
Code of the workflow |
string |
Definitions
FunctionDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
testSuite |
Name of test suite |
string |
inputs |
Input parameters |
< FunctionIO > array |
outputs |
List of outputs |
< FunctionIO > array |
samples |
Example input / outputs |
< Sample > array |
generateOutputs |
Whether to generate outputs or not |
boolean |
ActionStatus
| Name | Description | Schema |
|---|---|---|
status |
Status of the api response |
enum (SUCCESS, FAIL) |
errorCode |
Error code return by an api request |
enum (ENTITY_DOES_NOT_EXISTS_EXCEPTION, ENTITY_ALREADY_EXISTS_EXCEPTION, DELETE_REFERENCED_ENTITY_EXCEPTION, MISSING_PARAMETER, INVALID_PARAMETER, INVALID_ENUM_VALUE, DUPLICATE_ACCESS, INSUFFICIENT_BALANCE, GENERIC_API_EXCEPTION, BUSINESS_API_EXCEPTION, AUTHENTICATION_AUTHORIZATION_EXCEPTION, ACTION_FORBIDDEN, INVALID_IMAGE_DATA) |
message |
Message return by an api request |
string |
getjson |
string |
FileDto
| Name | Description | Schema |
|---|---|---|
name |
Physical file name in the system |
string |
lastModified |
Last date this file is modified |
string (date-time) |
directory |
boolean |
GetFilesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
files |
List of files information |
< FileDto > array |
CommunicationRequestDto
| Name | Description | Schema |
|---|---|---|
meveoInstanceCode |
Code of the meveo instance |
string |
macAddress |
Mac address of the meveo instance |
string |
subject |
Subject of the meveo instance |
string |
body |
Body of the meveo instance |
string |
additionnalInfo1 |
Additionnal info 1 |
string |
additionnalInfo2 |
Additionnal info 2 |
string |
additionnalInfo3 |
Additionnal info 3 |
string |
additionnalInfo4 |
Additionnal info 4 |
string |
vaild |
boolean |
EmailTemplateDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
media |
The type of message channel |
enum (POSTAL_MAIL, EMAIL, SMS, IM, FAX, VOICE, WEBSERVICE, QUEUE, FTP_FILE, CFT_FILE, DATABASE) |
tagStartDelimiter |
Use to parse an expression language |
string |
tagEndDelimiter |
End of the expression language |
string |
startDate |
Start date |
string (date-time) |
endDate |
End date |
string (date-time) |
type |
Template for this message |
enum (DUNNING, INVOICE, OTHER) |
subject |
Subject of the email |
string |
htmlContent |
Html content of the email |
string |
textContent |
Text content of the email |
string |
EmailTemplatesResponseDto
| Name | Schema |
|---|---|
actionStatus |
|
emailTemplates |
< EmailTemplateDto > array |
MeveoInstanceDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
productName |
The product name |
string |
productVersion |
The product version |
string |
owner |
The owner |
string |
md5 |
The md 5 |
string |
status |
The status |
enum (UNKNOWN, PARENT, CHILD, PARTNER) |
creationDate |
The creation date |
string (date-time) |
updateDate |
The update date |
string (date-time) |
keyEntreprise |
The key entreprise |
string |
macAddress |
The mac address |
string |
machineVendor |
The machine vendor |
string |
installationMode |
The installation mode |
string |
nbCores |
The nb cores |
string |
memory |
The memory |
string |
hdSize |
The hd size |
string |
osName |
The os name |
string |
osVersion |
The os version |
string |
osArch |
The os arch |
string |
javaVmVersion |
The java vm version |
string |
javaVmName |
The java vm name |
string |
javaVendor |
The java vendor |
string |
javaVersion |
The java version |
string |
asVendor |
The as vendor |
string |
asVersion |
The as version |
string |
url |
The url |
string |
authUsername |
The auth username |
string |
authPassword |
The auth password |
string |
user |
The user |
string |
customer |
The customer |
string |
MeveoInstancesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
meveoInstances |
List of meveo instances information |
< MeveoInstanceDto > array |
RemoteRepositoryDto
| Name | Description | Schema |
|---|---|---|
code |
Code of remote repisitory |
string |
url |
The url of remote repisitory |
string |
MavenConfigurationDto
| Name | Description | Schema |
|---|---|---|
mavenExecutablePath |
Maven executable path |
string |
mavenRepositories |
List of maven repositories |
< string > array |
MavenConfigurationUploadForm
| Name | Description | Schema |
|---|---|---|
data |
Zipped maven content |
|
filename |
string |
|
groupId |
string |
|
artifactId |
string |
|
version |
string |
|
classifier |
string |
MavenConfigurationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
mavenConfiguration |
Maven configuration information |
RemoteRepositoriesRespondseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
remoteRepositories |
List of remote repositories information |
< RemoteRepositoryDto > array |
CustomEntityCategoryDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
name |
Name of the custom entity category |
string |
CustomEntityCategoryResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customEntityCategory |
Custom entity category information |
CustomEntityCategoriesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
customEntityCategories |
List of custom entity categories |
< CustomEntityCategoryDto > array |
PagingAndFiltering
| Name | Description | Schema |
|---|---|---|
fullTextFilter |
Full text search filter |
string |
filters |
Search filters |
< string, object > map |
fields |
Data retrieval options/fieldnames separated by a comma |
string |
offset |
Offset from record number |
integer (int32) |
limit |
Number of items to retrieve |
integer (int32) |
sortBy |
Sort by a field |
string |
sortOrder |
Sort order |
enum (ASCENDING, DESCENDING) |
totalNumberOfRecords |
Total number of records |
integer (int32) |
CustomEntityInstanceDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the custom entity instance |
string |
description |
Description of the custom entity instance |
string |
cetCode |
Code of the custom entity template |
string |
disabled |
Whether to disable |
boolean |
customFields |
Custom fields information |
CustomFieldDto
| Name | Description | Schema |
|---|---|---|
code |
Code use as the identity of this entity |
string |
valueDate |
The date value |
string (date-time) |
valuePeriodStartDate |
Period’s start date |
string (date-time) |
valuePeriodEndDate |
Period’s end date |
string (date-time) |
valuePeriodPriority |
Period’s priority |
integer (int32) |
stringValue |
String value |
string |
dateValue |
Date value |
integer (int64) |
longValue |
Long value |
integer (int64) |
doubleValue |
Double value |
number (double) |
listValue |
List value |
< CustomFieldValueDto > array |
mapValue |
Map value |
< string, CustomFieldValueDto > map |
entityReferenceValue |
Entity reference value |
|
valueConverted |
A transient object. Contains a converted value from DTO to some object when it is applicable |
object |
indexType |
The type of index |
enum (STORE_ONLY, INDEX, STORE_ONLY_NEO4J, INDEX_NEO4J, INDEX_NOT_ANALYZE) |
booleanValue |
Boolean value |
boolean |
empty |
boolean |
CustomFieldValueDto
| Name | Description | Schema |
|---|---|---|
value |
Object value representation of the custom field value |
object |
empty |
boolean |
CustomFieldsDto
| Name | Schema |
|---|---|
customField |
< CustomFieldDto > array |
inheritedCustomField |
< CustomFieldDto > array |
empty |
boolean |
EntityReferenceDto
| Name | Description | Schema |
|---|---|---|
classname |
Classname of this entity |
string |
code |
Code of this entity |
string |
id |
Id of this entity |
integer (int64) |
empty |
boolean |
CustomEntityInstanceResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customEntityInstance |
Custom entity instance information |
CustomEntityInstancesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customEntityInstances |
List of custom entity instances |
< CustomEntityInstanceDto > array |
CustomFieldMatrixColumnDto
| Name | Description | Schema |
|---|---|---|
columnUse |
The column use |
enum (USE_KEY, USE_VALUE) |
position |
Display position |
integer (int32) |
code |
Unique field for this entity |
string |
label |
Display label |
string |
keyType |
Type of key for this matrix |
enum (STRING, TEXT_AREA, LONG, DOUBLE, RON) |
CustomFieldTemplateDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the custom field template |
string |
description |
Description of the custom field template |
string |
languageDescriptions |
List of language descriptions information |
< LanguageDescriptionDto > array |
fieldType |
Value type |
enum (STRING, DATE, LONG, DOUBLE, LIST, ENTITY, TEXT_AREA, CHILD_ENTITY, MULTI_VALUE, EXPRESSION, BOOLEAN, EMBEDDED_ENTITY, BINARY) |
accountLevel |
The account level |
string |
appliesTo |
Applies to |
string |
defaultValue |
Default value |
string |
useInheritedAsDefaultValue |
Whether to inherit value be used as default value instead if available |
boolean |
storageType |
Value storage type |
enum (SINGLE, LIST, MAP, MATRIX) |
valueRequired |
Whether to require value |
boolean |
versionable |
Whether to versionable value |
boolean |
triggerEndPeriodEvent |
Whether to fire Period end event when value period is over |
boolean |
calendar |
Calendar associated to value versioning periods |
string |
cacheValueTimeperiod |
Cache value time period |
integer (int32) |
entityClazz |
Entity class and CET code for a reference to entity or child entity type fields |
string |
listValues |
List of values for LIST type field |
< string, string > map |
allowEdit |
Whether to change value when editing a previously saved entity |
boolean |
hideOnNew |
Whether to do not show/apply field on new entity creation |
boolean |
maxValue |
Maximum value to validate long and double values |
integer (int64) |
minValue |
Minimum value to validate long and double values |
integer (int64) |
regExp |
Regular expression to validate string values |
string |
cacheValue |
Whether to cache value |
boolean |
contentTypes |
List of content types |
< string > array |
fileExtensions |
List of file extensions |
< string > array |
maxFileSizeAllowedInKb |
Max files size allowed in kb |
integer (int64) |
filePath |
File path |
string |
saveOnExplorer |
Whether to save on explorer |
boolean |
guiPosition |
Gui position |
string |
relationshipName |
Name of relationship |
string |
relationship |
Code of relationship |
string |
expressionSeparator |
Expression separator |
string |
identifier |
Whether we can use this field as the identifier of the entity |
boolean |
mapKeyType |
Key format of a map for map type fields |
enum (STRING, TEXT_AREA, LONG, DOUBLE, RON) |
applicableOnEl |
EL expression to evaluate when field is applicable |
string |
storages |
List of storage types |
< enum (SQL, NEO4J) > array |
samples |
List of samples |
< string > array |
summary |
Whether to summary |
boolean |
indexType |
If and how custom field values should be indexed in Elastic Search |
enum (STORE_ONLY, INDEX, STORE_ONLY_NEO4J, INDEX_NEO4J, INDEX_NOT_ANALYZE) |
tags |
Tags assigned to custom field template |
string |
displayFormat |
Display format |
string |
unique |
Whether to unique |
boolean |
entityClazzCetCode |
string |
|
filter |
Whether to filter |
boolean |
matrixColumns |
A list of columns matrix consists of |
< CustomFieldMatrixColumnDto > array |
childEntityFieldsForSummary |
A list of child entity fields to be displayed in a summary table of child entities |
< string > array |
LanguageDescriptionDto
| Name | Description | Schema |
|---|---|---|
languageCode |
The language code |
string |
description |
The description |
string |
GetCustomFieldTemplateReponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customFieldTemplate |
Custom field template information |
CustomRelationshipTemplateDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the custom relationship template |
string |
name |
Name of the custom relationship template |
string |
description |
Description of the custom relationship template |
string |
direction |
Relationship direction type |
enum (OUTGOING, INCOMING, BIDIRECTIONAL) |
startNodeKeys |
List of start node keys |
< string > array |
endNodeKeys |
List of end node keys |
< string > array |
availableStorages |
List of available storages where the custom relationship instances should be stored |
< enum (SQL, NEO4J) > array |
sourceNameSingular |
Name of the field that will be added to the source entity to refer the most recent target entity |
string |
sourceNamePlural |
Name of the field that will be added to the source entity to refer every target entities |
string |
targetNameSingular |
Name of the field that will be added to the target entity to refer the most recent source entity |
string |
targetNamePlural |
Name of the field that will be added to the target entity to refer every source entities |
string |
graphQlTypeName |
Name of graphQl type |
string |
unique |
boolean |
|
fields |
List of custom fields information |
< CustomFieldTemplateDto > array |
startNodeCode |
Start node code |
string |
endNodeCode |
End node code |
string |
CustomRelationshipTemplateResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customRelationshipTemplate |
Custom relationship template information |
CustomRelationshipTemplatesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customRelationshipTemplates |
List of custom relationship templates information |
< CustomRelationshipTemplateDto > array |
CustomTableDataDto
| Name | Description | Schema |
|---|---|---|
sqlConnectionCode |
Code of SqlConnection |
string |
customTableCode |
Custom table/custom entity (or relation) template code |
string |
overwrite |
Should data be overwritten (deleted all data first) instead of appended to existing values. Defaults to false if omitted. |
boolean |
records |
A list of values with field name as map’s key and field value as map’s value |
< CustomTableRecordDto > array |
CustomTableDataResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
customTableData |
Search within custom table results |
CustomTableRecordDto
| Name | Description | Schema |
|---|---|---|
values |
Hashmap of values |
< string, object > map |
EntityCustomActionDto
| Name | Description | Schema |
|---|---|---|
code |
Code of entity custom action |
string |
description |
Description of entity custom action |
string |
appliesTo |
Entity action applies to |
string |
applicableOnEl |
EL expression when action button should be visible. |
string |
label |
Button label |
string |
labelsTranslated |
Button label translations |
< LanguageDescriptionDto > array |
script |
Script instance information |
|
guiPosition |
Gui position |
string |
MavenDependencyDto
| Name | Description | Schema |
|---|---|---|
groupId |
The groupId |
string |
artifactId |
The artifactId |
string |
version |
The version |
string |
classifier |
The classifier |
string |
coordinates |
The coordinates |
string |
PermissionDto
| Name | Description | Schema |
|---|---|---|
permission |
The permission. Should be a very or prefix with a verb. |
string |
name |
The name use to identify this permission |
string |
RoleDto
| Name | Description | Schema |
|---|---|---|
name |
Name of the role |
string |
description |
Description of the role |
string |
permission |
List of permissions information |
< PermissionDto > array |
roles |
List of roles information |
< RoleDto > array |
ScriptInstanceDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
testSuite |
Name of test suite |
string |
inputs |
Input parameters |
< FunctionIO > array |
outputs |
List of outputs |
< FunctionIO > array |
samples |
Example input / outputs |
< Sample > array |
generateOutputs |
Whether to generate outputs or not |
boolean |
type |
enum (JAVA, ES5) |
|
script |
string |
|
executionRoles |
The execution roles. |
< RoleDto > array |
sourcingRoles |
The sourcing roles |
< RoleDto > array |
error |
Whether the script has compilation errors |
boolean |
mavenDependencies |
The maven dependencies |
< MavenDependencyDto > array |
importScriptInstances |
The import script instances |
< ScriptInstanceDto > array |
CustomEntityTemplateDto
| Name | Description | Schema |
|---|---|---|
code |
Code of custom entity template |
string |
superTemplate |
Super template |
string |
name |
Name of custom entity template |
string |
description |
Description of custom entity template |
string |
prePersistScripCode |
Code of the pre-persist script instance |
string |
customEntityCategoryCode |
Code of the custom entity category |
string |
availableStorages |
List of storages where cfts can be stored |
< enum (SQL, NEO4J) > array |
neo4jStorageConfiguration |
Neo4J storage configuration information |
|
sqlStorageConfiguration |
SQL storage configuration |
|
samples |
List of samples |
< string > array |
fields |
List of custom field templates information |
< CustomFieldTemplateDto > array |
actions |
List of entity custom actions information |
< EntityCustomActionDto > array |
CustomEntityTemplateUniqueConstraintDto
| Name | Description | Schema |
|---|---|---|
code |
The code of this dto |
string |
appliesTo |
Applies this template to this entity’s code |
string |
description |
Desscription of this dto |
string |
cypherQuery |
Cypher query for this entity |
string |
trustScore |
Trust store for this entity |
integer (int32) |
applicableOnEl |
Applies this unique constraint using this EL expression. |
string |
order |
Order value use when sorting a list of this entity |
integer (int32) |
GraphQLQueryField
| Name | Schema |
|---|---|
fieldName |
string |
fieldType |
string |
multivalued |
boolean |
query |
string |
Mutation
| Name | Schema |
|---|---|
code |
string |
parameters |
< string, string > map |
cypherQuery |
string |
Neo4JStorageConfigurationDto
| Name | Schema |
|---|---|
labels |
< string > array |
primitiveEntity |
boolean |
primitiveType |
enum (STRING, DATE, LONG, DOUBLE) |
graphqlQueryFields |
< GraphQLQueryField > array |
mutations |
< Mutation > array |
uniqueConstraints |
< CustomEntityTemplateUniqueConstraintDto > array |
EntityCustomizationDto
| Name | Description | Schema |
|---|---|---|
classname |
The classname |
string |
fields |
List of custom field templates information |
< CustomFieldTemplateDto > array |
actions |
List of entity custom actions information |
< EntityCustomActionDto > array |
EntityCustomizationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
entityCustomization |
Entity customization information |
BusinessEntityDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
BusinessEntityResponseDto
| Name | Schema |
|---|---|
actionStatus |
|
businessEntities |
< BusinessEntityDto > array |
CustomEntityTemplateResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customEntityTemplate |
Custom entity template information |
CustomEntityTemplatesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
customEntityTemplates |
List of custom entity templates |
< CustomEntityTemplateDto > array |
GraphQLRequest
| Name | Schema |
|---|---|
query |
string |
operationName |
string |
variables |
< string, object > map |
PersistenceDto
| Name | Description | Schema |
|---|---|---|
discriminator |
Type of the object to persist |
string |
source |
Source of relation |
string |
target |
Target of relation |
string |
type |
Type of the relation or entity |
string |
name |
Unique name of the entity in the given context |
string |
properties |
Map of properties to attach to the object, key references the CFT code |
< string, object > map |
ChartDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
measurableQuantity |
Measurable quantity information |
|
width |
The width |
string |
height |
The height |
string |
style |
The style |
string |
styleClass |
The style class |
string |
extender |
The extender |
string |
visible |
Whether to visible |
boolean |
MeasurableQuantityDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
theme |
The theme |
string |
dimension1 |
The dimension 1 |
string |
dimension2 |
The dimension 2 |
string |
dimension3 |
The dimension 3 |
string |
dimension4 |
The dimension 14 |
string |
editable |
The editable |
boolean |
additive |
The additive |
boolean |
sqlQuery |
The sql query |
string |
cypherQuery |
The cypher query |
string |
measurementPeriod |
The measurement period |
enum (DAILY, WEEKLY, MONTHLY, YEARLY) |
lastMeasureDate |
The last measure date |
integer (int64) |
codeOnly |
boolean |
BarChartDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
measurableQuantity |
Measurable quantity information |
|
width |
The width |
string |
height |
The height |
string |
style |
The style |
string |
styleClass |
The style class |
string |
extender |
The extender |
string |
visible |
Whether to visible |
boolean |
legendPosition |
The legend position |
enum (n, s, e, w) |
barPadding |
The bar padding |
integer (int32) |
barMargin |
The bar margin |
integer (int32) |
orientation |
The orientation |
enum (vertical, horizontal) |
stacked |
Enables stacked display of bars |
boolean |
min |
Minimum boundary value |
number (double) |
max |
Maximum boundary value |
number (double) |
breakOnNull |
Whether line segments should be broken at null value |
boolean |
xaxisLabel |
The xaxis label |
string |
yaxisLabel |
The yaxis label |
string |
xaxisAngle |
Angle of the x-axis ticks |
integer (int32) |
yaxisAngle |
The yaxis angle |
integer (int32) |
legendCols |
The legend cols |
integer (int32) |
legendRows |
The legend rows |
integer (int32) |
zoom |
Enables plot zooming |
boolean |
animate |
Enables animation on plot rendering |
boolean |
showDataTip |
Defines visibility of datatip |
boolean |
datatipFormat |
Template string for datatips |
string |
PieChartDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
measurableQuantity |
Measurable quantity information |
|
width |
The width |
string |
height |
The height |
string |
style |
The style |
string |
styleClass |
The style class |
string |
extender |
The extender |
string |
visible |
Whether to visible |
boolean |
filled |
The filled |
boolean |
legendPosition |
The legend position |
enum (n, s, e, w) |
seriesColors |
The series colors |
string |
diameter |
The diameter |
integer (int32) |
sliceMargin |
The slice margin |
integer (int32) |
shadow |
The shadow |
boolean |
showDataLabels |
The show data labels |
boolean |
legendCols |
The legend cols |
integer (int32) |
legendRows |
The legend rows |
integer (int32) |
LineChartDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
measurableQuantity |
Measurable quantity information |
|
width |
The width |
string |
height |
The height |
string |
style |
The style |
string |
styleClass |
The style class |
string |
extender |
The extender |
string |
visible |
Whether to visible |
boolean |
filled |
The filled |
boolean |
legendPosition |
The legend position |
enum (n, s, e, w) |
seriesColors |
The series colors |
string |
shadow |
The shadow |
boolean |
minX |
The min X |
integer (int32) |
maxX |
The max X |
integer (int32) |
minY |
The min Y |
integer (int32) |
maxY |
The max Y |
integer (int32) |
breakOnNull |
Whether line segments should be broken at null value |
boolean |
xaxisLabel |
The xaxis label |
string |
yaxisLabel |
The yaxis label |
string |
xaxisAngle |
Angle of the x-axis ticks |
integer (int32) |
yaxisAngle |
The yaxis angle |
integer (int32) |
stacked |
Whether to stack series |
boolean |
zoom |
Enables plot zooming |
boolean |
animate |
Enables animation on plot rendering |
boolean |
showDataTip |
Defines visibility of datatip |
boolean |
datatipFormat |
Template string for datatips |
string |
legendCols |
The legend cols |
integer (int32) |
legendRows |
The legend rows |
integer (int32) |
GetMeasurableQuantityResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
measurableQuantityDto |
Measurable quantity information |
GetListMeasurableQuantityResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
listMeasurableQuantityDto |
List of measurable quantities information |
< MeasurableQuantityDto > array |
FilterDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
shared |
Whether this filter is shared |
boolean |
inputXml |
The input xml |
string |
ReportExtractDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
scriptType |
The script type |
enum (JAVA, SQL) |
filenameFormat |
The filename format |
string |
category |
The category |
string |
scriptInstanceCode |
Code of the script instance |
string |
sqlQuery |
The sql query |
string |
params |
Map of params |
< string, string > map |
startDate |
The start date |
string (date-time) |
endDate |
The end date |
string (date-time) |
RunReportExtractDto
| Name | Description | Schema |
|---|---|---|
code |
The code |
string |
params |
Map of params |
< string, string > map |
ReportExtractResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
reportExtract |
Report extract information |
ReportExtractsResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
reportExtracts |
List of report extracts information |
< ReportExtractDto > array |
GitRepositoryDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
readingRoles |
List of reading roles that allows a user to make pull, fetch and clone actions |
< string > array |
writingRoles |
List of writing roles that allows a user to make commit, merge and push actions |
< string > array |
remoteOrigin |
Remote origin url if the repository is hosted somewhere else than locally |
string |
remoteUsername |
Remote username to use when making action with distant repository |
string |
remotePassword |
Remote password to use when making action with distant repository |
string |
meveoRepository |
Whether the remote repository is hosted in a meveo instance |
boolean |
currentBranch |
string |
|
branches |
< string > array |
|
remote |
boolean |
GitRepositoryUploadForm
| Name | Description | Schema |
|---|---|---|
data |
Zipped repository content |
|
repository |
Repository information |
UserHierarchyLevelDto
| Name | Description | Schema |
|---|---|---|
code |
The code |
string |
description |
The description |
string |
parentLevel |
The parent level |
string |
childLevels |
List of user hierarchy levels information |
< UserHierarchyLevelDto > array |
orderLevel |
The order level |
integer (int64) |
UserHierarchyLevelsDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
userHierarchyLevels |
List of user hierarchy levels information |
< UserHierarchyLevelDto > array |
UserHierarchyLevelResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
userHierarchyLevel |
User hierarchy level information |
CalendarDateIntervalDto
| Name | Description | Schema |
|---|---|---|
intervalBegin |
Beginning interval |
integer (int32) |
intervalEnd |
Ending interval |
integer (int32) |
CalendarDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
calendarType |
Calendar type |
enum (YEARLY, DAILY, PERIOD, INTERVAL, INTERSECT, UNION) |
days |
List of days in year |
< DayInYearDto > array |
hours |
List of hours in day |
< HourInDayDto > array |
periodLength |
Period length |
integer (int32) |
periodUnit |
Period measurement unit |
enum (MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND) |
nbPeriods |
Number of periods |
integer (int32) |
joinCalendar1Code |
Code of the first calendar to intersect/union |
string |
joinCalendar2Code |
Code of the second calendar to intersect/union |
string |
intervalType |
Calendar interval type |
enum (DAY, HOUR, WDAY) |
intervals |
List of intervals |
< CalendarDateIntervalDto > array |
DayInYearDto
| Name | Description | Schema |
|---|---|---|
day |
Day value |
integer (int32) |
month |
Month value of this object |
enum (JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER) |
HourInDayDto
| Name | Description | Schema |
|---|---|---|
hour |
The hour |
integer (int32) |
min |
The min |
integer (int32) |
GetCalendarResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
calendar |
Calendar information |
CalendarsDto
| Name | Description | Schema |
|---|---|---|
calendar |
List of calendar information |
< CalendarDto > array |
ListCalendarResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
calendars |
List of calendars information |
CountryIsoDto
| Name | Description | Schema |
|---|---|---|
countryCode |
Code of the country |
string |
description |
Description of the country |
string |
nationality |
The nationality |
string |
languageDescriptions |
List of language descriptions information |
< LanguageDescriptionDto > array |
currencyCode |
Code of the currency |
string |
languageCode |
Code of the language |
string |
GetCountryIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
country |
Country information |
GetCountriesIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
countries |
List of countries information |
< CountryIsoDto > array |
CountryDto
| Name | Description | Schema |
|---|---|---|
countryCode |
Code of the country |
string |
name |
Name of the country |
string |
currencyCode |
Code of the currency |
string |
languageCode |
Code of the language |
string |
GetCountryResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
country |
Country information |
CurrencyIsoDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the currency |
string |
description |
Description of the currency |
string |
GetCurrencyIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
currency |
Currency information |
GetCurrenciesIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
currencies |
List of currencies information |
< CurrencyIsoDto > array |
CurrencyDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the currency |
string |
description |
Description of the currency |
string |
GetCurrencyResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
currency |
Currency information |
GetFilterResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
filter |
Filter information |
LanguageIsoDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the language |
string |
description |
Description of the language |
string |
GetLanguageIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
language |
Language information |
GetLanguagesIsoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
languages |
List of languages information |
< LanguageIsoDto > array |
LanguageDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the language |
string |
description |
Description of the language |
string |
GetLanguageResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
language |
Language information |
MailerConfigurationDto
| Name | Description | Schema |
|---|---|---|
host |
The host |
string |
port |
The port |
integer (int32) |
userName |
The user name |
string |
password |
The password |
string |
tls |
The tls |
boolean |
PermissionResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
permissionsDto |
Permissions information |
PermissionsDto
| Name | Description | Schema |
|---|---|---|
permission |
List of permissions |
< PermissionDto > array |
ProviderDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the provider |
string |
description |
The description |
string |
currency |
The currency |
string |
country |
The country |
string |
language |
The country |
string |
multiCurrency |
The multi currency |
boolean |
multiCountry |
The multi country |
boolean |
multiLanguage |
The multi language |
boolean |
userAccount |
The user account |
string |
enterprise |
The enterprise |
boolean |
levelDuplication |
The level duplication |
boolean |
rounding |
The rounding |
integer (int32) |
prepaidReservationExpirationDelayinMillisec |
The prepaid reservation expiration delayin millisec |
integer (int64) |
discountAccountingCode |
Code of the discount accounting |
string |
email |
The email |
string |
recognizeRevenue |
The recognize revenue |
boolean |
customFields |
Custom fields information |
GetProviderResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
provider |
Provider information |
ProvidersDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
providers |
List of providers information |
< ProviderDto > array |
RolesDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
roles |
List of roles information |
< RoleDto > array |
ScriptInstanceErrorDto
| Name | Description | Schema |
|---|---|---|
lineNumber |
The line number |
integer (int64) |
columnNumber |
The column number |
integer (int64) |
message |
string |
ScriptInstanceReponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
compilationErrors |
The compilation errors |
< ScriptInstanceErrorDto > array |
GetScriptInstanceResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
scriptInstance |
Script instance information |
SecuredEntityDto
| Name | Description | Schema |
|---|---|---|
code |
Code of this entity |
string |
entityClass |
The entity class |
string |
UserDto
| Name | Description | Schema |
|---|---|---|
username |
The username |
string |
password |
Password used when creating keycloak user |
string |
email |
The email |
string |
firstName |
The first name |
string |
lastName |
The last name |
string |
roles |
List of roles |
< string > array |
externalRoles |
The external roles |
< RoleDto > array |
securedEntities |
The secured entities |
< SecuredEntityDto > array |
role |
The role |
string |
userLevel |
The user level |
string |
createdAt |
The created at |
string (date-time) |
lastLoginDate |
The last login date |
string (date-time) |
sshPrivateKey |
Ssh private key |
string |
sshPublicKey |
Ssh public key |
string |
UsersDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
paging |
||
users |
List of users information |
< UserDto > array |
ImportExportResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
executionId |
The execution id |
string |
summary |
Summary of entities imported/exported per entity class |
< string, integer (int32) > map |
fieldsNotImported |
Stores a list of field names that were not imported because of differences between original and current model |
< string, FieldsNotImportedStringCollectionDto > map |
exceptionMessage |
Occurred exception message |
string |
failureMessage |
string |
|
failureMessageKey |
string |
|
done |
boolean |
|
failed |
boolean |
InputPart
| Name | Schema |
|---|---|
bodyAsString |
string |
mediaType |
|
headers |
< string, < string > array > map |
contentTypeFromMessage |
boolean |
MediaType
| Name | Schema |
|---|---|
type |
string |
subtype |
string |
parameters |
< string, string > map |
wildcardSubtype |
boolean |
wildcardType |
boolean |
MultipartFormDataInput
| Name | Schema |
|---|---|
formDataMap |
< string, < InputPart > array > map |
formData |
< string, InputPart > map |
preamble |
string |
parts |
< InputPart > array |
JobInstanceDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
jobCategory |
Job category type |
enum (RATING, INVOICING, IMPORT_HIERARCHY, DWH, ACCOUNT_RECEIVABLES, WALLET, UTILS, MEDIATION, EXPORT, TEST) |
jobTemplate |
Job template |
string |
followingJob |
Following job to execute |
string |
parameter |
Parameter to job execution |
string |
customFields |
Custom fields information |
|
timerCode |
Job scheduling timer code |
string |
runOnNodes |
What cluster nodes job could/should run on |
string |
limitToSingleNode |
Limit to single node |
boolean |
JobInstanceResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
jobInstanceDto |
Contains job instance information |
JobExecutionResultDto
| Name | Description | Schema |
|---|---|---|
id |
Job execution result identifier. |
integer (int64) |
jobInstanceId |
Job instance identifier |
integer (int64) |
runningOnNodes |
Nodes that job is CURRENTLY running. |
string |
startDate |
Job start date |
string (date-time) |
endDate |
Job end date |
string (date-time) |
nbItemsToProcess |
Number of items to process |
integer (int64) |
nbItemsCorrectlyProcessed |
Number of items that were processed correctly |
integer (int64) |
nbItemsProcessedWithWarning |
Number of items that were processed with warning |
integer (int64) |
nbItemsProcessedWithError |
Number of items that were not processed due to some error |
integer (int64) |
done |
Is job execution done - if False, job should be repeated again to finish processing |
boolean |
report |
Jon execution report/summary |
string |
jobInstanceCode |
JobInstance code |
string |
JobExecutionResultResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
jobExecutionResultDto |
Contains job execution result information |
TimerEntityDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
hour |
The hour |
string |
minute |
The minute |
string |
second |
The second |
string |
year |
The year |
string |
month |
The month |
string |
dayOfMonth |
The day of month |
string |
dayOfWeek |
The day of week |
string |
TimerEntityResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
timerEntity |
Timer entity information |
JobInstanceInfoDto
| Name | Description | Schema |
|---|---|---|
timerName |
The timer name |
string |
code |
Code of job instance info |
string |
lastTransactionDate |
The last transaction date |
string (date-time) |
invoiceDate |
The invoice date |
string (date-time) |
billingCycle |
The billing cycle |
string |
forceExecution |
Ignore a check if job is currently running and launch it anyway |
boolean |
GetTimerEntityResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
timerEntity |
Timer entity information |
MeveoModulePatchDto
| Name | Description | Schema |
|---|---|---|
moduleCode |
The module code |
string |
scriptInstance |
Script executed before and after this patch is applied. |
|
sourceVersion |
This patch can be apply from this version |
string |
targetVersion |
This patch can be apply up to this version |
string |
MeveoModuleDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
license |
The license type |
enum (APACHE, BSD3_N, BSD3_R, BSD2_S, FREE_BSD, GPL, AGPL, LGPL, MIT, MOZ, CDDL, EPL, OPEN, COM) |
logoPicture |
The logo picture |
string |
logoPictureFile |
The logo picture file |
< string (byte) > array |
script |
Script instance information |
|
currentVersion |
The current version |
string |
meveoVersionBase |
The meveo version base |
string |
meveoVersionCeiling |
The meveo version ceiling |
string |
codeOnly |
boolean |
|
inDraft |
boolean |
|
transient |
boolean |
|
moduleItems |
List of module items information |
< MeveoModuleItemDto > array |
moduleDependencies |
List of module dependencies information |
< ModuleDependencyDto > array |
patches |
List of patch linked to this module |
< MeveoModulePatchDto > array |
moduleFiles |
The module files |
< string > array |
MeveoModuleItemDto
| Name | Description | Schema |
|---|---|---|
dtoClassName |
Simple class name to of this module |
string |
dtoData |
Linked list value representation of this object when module is uninstalled. Otherwise, it represents the object. |
object |
ModuleDependencyDto
| Name | Description | Schema |
|---|---|---|
code |
The module code |
string |
description |
The module description |
string |
currentVersion |
The current version |
string |
ModuleUploadForm
| Name | Description | Schema |
|---|---|---|
data |
Zipped module with files |
|
filename |
string |
MeveoModuleDtoResponse
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
module |
Module information |
Neo4jConfigurationDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
neo4jUrl |
Neo4j url |
string |
neo4jLogin |
Neo4j login |
string |
neo4jPassword |
Neo4j password |
string |
Neo4jConfigurationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
neo4jConfiguration |
Neo4j configuration information |
Neo4jConfigurationsResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
neo4jConfigurations |
List of neo4j configurations information |
< Neo4jConfigurationDto > array |
JobTriggerDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
classNameFilter |
The class name filter |
string |
eventTypeFilter |
Notification event type |
enum (CREATED, UPDATED, REMOVED, TERMINATED, DISABLED, PROCESSED, REJECTED, REJECTED_CDR, LOGGED_IN, INBOUND_REQ, ENABLED, LOW_BALANCE, FILE_UPLOAD, FILE_DOWNLOAD, FILE_RENAME, FILE_DELETE, COUNTER_DEDUCED, END_OF_TERM) |
elFilter |
The el filter |
string |
scriptInstanceCode |
Code of the script instance |
string |
scriptParams |
Map of script params |
< string, string > map |
counterTemplate |
The counter template |
string |
priority |
The priority |
integer (int32) |
jobParams |
Map of job params |
< string, string > map |
jobInstance |
The job instance |
string |
GetJobTriggerResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
jobTriggerDto |
Job trigger information |
NotificationDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
classNameFilter |
The class name filter |
string |
eventTypeFilter |
Notification event type |
enum (CREATED, UPDATED, REMOVED, TERMINATED, DISABLED, PROCESSED, REJECTED, REJECTED_CDR, LOGGED_IN, INBOUND_REQ, ENABLED, LOW_BALANCE, FILE_UPLOAD, FILE_DOWNLOAD, FILE_RENAME, FILE_DELETE, COUNTER_DEDUCED, END_OF_TERM) |
elFilter |
The el filter |
string |
scriptInstanceCode |
Code of the script instance |
string |
scriptParams |
Map of script params |
< string, string > map |
counterTemplate |
The counter template |
string |
priority |
The priority |
integer (int32) |
NotificationHistoriesDto
| Name | Description | Schema |
|---|---|---|
notificationHistory |
List of notification histories |
< NotificationHistoryDto > array |
NotificationHistoriesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
notificationHistories |
Notification histories information |
NotificationHistoryDto
| Name | Description | Schema |
|---|---|---|
notification |
The notification |
string |
entityClassName |
The entity class name |
string |
entityCode |
The entity code |
string |
serializedEntity |
The serialized entity |
string |
nbRetry |
The nb retry |
integer (int32) |
result |
Result of notification |
string |
date |
Date when this notification happened |
string (date-time) |
status |
enum (SENT, TO_RETRY, FAILED, CANCELED) |
InboundRequestDto
| Name | Description | Schema |
|---|---|---|
contentLength |
integer (int32) |
|
contentType |
The content type |
string |
protocol |
The protocol |
string |
scheme |
The scheme |
string |
remoteAddr |
The remote addr |
string |
remotePort |
The remote port |
integer (int32) |
method |
The method |
string |
authType |
The auth type |
string |
pathInfo |
The path info |
string |
requestURI |
The request URI |
string |
responseContentType |
The response content type |
string |
responseEncoding |
The response encoding |
string |
InboundRequestsDto
| Name | Description | Schema |
|---|---|---|
inboundRequest |
List of inbound requests |
< InboundRequestDto > array |
InboundRequestsResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
inboundRequests |
Inbound requests information |
GetNotificationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
notificationDto |
Notification information |
WebHookDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
classNameFilter |
The class name filter |
string |
eventTypeFilter |
Notification event type |
enum (CREATED, UPDATED, REMOVED, TERMINATED, DISABLED, PROCESSED, REJECTED, REJECTED_CDR, LOGGED_IN, INBOUND_REQ, ENABLED, LOW_BALANCE, FILE_UPLOAD, FILE_DOWNLOAD, FILE_RENAME, FILE_DELETE, COUNTER_DEDUCED, END_OF_TERM) |
elFilter |
The el filter |
string |
scriptInstanceCode |
Code of the script instance |
string |
scriptParams |
Map of script params |
< string, string > map |
counterTemplate |
The counter template |
string |
priority |
The priority |
integer (int32) |
httpProtocol |
The http protocol |
enum (HTTPS, HTTP) |
host |
The host |
string |
port |
The port |
integer (int32) |
page |
The page |
string |
httpMethod |
Http method |
enum (HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_DELETE) |
username |
The username |
string |
password |
The password |
string |
headers |
Map of headers |
< string, string > map |
params |
Map of params |
< string, string > map |
GetWebHookNotificationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
webhookDto |
Web hook information |
PersistedItem
| Name | Schema |
|---|---|
code |
string |
name |
string |
uuid |
string |
properties |
< string, object > map |
PaginationConfiguration
| Name | Schema |
|---|---|
firstRow |
integer (int32) |
numberOfRows |
integer (int32) |
randomize |
boolean |
fullTextFilter |
string |
filters |
< string, object > map |
sortOrdering |
< string, string > map |
fetchFields |
< string > array |
sortField |
string |
ordering |
enum (ASCENDING, DESCENDING, UNSORTED) |
graphQlQuery |
string |
sorted |
boolean |
ascendingSorting |
boolean |
orderings |
< string, string > map |
SqlConfigurationDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
driverClass |
The driver class use to load this datasource |
string |
url |
The url of this datasource. jdbc:postgresql://localhost:5432/meveo. |
string |
username |
This datasource’s username |
string |
password |
This datasource’s password |
string |
dialect |
The dialect, if supported |
string |
SqlConfigurationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
sqlConfiguration |
The sql configuration dto. |
SqlConfigurationsResponseDto
| Name | Schema |
|---|---|
actionStatus |
|
sqlConfigurations |
< SqlConfigurationDto > array |
BinaryStorageConfigurationDto
| Name | Description | Schema |
|---|---|---|
code |
Code of the binary storage |
string |
rootPath |
Root path |
string |
BinaryStorageConfigurationResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
binaryStorageConfiguration |
Binary storage configuration information |
BinaryStorageConfigurationsResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
binaryStorageConfigurations |
List of binary storage configurations information |
< BinaryStorageConfigurationDto > array |
RepositoryDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
sqlConfigurationCode |
string |
|
parentCode |
Code of the parent |
string |
binaryStorageConfigurationCode |
Code of the binary storage configuration |
string |
neo4jConfigurationCode |
Code of the neo4j configuration |
string |
dataSeparationType |
Data separation type |
enum (LOGICAL, PHYSICAL) |
path |
Physical ath |
string |
forceDelete |
Whether to delete the children of the repository |
boolean |
RepositoryResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
repository |
Repository information |
RepositoriesResponseDto
| Name | Description | Schema |
|---|---|---|
actionStatus |
||
repositories |
List of repositories information |
< RepositoryDto > array |
EndpointDto
| Name | Description | Schema |
|---|---|---|
active |
Whether this entity is active |
boolean |
code |
Business entity’s code |
string |
description |
Description of the business entity |
string |
updatedCode |
Use when updating the code of the business entity |
string |
serviceCode |
Code of the technical service |
string |
synchronous |
synchronous |
boolean |
method |
Http method of the endpoint |
enum (GET, DELETE, POST) |
parameterMappings |
Parameter mappings information |
< TSParameterMappingDto > array |
pathParameters |
List of endpoint path parameters |
< string > array |
roles |
Roles |
< string > array |
jsonataTransformer |
JSONata query to transform the serialized result |
string |
returnedVariableName |
Name of the returned context variable |
string |
serializeResult |
Whether to serialize the result of the endpoint |
boolean |
contentType |
Content type of the response |
string |
TSParameterMappingDto
| Name | Schema |
|---|---|
serviceParameter |
string |
multivalued |
string |
parameterName |
string |
defaultValue |
string |
valueRequired |
boolean |
WFActionDto
| Name | Description | Schema |
|---|---|---|
uuid |
workflow’s id |
string |
actionEl |
expression to trigger when condition is true |
string |
priority |
order of this action |
integer (int32) |
conditionEl |
expression to evaluate to trigger an action |
string |
WFDecisionRuleDto
| Name | Description | Schema |
|---|---|---|
name |
Name of the decision. Use for display. |
string |
value |
Value of the decision |
string |
WFTransitionDto
| Name | Description | Schema |
|---|---|---|
uuid |
id of this transition |
string |
fromStatus |
Status before the transition |
string |
toStatus |
Status after the transition |
string |
conditionEl |
Condition to perform this transition |
string |
priority |
Order in which to perform this transition |
integer (int32) |
description |
The description |
string |
listWFActionDto |
List of actions to perform |
< WFActionDto > array |
listWFDecisionRuleDto |
List of decision rules to execute |
< WFDecisionRuleDto > array |
WorkflowDto
| Name | Description | Schema |
|---|---|---|
code |
Code of workflow |
string |
description |
Description of workflow |
string |
wfType |
The type |
string |
enableHistory |
If history is save when executing this workflow |
boolean |
listWFTransitionDto |
List of transitions associated with this workflow |
< WFTransitionDto > array |
WorkflowsResponseDto
| Name | Schema |
|---|---|
actionStatus |
|
workflows |
< WorkflowDto > array |
WorkflowHistoryActionDto
| Name | Description | Schema |
|---|---|---|
action |
Action to perform |
string |
result |
Result of the action |
string |
WorkflowHistoryDto
| Name | Description | Schema |
|---|---|---|
actionDate |
Date when this action is executed |
string (date-time) |
workflowCode |
Code of workflow |
string |
entityInstanceCode |
Code of entity instance |
string |
fromStatus |
Status before the transition |
string |
toStatus |
Status after the transition |
string |
listWorkflowHistoryActionDto |
List of actions performed |
< WorkflowHistoryActionDto > array |
WorkflowHistoryResponseDto
| Name | Schema |
|---|---|
actionStatus |
|
workflowHistories |
< WorkflowHistoryDto > array |