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) |