Overview

Version information

Version : 6.9.0-SNAPSHOT

URI scheme

BasePath : /api/rest
Schemes : HTTP, HTTPS

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

Git

Manage git repositories

FunctionRs

GET /function/{code}

Parameters
Type Name Schema

Path

code
required

string

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Get samples function by code

GET /function/sample/code/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the function

string

Responses
HTTP Code Description Schema

200

successful operation

< Sample > array

Produces
  • application/json

GET /function

Parameters
Type Name Description Schema

Query

codeOnly
optional

Whether to retrieve only codes

boolean

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Test function

POST /function/{code}/test
Parameters
Type Name Description Schema

Path

code
required

Code of the function

string

Body

body
optional

Parameters to execute the function with

< string, object > map

Responses
HTTP Code Description Schema

200

successful operation

< string, object > map

Produces
  • application/json; charset=UTF-8

Update function

PATCH /function/{code}/test
Parameters
Type Name Description Schema

Path

code
required

Code of the function

string

Body

body
optional

Test suite file

file

Responses
HTTP Code Description Schema

default

successful operation

No Content

Start function by code

POST /function/{code}/job/start
Parameters
Type Name Description Schema

Path

code
required

Code of the function

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

OntologyRs

Finds a schema with the given filters

GET /ontology
Parameters
Type Name Description Schema Default

Query

onlyActivated
optional

Whether to only activated schema

boolean

"true"

Query

category
optional

Code of the category

string

Responses
HTTP Code Description Schema

200

successful operation

string

Produces
  • application/json

FilesRs

Upload file

POST /admin/files/upload
Parameters
Type Name Description Schema

Body

body
optional

Upload form

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • multipart/form-data

Create directory from where to list files

POST /admin/files/createDir
Parameters
Type Name Description Schema

Body

body
optional

Directory from where to list files

string

Responses
HTTP Code Description Schema

200

successful operation

Zip file

POST /admin/files/zipFile
Parameters
Type Name Description Schema

Body

body
optional

File to be zipped

string

Responses
HTTP Code Description Schema

200

successful operation

Zip directory

POST /admin/files/zipDirectory
Parameters
Type Name Description Schema

Body

body
optional

Directory to be zipped

string

Responses
HTTP Code Description Schema

200

successful operation

Rename folder

PUT /admin/files/renameFolder
Parameters
Type Name Description Schema

FormData

oldFolder
optional

Old folder

string

FormData

newFolder
optional

New folder

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/x-www-form-urlencoded

Download file

GET /admin/files/downloadFile
Parameters
Type Name Description Schema

Query

file
optional

File to be downloaded

string

Responses
HTTP Code Description Schema

200

successful operation

Suppress directory

POST /admin/files/suppressDirectory
Parameters
Type Name Description Schema

Body

body
optional

Directory to be suppressed

string

Responses
HTTP Code Description Schema

200

successful operation

Suppress file

POST /admin/files/suppressFile
Parameters
Type Name Description Schema

Body

body
optional

File to be suppressed

string

Responses
HTTP Code Description Schema

200

successful operation

List directory from where to list files

GET /admin/files
Parameters
Type Name Description Schema

Query

dir
optional

Directory from where to list files

string

Responses
HTTP Code Description Schema

200

successful operation

List of files

GET /admin/files/all
Responses
HTTP Code Description Schema

200

successful operation

CacheRs

Populate all caches

POST /caches/populate
Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Clean and popuplate a cache

POST /caches/{name}/refresh
Parameters
Type Name Description Schema

Path

name
required

Name of the cache to refresh

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Populate a cache

POST /caches/{name}/populate
Parameters
Type Name Description Schema

Path

name
required

Name of the cache to populate

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Clean and populate all caches

POST /caches/refresh
Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Count elements inside a cache

GET /caches/{name}/status
Parameters
Type Name Description Schema

Path

name
required

Name of the cache to count elements

string

Responses
HTTP Code Description Schema

200

successful operation

integer (int32)

Produces
  • application/json

Count elements by cache

GET /caches/status
Responses
HTTP Code Description Schema

200

successful operation

< string, integer (int32) > map

Produces
  • application/json

CommunicationRs

Inbound communication

POST /Communication/inbound
Parameters
Type Name Description Schema

Body

body
optional

Communication request information

Responses
HTTP Code Description Schema

200

successful operation

EmailTemplateRs

Create new or update an existing email template

POST /communication/emailTemplate/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Email template information

Responses
HTTP Code Description Schema

200

successful operation

Remove an email template

DELETE /communication/emailTemplate/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the email template

string

Responses
HTTP Code Description Schema

200

successful operation

Find an email template

GET /communication/emailTemplate
Parameters
Type Name Description Schema

Query

code
optional

Code of the email template

string

Responses
HTTP Code Description Schema

200

successful operation

Update email template information

PUT /communication/emailTemplate
Parameters
Type Name Description Schema

Body

body
optional

Email template information

Responses
HTTP Code Description Schema

200

successful operation

Create an email template

POST /communication/emailTemplate
Parameters
Type Name Description Schema

Body

body
optional

Email template information

Responses
HTTP Code Description Schema

200

successful operation

List email templates

GET /communication/emailTemplate/list
Responses
HTTP Code Description Schema

200

successful operation

MeveoInstanceRs

Create or update meveo instance information

POST /communication/meveoInstance/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Meveo instance information

Responses
HTTP Code Description Schema

200

successful operation

PUT /communication/meveoInstance/{code}/syncRepositories

Parameters
Type Name Schema

Path

code
required

string

Responses
HTTP Code Description Schema

200

successful operation

Remove meveo instance information

DELETE /communication/meveoInstance/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the meveo instance

string

Responses
HTTP Code Description Schema

200

successful operation

Find meveo instance information

GET /communication/meveoInstance
Parameters
Type Name Description Schema

Query

code
optional

Code of the meveo instance

string

Responses
HTTP Code Description Schema

200

successful operation

Update meveo instance information

PUT /communication/meveoInstance
Parameters
Type Name Description Schema

Body

body
optional

Meveo instance information

Responses
HTTP Code Description Schema

200

successful operation

Create meveo instance information

POST /communication/meveoInstance
Parameters
Type Name Description Schema

Body

body
optional

Meveo instance information

Responses
HTTP Code Description Schema

200

successful operation

List meveoInstances

GET /communication/meveoInstance/list
Responses
HTTP Code Description Schema

200

successful operation

MavenConfigurationRs

List of remote repositories

GET /mavenConfiguration/remoteRepository
Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

Create or update remote repository

POST /mavenConfiguration/remoteRepository
Parameters
Type Name Description Schema

Body

body
optional

Remote repository information

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

Get maven configuration

GET /mavenConfiguration
Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

Create or update maven configuration

POST /mavenConfiguration
Parameters
Type Name Description Schema

Body

body
optional

Maven configuration information

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

Upload a new artifact

POST /mavenConfiguration/upload
Parameters
Type Name Description Schema

Body

body
optional

Upload form

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

Remove remote repository by code

DELETE /mavenConfiguration/remoteRepository/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the remote repository

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

CustomEntityCategoryRs

Create or update custom entity category information

POST /customEntityCategory/entity/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom entity category information

Responses
HTTP Code Description Schema

200

successful operation

Remove custom entity category information by code

DELETE /customEntityCategory/entity/{customEntityCategoryCode}
Parameters
Type Name Description Schema Default

Path

customEntityCategoryCode
required

Code of the custom entity category

string

Query

deleteRelatedTemplates
optional

Whether to delete the related templates

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

Update custom entity category information

PUT /customEntityCategory/entity
Parameters
Type Name Description Schema

Body

body
optional

Custom entity category information

Responses
HTTP Code Description Schema

200

successful operation

Create a new custom entity category

POST /customEntityCategory/entity
Parameters
Type Name Description Schema

Body

body
optional

Custom entity category information

Responses
HTTP Code Description Schema

200

successful operation

Find custom entity category information

GET /customEntityCategory/entity/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the custom entity category

string

Responses
HTTP Code Description Schema

200

successful operation

List custom entity category information

POST /customEntityCategory/entity/list
Parameters
Type Name Description Schema

Body

body
optional

Paging and filtering information

Responses
HTTP Code Description Schema

200

successful operation

CustomEntityInstanceRs

Create or update code of the custom entity template

POST /customEntityInstance/{customEntityTemplateCode}/createOrUpdate
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Body

body
optional

Custom entity instance information

Responses
HTTP Code Description Schema

200

successful operation

Find custom entity template by code

GET /customEntityInstance/{customEntityTemplateCode}/{code}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Path

code
required

Code of the custom entity instance

string

Responses
HTTP Code Description Schema

200

successful operation

Delete custom entity template by code

DELETE /customEntityInstance/{customEntityTemplateCode}/{code}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Path

code
required

Code of the custom entity instance

string

Responses
HTTP Code Description Schema

200

successful operation

Update code of the custom entity template

PUT /customEntityInstance/{customEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Body

body
optional

Custom entity instance information

Responses
HTTP Code Description Schema

200

successful operation

Create code of the custom entity template

POST /customEntityInstance/{customEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Body

body
optional

Custom entity instance information

Responses
HTTP Code Description Schema

200

successful operation

List custom entity template

GET /customEntityInstance/list/{customEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity instance

string

Responses
HTTP Code Description Schema

200

successful operation

CustomFieldTemplateRs

Create or update custom field template information

POST /customFieldTemplate/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

Remove custom field template information

DELETE /customFieldTemplate/{customFieldTemplateCode}/{appliesTo}
Parameters
Type Name Description Schema

Path

customFieldTemplateCode
required

Code of the custom field template

string

Path

appliesTo
required

applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Find custom field template information

GET /customFieldTemplate
Parameters
Type Name Description Schema

Query

customFieldTemplateCode
optional

Code of the custom field template

string

Query

appliesTo
optional

applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Update existing custom field definition

PUT /customFieldTemplate
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

Create custom field template information

POST /customFieldTemplate
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

CustomRelationshipTemplateRs

Find custom relationship template information

GET /customRelationshipTemplate/relationship/{customCustomRelationshipTemplateCode}/{startCustomEntityTemplateCode}/{endCustomEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customCustomRelationshipTemplateCode
required

Code of the custom relationship template

string

Responses
HTTP Code Description Schema

200

successful operation

Remove custom relationship template information

DELETE /customRelationshipTemplate/relationship/{customCustomRelationshipTemplateCode}/{startCustomEntityTemplateCode}/{endCustomEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customCustomRelationshipTemplateCode
required

Code of the custom relationship template

string

Responses
HTTP Code Description Schema

200

successful operation

Create or update custom relationship template information

POST /customRelationshipTemplate/crt/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom relationship template information

Responses
HTTP Code Description Schema

200

successful operation

List custom relationship template information

GET /customRelationshipTemplate/relationship/list
Parameters
Type Name Description Schema

Query

customCustomRelationshipTemplateCode
optional

Code of the custom relationship template

string

Responses
HTTP Code Description Schema

200

successful operation

Update custom relationship template information

PUT /customRelationshipTemplate/relationship
Parameters
Type Name Description Schema

Body

body
optional

Custom relationship template information

Responses
HTTP Code Description Schema

200

successful operation

Create custom relationship template information

POST /customRelationshipTemplate/relationship
Parameters
Type Name Description Schema

Body

body
optional

Custom relationship template information

Responses
HTTP Code Description Schema

200

successful operation

Custom Table

List of custom table

POST /customTable/list/{customTableCode}
Parameters
Type Name Description Schema

Path

customTableCode
required

Code of the custom table

string

Body

body
optional

Paging and search criteria

Responses
HTTP Code Description Schema

200

successful operation

List of custom table

POST /customTable/relationship/list/{customTableCode}
Parameters
Type Name Description Schema

Path

customTableCode
required

Code of the custom table

string

Body

body
optional

Paging and search criteria

Responses
HTTP Code Description Schema

200

successful operation

EntityCustomizationRs

Find entity custom action information

GET /entityCustomization/action
Parameters
Type Name Description Schema

Query

actionCode
optional

Code of the entity action

string

Query

appliesTo
optional

Entity that action applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Update entity custom action information

PUT /entityCustomization/action
Parameters
Type Name Description Schema

Body

body
optional

Entity custom action information

Responses
HTTP Code Description Schema

200

successful operation

Create entity custom action information

POST /entityCustomization/action
Parameters
Type Name Description Schema

Body

body
optional

Entity custom action information

Responses
HTTP Code Description Schema

200

successful operation

Find custom field template information

GET /entityCustomization/field
Parameters
Type Name Description Schema

Query

customFieldTemplateCode
optional

Code of the custom field template

string

Query

appliesTo
optional

Entity custom field applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Update custom field template information

PUT /entityCustomization/field
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

Create custom field template information

POST /entityCustomization/field
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

Find custom entity template information

GET /entityCustomization/entity/{customEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Responses
HTTP Code Description Schema

200

successful operation

Remove custom entity template information

DELETE /entityCustomization/entity/{customEntityTemplateCode}
Parameters
Type Name Description Schema

Path

customEntityTemplateCode
required

Code of the custom entity template

string

Responses
HTTP Code Description Schema

200

successful operation

Update custom entity template information

PUT /entityCustomization/entity
Parameters
Type Name Description Schema

Body

body
optional

Custom entity template information

Responses
HTTP Code Description Schema

200

successful operation

Create custom entity template information

POST /entityCustomization/entity
Parameters
Type Name Description Schema

Body

body
optional

Custom entity template information

Responses
HTTP Code Description Schema

200

successful operation

List custom field template applies to the type of entity

GET /entityCustomization/entity/listELFiltered
Parameters
Type Name Description Schema

Query

appliesTo
optional

The custom field template applies to the type of entity

string

Query

entityCode
optional

Code of the entity

string

Responses
HTTP Code Description Schema

200

successful operation

Information of entity customization

PUT /entityCustomization/customize
Parameters
Type Name Description Schema

Body

body
optional

Entity customization information

Responses
HTTP Code Description Schema

200

successful operation

Find entity customized information

GET /entityCustomization/customize/{customizedEntityClass}
Parameters
Type Name Description Schema

Path

customizedEntityClass
required

Standard meveo entity class name

string

Responses
HTTP Code Description Schema

200

successful operation

List custom field template by code

GET /entityCustomization/listBusinessEntityForCFVByCode
Parameters
Type Name Description Schema

Query

code
optional

Code of the custom field template

string

Query

wildcode
optional

Code filter

string

Responses
HTTP Code Description Schema

200

successful operation

Remove custom field template information

DELETE /entityCustomization/field/{customFieldTemplateCode}/{appliesTo}
Parameters
Type Name Description Schema

Path

customFieldTemplateCode
required

Code of the custom field template

string

Path

appliesTo
required

Entity custom field applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Create or update custom entity template information

POST /entityCustomization/cet/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom entity template information

Responses
HTTP Code Description Schema

200

successful operation

List custom entity template information

GET /entityCustomization/entity/list
Parameters
Type Name Description Schema

Query

customEntityTemplateCode
optional

Code of the custom entity template

string

Responses
HTTP Code Description Schema

200

successful operation

Create or update custom field template information

POST /entityCustomization/field/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom field template information

Responses
HTTP Code Description Schema

200

successful operation

Delete entity custom action information

DELETE /entityCustomization/action/{actionCode}/{appliesTo}
Parameters
Type Name Description Schema

Path

actionCode
required

Code of the entity action

string

Path

appliesTo
required

Entity that action applies to

string

Responses
HTTP Code Description Schema

200

successful operation

Create or update entity custom action information

POST /entityCustomization/action/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Entity custom action information

Responses
HTTP Code Description Schema

200

successful operation

Create customized entity template information

POST /entityCustomization/entity/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Custom entity template information

Responses
HTTP Code Description Schema

200

successful operation

Execute

POST /entityCustomization/entity/action/execute/{actionCode}/{appliesTo}/{entityCode}
Parameters
Type Name Description Schema

Path

actionCode
required

Code of the action

string

Path

appliesTo
required

The action applies to the entity

string

Path

entityCode
required

Code of the entity

string

Responses
HTTP Code Description Schema

200

successful operation

Graph Query

Execute query of graphql in get

GET /graphql/{neo4jConfiguration}
Parameters
Type Name Description Schema

Path

neo4jConfiguration
required

string

Query

query
optional

Query of graphql

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Execute query of graphql in post

POST /graphql/{neo4jConfiguration}
Parameters
Type Name Description Schema

Path

neo4jConfiguration
required

string

Body

body
optional

Query of graphql

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/graphql

Produces
  • application/json

GET /graphql/{neo4jConfiguration}/idl

Parameters
Type Name Schema

Path

neo4jConfiguration
required

string

Responses
HTTP Code Description Schema

200

successful operation

string

POST /graphql/{neo4jConfiguration}/idl

Parameters
Type Name Schema

Path

neo4jConfiguration
required

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Neo4j Persistence

Persist entity data to be persisted

POST /neo4j/persist/entities
Parameters
Type Name Description Schema

Query

neo4jConfiguration
optional

string

Body

body
optional

Data to be persisted

< PersistenceDto > array

Responses
HTTP Code Description Schema

default

successful operation

No Content

Delete data to be persisted

DELETE /neo4j/persist
Parameters
Type Name Description Schema

Query

neo4jConfiguration
optional

string

Body

body
optional

Data to be persisted

< PersistenceDto > array

Responses
HTTP Code Description Schema

default

successful operation

No Content

ChartRs

Create or update char

POST /chart/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Chart information

Responses
HTTP Code Description Schema

200

successful operation

Update an existing bar chart

PUT /chart/bar
Parameters
Type Name Description Schema

Body

body
optional

Bar chart information

Responses
HTTP Code Description Schema

200

successful operation

Create a new bar chart

POST /chart/bar
Parameters
Type Name Description Schema

Body

body
optional

Bar chart information

Responses
HTTP Code Description Schema

200

successful operation

Update an existing pie chart

PUT /chart/pie
Parameters
Type Name Description Schema

Body

body
optional

Pie chart information

Responses
HTTP Code Description Schema

200

successful operation

Create pie chart

POST /chart/pie
Parameters
Type Name Description Schema

Body

body
optional

Pie chart information

Responses
HTTP Code Description Schema

200

successful operation

Update an existing line chart

PUT /chart/line
Parameters
Type Name Description Schema

Body

body
optional

Line chart information

Responses
HTTP Code Description Schema

200

successful operation

Create line chart

POST /chart/line
Parameters
Type Name Description Schema

Body

body
optional

Line chart information

Responses
HTTP Code Description Schema

200

successful operation

Find char by code

GET /chart
Parameters
Type Name Description Schema

Query

chartCode
optional

Code of the chart

string

Responses
HTTP Code Description Schema

200

successful operation

Update an existing chart

PUT /chart
Parameters
Type Name Description Schema

Body

body
optional

Chart information

Responses
HTTP Code Description Schema

200

successful operation

Create chart information

POST /chart
Parameters
Type Name Description Schema

Body

body
optional

Chart information

Responses
HTTP Code Description Schema

200

successful operation

Remove char by code

DELETE /chart
Parameters
Type Name Description Schema

Query

chartCode
optional

Code of the chart

string

Responses
HTTP Code Description Schema

200

successful operation

MeasurableQuantityRs

Find measurable quantity by date and period

GET /measurableQuantity/findMVByDateAndPeriod
Parameters
Type Name Description Schema

Query

code
optional

Code of mesurable value

string

Query

fromDate
optional

From date

string (date-time)

Query

toDate
optional

To date

string (date-time)

Query

period
optional

Period in which mesurable value is calculated

enum (DAILY, WEEKLY, MONTHLY, YEARLY)

Query

mqCode
optional

Code of the measureable quantity

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Remove measurable quantity by code

DELETE /measurableQuantity/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the measurable quantity

string

Responses
HTTP Code Description Schema

200

successful operation

Find measurable quantity by code

GET /measurableQuantity
Parameters
Type Name Description Schema

Query

code
optional

Code of the measureable quantity

string

Responses
HTTP Code Description Schema

200

successful operation

Update measurable quantity

PUT /measurableQuantity
Parameters
Type Name Description Schema

Body

body
optional

Measurable quantity information

Responses
HTTP Code Description Schema

200

successful operation

Create measurable quantity

POST /measurableQuantity
Parameters
Type Name Description Schema

Body

body
optional

Measurable quantity information

Responses
HTTP Code Description Schema

200

successful operation

List measurable quantity

GET /measurableQuantity/list
Responses
HTTP Code Description Schema

200

successful operation

FilteredListRs

List filter

POST /filteredList/listByFilter
Parameters
Type Name Description Schema

Body

body
optional

Filter information

Query

from
optional

Starting record

integer (int32)

Query

size
optional

Number of records per page

integer (int32)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Clean and reindex Elastic Search repository

GET /filteredList/reindex
Responses
HTTP Code Description Schema

default

successful operation

No Content

Search filter

GET /filteredList/fullSearch
Caution

operation.deprecated

Parameters
Type Name Description Schema

Query

query
optional

Query

string

Query

category
optional

Search by category

string

Query

from
optional

Starting record

integer (int32)

Query

size
optional

Number of records per page

integer (int32)

Query

sortField
optional

Sort the results of field

string

Query

sortOrder
optional

Sort ASC or DESC order of the results

enum (ASC, DESC)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Search filter by field

GET /filteredList/searchByField
Parameters
Type Name Description Schema

Query

classnamesOrCetCodes
optional

Entity classes to match

< string > array(multi)

Query

from
optional

Starting record

integer (int32)

Query

size
optional

Number of records per page

integer (int32)

Query

sortField
optional

Sort the results of field

string

Query

sortOrder
optional

Sort ASC or DESC order of the results

enum (ASC, DESC)

Responses
HTTP Code Description Schema

default

successful operation

No Content

GET /filteredList/search
Parameters
Type Name Description Schema

Query

classnamesOrCetCodes
optional

Entity classes to match

< string > array(multi)

Query

query
optional

Query

string

Query

from
optional

Starting record

integer (int32)

Query

size
optional

Number of records per page

integer (int32)

Query

sortField
optional

Sort the results of field

string

Query

sortOrder
optional

Sort ASC or DESC order of the results

enum (ASC, DESC)

Responses
HTTP Code Description Schema

default

successful operation

No Content

ReportExtractRs

Create or update report extract

POST /finance/reportExtracts/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Report extract information

Responses
HTTP Code Description Schema

200

successful operation

Run report extract

POST /finance/reportExtracts/run
Parameters
Type Name Description Schema

Body

body
optional

Run report extract information

Responses
HTTP Code Description Schema

200

successful operation

Find report extract by code

GET /finance/reportExtracts
Parameters
Type Name Description Schema

Query

reportExtractCode
optional

Code of the report extract

string

Responses
HTTP Code Description Schema

200

successful operation

Create report extract

POST /finance/reportExtracts
Parameters
Type Name Description Schema

Body

body
optional

Report extract information

Responses
HTTP Code Description Schema

200

successful operation

Remove report extract by code

DELETE /finance/reportExtracts
Parameters
Type Name Description Schema

Body

body
optional

Code of the report extract

string

Responses
HTTP Code Description Schema

200

successful operation

List of report extracts

GET /finance/reportExtracts/list
Responses
HTTP Code Description Schema

200

successful operation

GitRepositoryRs

List all existing repositories

GET /git/repositories
Responses
HTTP Code Description Schema

200

successful operation

< GitRepositoryDto > array

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Create a new repository

POST /git/repositories
Description

If branch is specified and does not exist, will create it

Parameters
Type Name Description Schema

Body

body
optional

Repository information

Query

username
optional

Username to connect to remote

string

Query

password
optional

Password to connect to remote

string

Query

branch
optional

Branch to checkout

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Pull changes from remote origin

POST /git/repositories/{code}/pull
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

username
optional

Username to use during pull

string

FormData

password
optional

Password to use during pull

string

Responses
HTTP Code Description Schema

200

If pull is successful

No Content

400

If repository has no remote

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

Create a branch

POST /git/repositories/{code}/branches/{branch}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to create

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Delete a branch

DELETE /git/repositories/{code}/branches/{branch}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to delte

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Checkout a branch

POST /git/repositories/{code}/branches/{branch}/checkout
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to checkout

string

Query

create
optional

Whether to create branch if it does not exist

boolean

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Retrieve one repository by code

GET /git/repositories/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

Upload a repository

PUT /git/repositories/{code}
Parameters
Type Name Description Schema

Body

body
optional

Upload form

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

  • text/csv

Update an existing repository

POST /git/repositories/{code}
Parameters
Type Name Description Schema

Body

body
optional

Repository information

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

200

If update is ok

No Content

404

If specified repository does not exists

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Remove a repository by code

DELETE /git/repositories/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Commit content of a repository

POST /git/repositories/{code}/commit
Description

Will commit every file if patterns is empty

Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

message
optional

Commit message

string

FormData

pattern
optional

Patterns of the files to commit

< string > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

Push the commit to remote origin

POST /git/repositories/{code}/push
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

username
optional

Username to use during push

string

FormData

password
optional

Password to use during push

string

Responses
HTTP Code Description Schema

200

If push is successful

No Content

400

If repository has no remote

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

Merge one branch into another

POST /git/repositories/{code}/branches/merge
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

source
required

Source branch of the merge

string

FormData

target
required

Target branch of the merge

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Export to a file

POST /git/export
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

file

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • text/csv

  • application/xml

  • application/json

Import from multiple files

POST /git/import
Parameters
Type Name Description Schema

Query

overwrite
optional

Whether to overwrite existing data

boolean

FormData

file
required

File contained serialized data

< file > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

  • text/csv

UserHierarchyLevelRs

Create or update user hierarchy level

POST /hierarchy/userGroupLevel/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

User hierarchy level information

Responses
HTTP Code Description Schema

200

successful operation

List get user hierarchy level

GET /hierarchy/userGroupLevel/list
Parameters
Type Name Description Schema Default

Query

query
optional

Query to search criteria

string

Query

fields
optional

Data retrieval options/fieldnames

string

Query

offset
optional

Offset from record number

integer (int32)

Query

limit
optional

Number of records to retrieve

integer (int32)

Query

sortBy
optional

Sort by a field

string

"code"

Query

sortOrder
optional

Sort order

enum (ASCENDING, DESCENDING)

"ASCENDING"

Responses
HTTP Code Description Schema

200

successful operation

List post user hierarchy level

POST /hierarchy/userGroupLevel/list
Parameters
Type Name Description Schema

Body

body
optional

Pagination and filtering criteria

Responses
HTTP Code Description Schema

200

successful operation

Remove user hierarchy level by code

DELETE /hierarchy/userGroupLevel/{hierarchyLevelCode}
Parameters
Type Name Description Schema

Path

hierarchyLevelCode
required

Code of the user hierarchy level

string

Responses
HTTP Code Description Schema

200

successful operation

Find user hierarchy level by code

GET /hierarchy/userGroupLevel
Parameters
Type Name Description Schema

Query

hierarchyLevelCode
optional

Code of the user hierarchy level

string

Responses
HTTP Code Description Schema

200

successful operation

Update user hierarchy level

PUT /hierarchy/userGroupLevel
Parameters
Type Name Description Schema

Body

body
optional

User hierarchy level information

Responses
HTTP Code Description Schema

200

successful operation

Create user hierarchy level

POST /hierarchy/userGroupLevel
Parameters
Type Name Description Schema

Body

body
optional

User hierarchy level information

Responses
HTTP Code Description Schema

200

successful operation

CalendarRs

Create or update calendar information

POST /calendar/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Calendar information

Responses
HTTP Code Description Schema

200

successful operation

Remove calendar information

DELETE /calendar/{calendarCode}
Parameters
Type Name Description Schema

Path

calendarCode
required

Code of the calendar

string

Responses
HTTP Code Description Schema

200

successful operation

Find calendar information

GET /calendar
Parameters
Type Name Description Schema

Query

calendarCode
optional

Code of the calendar

string

Responses
HTTP Code Description Schema

200

successful operation

Update calendar information

PUT /calendar
Parameters
Type Name Description Schema

Body

body
optional

Calendar information

Responses
HTTP Code Description Schema

200

successful operation

Create calendar information

POST /calendar
Parameters
Type Name Description Schema

Body

body
optional

Calendar information

Responses
HTTP Code Description Schema

200

successful operation

Retrieve a list of all calendars

GET /calendar/list
Responses
HTTP Code Description Schema

200

successful operation

CountryIsoRs

Create or update country iso information

POST /countryIso/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Country iso information

Responses
HTTP Code Description Schema

200

successful operation

Remove country iso information

DELETE /countryIso/{countryCode}
Parameters
Type Name Description Schema

Path

countryCode
required

Code of the country

string

Responses
HTTP Code Description Schema

200

successful operation

Find country iso information

GET /countryIso
Parameters
Type Name Description Schema

Query

countryCode
optional

Code of the country

string

Responses
HTTP Code Description Schema

200

successful operation

Update country iso information

PUT /countryIso
Parameters
Type Name Description Schema

Body

body
optional

Country iso information

Responses
HTTP Code Description Schema

200

successful operation

Create country iso information

POST /countryIso
Parameters
Type Name Description Schema

Body

body
optional

Country iso information

Responses
HTTP Code Description Schema

200

successful operation

List all countries

GET /countryIso/list
Responses
HTTP Code Description Schema

200

successful operation

CountryRs

Create or update country information

POST /country/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Country information

Responses
HTTP Code Description Schema

200

successful operation

Remove country information

DELETE /country/{countryCode}/{currencyCode}
Parameters
Type Name Description Schema

Path

countryCode
required

Code of the country

string

Path

currencyCode
required

Code of the currency

string

Responses
HTTP Code Description Schema

200

successful operation

Find country information

GET /country
Parameters
Type Name Description Schema

Query

countryCode
optional

Code of the country

string

Responses
HTTP Code Description Schema

200

successful operation

Update country information

PUT /country
Parameters
Type Name Description Schema

Body

body
optional

Country information

Responses
HTTP Code Description Schema

200

successful operation

Create country information

POST /country
Parameters
Type Name Description Schema

Body

body
optional

Country information

Responses
HTTP Code Description Schema

200

successful operation

CurrencyIsoRs

Create or update currency iso information

POST /currencyIso/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Currency iso information

Responses
HTTP Code Description Schema

200

successful operation

Remove currency iso information

DELETE /currencyIso/{currencyCode}
Parameters
Type Name Description Schema

Path

currencyCode
required

Code of the currency

string

Responses
HTTP Code Description Schema

200

successful operation

List all currencies

GET /currencyIso
Responses
HTTP Code Description Schema

200

successful operation

Update currency iso information

PUT /currencyIso
Parameters
Type Name Description Schema

Body

body
optional

Currency iso information

Responses
HTTP Code Description Schema

200

successful operation

Create currency iso information

POST /currencyIso
Parameters
Type Name Description Schema

Body

body
optional

Currency iso information

Responses
HTTP Code Description Schema

200

successful operation

CurrencyRs

Create or update currency information

POST /currency/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Currency information

Responses
HTTP Code Description Schema

200

successful operation

Remove currency information

DELETE /currency/{currencyCode}
Parameters
Type Name Description Schema

Path

currencyCode
required

Code of the currency

string

Responses
HTTP Code Description Schema

200

successful operation

Find currency information

GET /currency
Parameters
Type Name Description Schema

Query

currencyCode
optional

Code of the currency

string

Responses
HTTP Code Description Schema

200

successful operation

Update currency information

PUT /currency
Parameters
Type Name Description Schema

Body

body
optional

Currency information

Responses
HTTP Code Description Schema

200

successful operation

Create currency information

POST /currency
Parameters
Type Name Description Schema

Body

body
optional

Currency information

Responses
HTTP Code Description Schema

200

successful operation

FilterRs

Create or update filter

POST /filter/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Filter information

Responses
HTTP Code Description Schema

200

successful operation

Find filter by code

GET /filter
Parameters
Type Name Description Schema

Query

filterCode
optional

Code of the filter

string

Responses
HTTP Code Description Schema

200

successful operation

LanguageIsoRs

Create or update language iso

POST /languageIso/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Language iso information

Responses
HTTP Code Description Schema

200

successful operation

Remove language iso by code

DELETE /languageIso/{languageCode}
Parameters
Type Name Description Schema

Path

languageCode
required

Code of the language

string

Responses
HTTP Code Description Schema

200

successful operation

List all languages

GET /languageIso
Responses
HTTP Code Description Schema

200

successful operation

Update language iso

PUT /languageIso
Parameters
Type Name Description Schema

Body

body
optional

Language iso information

Responses
HTTP Code Description Schema

200

successful operation

Create language iso

POST /languageIso
Parameters
Type Name Description Schema

Body

body
optional

Language iso information

Responses
HTTP Code Description Schema

200

successful operation

LanguageRs

Create or update language

POST /language/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Language information

Responses
HTTP Code Description Schema

200

successful operation

Remove language by code

DELETE /language/{languageCode}
Parameters
Type Name Description Schema

Path

languageCode
required

Code of the language

string

Responses
HTTP Code Description Schema

200

successful operation

Find language by code

GET /language
Parameters
Type Name Description Schema

Query

languageCode
optional

Code of the language

string

Responses
HTTP Code Description Schema

200

successful operation

Update language

PUT /language
Parameters
Type Name Description Schema

Body

body
optional

Language information

Responses
HTTP Code Description Schema

200

successful operation

Create language

POST /language
Parameters
Type Name Description Schema

Body

body
optional

Language information

Responses
HTTP Code Description Schema

200

successful operation

MailerConfigurationRs

Create or update mailer configuration

POST /mailerConfiguration
Parameters
Type Name Description Schema

Body

body
optional

Mailer configuration information

Responses
HTTP Code Description Schema

200

successful operation

PermissionRs

Add to white list information

PUT /permission/whitelist
Parameters
Type Name Description Schema

FormData

permission
optional

Permission

string

FormData

id
optional

Id

string

FormData

role
optional

Role

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Remove from white list by permission and id and role

DELETE /permission/whitelist
Parameters
Type Name Description Schema

FormData

permission
optional

Permission

string

FormData

id
optional

Id

string

FormData

role
optional

Role

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Add to black list information

PUT /permission/blacklist
Parameters
Type Name Description Schema

FormData

permission
optional

Permission

string

FormData

id
optional

Id

string

FormData

role
optional

Role

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Remove from black list by permission and id and role

DELETE /permission/blacklist
Parameters
Type Name Description Schema

FormData

permission
optional

Permission

string

FormData

id
optional

Id

string

FormData

role
optional

Role

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

List of permissions

GET /permission/list
Responses
HTTP Code Description Schema

200

successful operation

ProviderRs

Create or update provider

POST /provider/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Provider information

Responses
HTTP Code Description Schema

200

successful operation

Remove tenant provider by code

DELETE /provider/{providerCode}
Parameters
Type Name Description Schema

Path

providerCode
required

Code of the provider

string

Responses
HTTP Code Description Schema

200

successful operation

Update provider cf

PUT /provider/updateProviderCF
Parameters
Type Name Description Schema

Body

body
optional

Provider information

Responses
HTTP Code Description Schema

200

successful operation

Find provider cf by code

GET /provider/findProviderCF
Parameters
Type Name Description Schema

Query

providerCode
optional

Code of the provider

string

Responses
HTTP Code Description Schema

200

successful operation

Create tenant provider

POST /provider/createTenant
Parameters
Type Name Description Schema

Body

body
optional

Provider information

Responses
HTTP Code Description Schema

200

successful operation

List tenants

GET /provider/listTenants
Responses
HTTP Code Description Schema

200

successful operation

Find provider by code

GET /provider
Parameters
Type Name Description Schema

Query

providerCode
optional

Code of the provider

string

Responses
HTTP Code Description Schema

200

successful operation

Update provider

PUT /provider
Parameters
Type Name Description Schema

Body

body
optional

Provider information

Responses
HTTP Code Description Schema

200

successful operation

Create provider

POST /provider
Parameters
Type Name Description Schema

Body

body
optional

Provider information

Responses
HTTP Code Description Schema

200

successful operation

RoleRs

Create or update role

POST /role/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Role information

Responses
HTTP Code Description Schema

200

successful operation

List external roles

GET /role/external
Responses
HTTP Code Description Schema

200

successful operation

List get role

GET /role/list
Parameters
Type Name Description Schema Default

Query

query
optional

Query to search criteria

string

Query

fields
optional

Data retrieval options/fieldnames

string

Query

offset
optional

Offset from record number

integer (int32)

Query

limit
optional

Number of records to retrieve

integer (int32)

Query

sortBy
optional

Sort by a field

string

"name"

Query

sortOrder
optional

Sort order

enum (ASCENDING, DESCENDING)

"ASCENDING"

Responses
HTTP Code Description Schema

200

successful operation

List post role

POST /role/list
Parameters
Type Name Description Schema

Body

body
optional

Pagination and filtering criteria

Responses
HTTP Code Description Schema

200

successful operation

Remove role by roleName

DELETE /role/{roleName}/{provider}
Parameters
Type Name Description Schema

Path

roleName
required

Name of the role

string

Responses
HTTP Code Description Schema

200

successful operation

Find role by roleName

GET /role
Parameters
Type Name Description Schema

Query

roleName
optional

Name of the role

string

Responses
HTTP Code Description Schema

200

successful operation

Update role

PUT /role
Parameters
Type Name Description Schema

Body

body
optional

Role information

Responses
HTTP Code Description Schema

200

successful operation

Create role

POST /role
Parameters
Type Name Description Schema

Body

body
optional

Role information

Responses
HTTP Code Description Schema

200

successful operation

ScriptInstanceRs

Create or update script instance

POST /scriptInstance/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

ScriptInstance information

Responses
HTTP Code Description Schema

200

successful operation

GET /scriptInstance/codes

Responses
HTTP Code Description Schema

200

successful operation

string

Produces
  • application/json

Remove script instance by code

DELETE /scriptInstance/{scriptInstanceCode}
Parameters
Type Name Description Schema

Path

scriptInstanceCode
required

Code of the script instance

string

Responses
HTTP Code Description Schema

200

successful operation

Find script instance by code

GET /scriptInstance
Parameters
Type Name Description Schema

Query

scriptInstanceCode
optional

Code of the script instance

string

Responses
HTTP Code Description Schema

200

successful operation

Update script instance

PUT /scriptInstance
Parameters
Type Name Description Schema

Body

body
optional

ScriptInstance information

Responses
HTTP Code Description Schema

200

successful operation

Create script instance

POST /scriptInstance
Parameters
Type Name Description Schema

Body

body
optional

ScriptInstance information

Responses
HTTP Code Description Schema

200

successful operation

UserRs

Create or update user

POST /user/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

User information

Responses
HTTP Code Description Schema

200

successful operation

Update external user

PUT /user/external
Parameters
Type Name Description Schema

Body

body
optional

User information

Responses
HTTP Code Description Schema

200

successful operation

Create external user

POST /user/external
Parameters
Type Name Description Schema

Body

body
optional

User information

Responses
HTTP Code Description Schema

200

successful operation

Remove external user by username

DELETE /user/external/{username}
Parameters
Type Name Description Schema

Path

username
required

The name of user

string

Responses
HTTP Code Description Schema

200

successful operation

Generate SH key by username

POST /user/ssh/generate
Parameters
Type Name Description Schema

Query

username
optional

Username to connect

string

Body

body
optional

Pass phrase

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • text/plain

List get user

GET /user/list
Parameters
Type Name Description Schema Default

Query

query
optional

Query to search criteria

string

Query

fields
optional

Data retrieval options/fieldnames

string

Query

offset
optional

Offset from record number

integer (int32)

Query

limit
optional

Number of records to retrieve

integer (int32)

Query

sortBy
optional

Sort by a field

string

"userName"

Query

sortOrder
optional

Sort order

enum (ASCENDING, DESCENDING)

"ASCENDING"

Responses
HTTP Code Description Schema

200

successful operation

List post user

POST /user/list
Parameters
Type Name Description Schema

Body

body
optional

Pagination and filtering criteria

Responses
HTTP Code Description Schema

200

successful operation

Remove user by username

DELETE /user/{username}
Parameters
Type Name Description Schema

Path

username
required

The name of user

string

Responses
HTTP Code Description Schema

200

successful operation

Find user by username

GET /user
Parameters
Type Name Description Schema

Query

username
optional

The name of user

string

Responses
HTTP Code Description Schema

200

successful operation

Update user

PUT /user
Parameters
Type Name Description Schema

Body

body
optional

User information

Responses
HTTP Code Description Schema

200

successful operation

Create user

POST /user
Parameters
Type Name Description Schema

Body

body
optional

User information

Responses
HTTP Code Description Schema

200

successful operation

ImportExportRs

Import data

POST /importExport/importData
Parameters
Type Name Description Schema

Body

body
optional

File containing a list of object for import

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • multipart/form-data

Check export data result

GET /importExport/checkImportDataResult
Parameters
Type Name Description Schema

Query

executionId
optional

The execution id

string

Responses
HTTP Code Description Schema

200

successful operation

JobInstanceRs

Create or update job instance

POST /jobInstance/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Job instance information

Responses
HTTP Code Description Schema

200

successful operation

Remove job instance by code

DELETE /jobInstance/{jobInstanceCode}
Parameters
Type Name Description Schema

Path

jobInstanceCode
required

Code of the job instance

string

Responses
HTTP Code Description Schema

200

successful operation

Update job instance

POST /jobInstance/update
Parameters
Type Name Description Schema

Body

body
optional

Job instance information

Responses
HTTP Code Description Schema

200

successful operation

Find job instance by code

GET /jobInstance
Parameters
Type Name Description Schema

Query

jobInstanceCode
optional

Code of the job instance

string

Responses
HTTP Code Description Schema

200

successful operation

Create job instance

POST /jobInstance/create
Parameters
Type Name Description Schema

Body

body
optional

Job instance information

Responses
HTTP Code Description Schema

200

successful operation

JobRs

Create or update job

POST /job/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Job instance info information

Responses
HTTP Code Description Schema

200

successful operation

Find job execution result by code

GET /job/jobReport
Parameters
Type Name Description Schema

Query

code
optional

Code of the job instance to match

string

Query

id
optional

A job execution result id

integer (int64)

Responses
HTTP Code Description Schema

200

successful operation

Find timer entity by code

GET /job/timer
Parameters
Type Name Description Schema

Query

timerCode
optional

Code of the time

string

Responses
HTTP Code Description Schema

200

successful operation

Update timer entity

PUT /job/timer
Parameters
Type Name Description Schema

Body

body
optional

Timer entity information

Responses
HTTP Code Description Schema

200

successful operation

Create timer entity

POST /job/timer
Parameters
Type Name Description Schema

Body

body
optional

Timer entity information

Responses
HTTP Code Description Schema

200

successful operation

Create or update timer entity

POST /job/timer/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Timer entity information

Responses
HTTP Code Description Schema

200

successful operation

Remove timer entity by code

DELETE /job/timer/{timerCode}
Parameters
Type Name Description Schema

Path

timerCode
required

Code of the time

string

Responses
HTTP Code Description Schema

200

successful operation

Remove job by code

DELETE /job/{jobInstanceCode}
Parameters
Type Name Description Schema

Path

jobInstanceCode
required

Code of the job instance

string

Responses
HTTP Code Description Schema

200

successful operation

Find job by code

GET /job
Parameters
Type Name Description Schema

Query

jobInstanceCode
optional

Code of the job instance

string

Responses
HTTP Code Description Schema

200

successful operation

Update job

PUT /job
Parameters
Type Name Description Schema

Body

body
optional

Job instance info information

Responses
HTTP Code Description Schema

200

successful operation

Execute job

POST /job/execute
Parameters
Type Name Description Schema

Body

body
optional

Job instance info information

Responses
HTTP Code Description Schema

200

successful operation

Create job

POST /job/create
Parameters
Type Name Description Schema

Body

body
optional

Job instance info information

Responses
HTTP Code Description Schema

200

successful operation

Stop job

POST /job/stop
Parameters
Type Name Description Schema

Path

jobInstanceCode
required

Code of the job instance

string

Responses
HTTP Code Description Schema

200

successful operation

TimerEntityRs

Create or update time entity

POST /timerEntity/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Time entity information

Responses
HTTP Code Description Schema

200

successful operation

Update time entity

POST /timerEntity/update
Parameters
Type Name Description Schema

Body

body
optional

Time entity information

Responses
HTTP Code Description Schema

200

successful operation

Find time entity by code

GET /timerEntity/{timerEntityCode}
Parameters
Type Name Description Schema

Path

timerEntityCode
required

Code of the timer entity

string

Responses
HTTP Code Description Schema

200

successful operation

Create time entity

POST /timerEntity/create
Parameters
Type Name Description Schema

Body

body
optional

Time entity information

Responses
HTTP Code Description Schema

200

successful operation

GET /timerEntity

Responses
HTTP Code Description Schema

200

successful operation

< TimerEntityDto > array

ModulePatchesRs

GET /module/patches

Parameters
Type Name Schema

Query

moduleCode
optional

string

Query

scriptInstanceCode
optional

string

Query

sourceVersion
optional

string

Query

targetVersion
optional

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

POST /module/patches

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

DELETE /module/patches/{moduleCode}/{scriptInstanceCode}/{sourceVersion}/{targetVersion}

Parameters
Type Name Schema

Path

moduleCode
required

string

Path

scriptInstanceCode
required

string

Path

sourceVersion
required

string

Path

targetVersion
required

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

GET /module/patches/{moduleCode}

Parameters
Type Name Schema

Path

moduleCode
required

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

ModuleRs

Create or update meveo module

POST /module/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Meveo module information

Responses
HTTP Code Description Schema

200

successful operation

Import from a zip

POST /module/importZip
Parameters
Type Name Description Schema

Body

body
optional

Upload module

Query

overwrite
optional

Whether to overwrite existing data

boolean

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Add to module

POST /module/{code}/items/add
Parameters
Type Name Description Schema

Path

code
required

Code of the module to modify

string

FormData

itemCode
optional

Code of the item to add

string

FormData

itemType
optional

Type of the item to add

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/x-www-form-urlencoded

Remove from module

POST /module/{code}/items/remove
Parameters
Type Name Description Schema

Path

code
required

Code of the module to modify

string

FormData

itemCode
optional

Code of the item to remove

string

FormData

itemType
optional

Type of the item to remove

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/x-www-form-urlencoded

Add file to module

POST /module/{code}/file/add
Parameters
Type Name Description Schema

Path

code
required

Code of the module to modify

string

FormData

path
optional

Path of file/folder to add

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/x-www-form-urlencoded

Remove from module

POST /module/{code}/file/remove
Parameters
Type Name Description Schema

Path

code
required

Code of the module to modify

string

FormData

path
optional

Path of file/folder to remove

string

Responses
HTTP Code Description Schema

200

successful operation

Consumes
  • application/x-www-form-urlencoded

Fork meveo module by code

PUT /module/fork/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the module

string

Responses
HTTP Code Description Schema

200

successful operation

release meveo module by code

POST /module/release/{code}/{nextVersion}
Parameters
Type Name Description Schema

Path

code
required

Code of the module

string

Path

nextVersion
required

next version meveo module

string

Responses
HTTP Code Description Schema

200

successful operation

Export to a file

GET /module/export
Parameters
Type Name Description Schema

Query

modulesCode
optional

List of the code meveo module

< string > array(multi)

Query

exportFormat
optional

Format of file

enum (JSON, XML, CSV)

Responses
HTTP Code Description Schema

200

successful operation

file

Instance meveo module

PUT /module/install
Parameters
Type Name Description Schema

Body

body
optional

Meveo module information

Responses
HTTP Code Description Schema

200

successful operation

Uninstall meveo module

GET /module/uninstall
Parameters
Type Name Description Schema Default

Query

code
optional

Code of the meveo module

string

Query

remove
optional

Whether to remove elements

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

Get meveo module by code

GET /module
Parameters
Type Name Description Schema

Query

code
optional

Code of the meveo module

string

Responses
HTTP Code Description Schema

200

successful operation

Update meveo module

PUT /module
Parameters
Type Name Description Schema

Body

body
optional

Meveo module information

Responses
HTTP Code Description Schema

200

successful operation

Create meveo module

POST /module
Parameters
Type Name Description Schema Default

Body

body
optional

Meveo module information

Query

development
optional

Whether to development meveo module

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

Remove meveo module by code

DELETE /module/{code}
Parameters
Type Name Description Schema Default

Path

code
required

Code of the module

string

Query

deleteFiles
optional

Delete the module files

boolean

"false"

Responses
HTTP Code Description Schema

200

successful operation

List meveo module

GET /module/list
Parameters
Type Name Description Schema

Query

codesOnly
optional

Whether to codes only for list of modules

boolean

Query

active
optional

Meveo module filters information

boolean

Query

downloaded
optional

Meveo module filters information

boolean

Query

itemCode
optional

Meveo module filters information

string

Query

itemType
optional

Meveo module filters information

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Enable meveo module

GET /module/enable
Parameters
Type Name Description Schema

Query

code
optional

Code of the meveo module

string

Responses
HTTP Code Description Schema

200

successful operation

Disable meveo module

GET /module/disable
Parameters
Type Name Description Schema

Query

code
optional

Code of the meveo module

string

Responses
HTTP Code Description Schema

200

successful operation

Neo4jConfigurationRs

Create or update neo4j configuration

POST /neo4j/configurations/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

Find neo4j configuration by code

GET /neo4j/configurations/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the binary storage

string

Responses
HTTP Code Description Schema

200

successful operation

Remove neo4j configuration by code

DELETE /neo4j/configurations/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the binary storage

string

Responses
HTTP Code Description Schema

200

successful operation

list of binary storages

GET /neo4j/configurations
Responses
HTTP Code Description Schema

200

successful operation

Update neo4j configuration

PUT /neo4j/configurations
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

Create neo4j configuration

POST /neo4j/configurations
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

JobTriggerRs

Create or update job trigger

POST /notification/jobTrigger/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Job trigger information

Responses
HTTP Code Description Schema

200

successful operation

Remove job trigger by code

DELETE /notification/jobTrigger/{notificationCode}
Parameters
Type Name Description Schema

Path

notificationCode
required

Code of the job trigger

string

Responses
HTTP Code Description Schema

200

successful operation

Find job trigger by code

GET /notification/jobTrigger
Parameters
Type Name Description Schema

Query

notificationCode
optional

Code of the job trigger

string

Responses
HTTP Code Description Schema

200

successful operation

Update job trigger

PUT /notification/jobTrigger
Parameters
Type Name Description Schema

Body

body
optional

Job trigger information

Responses
HTTP Code Description Schema

200

successful operation

Create job trigger

POST /notification/jobTrigger
Parameters
Type Name Description Schema

Body

body
optional

Job trigger information

Responses
HTTP Code Description Schema

200

successful operation

NotificationRs

Create or update notification

POST /notification/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Notification information

Responses
HTTP Code Description Schema

200

successful operation

GET /notification/listNotificationHistory

Responses
HTTP Code Description Schema

200

successful operation

GET /notification/listInboundRequest

Responses
HTTP Code Description Schema

200

successful operation

Remove notification by code

DELETE /notification/{notificationCode}
Parameters
Type Name Description Schema

Path

notificationCode
required

Code of the notification

string

Responses
HTTP Code Description Schema

200

successful operation

Find notification by code

GET /notification
Parameters
Type Name Description Schema

Query

notificationCode
optional

Code of the notification

string

Responses
HTTP Code Description Schema

200

successful operation

Update notification

PUT /notification
Parameters
Type Name Description Schema

Body

body
optional

Notification information

Responses
HTTP Code Description Schema

200

successful operation

Create notification

POST /notification
Parameters
Type Name Description Schema

Body

body
optional

Notification information

Responses
HTTP Code Description Schema

200

successful operation

WebHookNotificationRs

Create or update web hook notification

POST /notification/webhook/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Web hook information

Responses
HTTP Code Description Schema

200

successful operation

Remove web hook notification by code

DELETE /notification/webhook/{notificationCode}
Parameters
Type Name Description Schema

Path

notificationCode
required

Code of the web hook

string

Responses
HTTP Code Description Schema

200

successful operation

Find web hook notification by code

GET /notification/webhook
Parameters
Type Name Description Schema

Query

notificationCode
optional

Code of the web hook

string

Responses
HTTP Code Description Schema

200

successful operation

Update web hook notification

PUT /notification/webhook
Parameters
Type Name Description Schema

Body

body
optional

Web hook information

Responses
HTTP Code Description Schema

200

successful operation

Create web hook notification

POST /notification/webhook
Parameters
Type Name Description Schema

Body

body
optional

Web hook information

Responses
HTTP Code Description Schema

200

successful operation

PersistenceRs

List persistence

POST /{repository}/persistence
Parameters
Type Name Schema

Path

repository
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

< PersistedItem > array

Consumes
  • multipart/form-data

Produces
  • application/json

List data for a given CET

POST /{repository}/persistence/{cetCode}/examples
Parameters
Type Name Description Schema

Path

repository
required

string

Path

cetCode
required

Code of the custom entity template

string

Body

body
optional

Pagination configuration

Responses
HTTP Code Description Schema

200

successful operation

< < string, string > map > array

Produces
  • application/json

Get persistence

GET /{repository}/persistence/{cetCode}/{uuid}
Parameters
Type Name Description Schema

Path

repository
required

string

Header

Base64-Encode
optional

Base 64 encode

boolean

Path

cetCode
required

Code of the custom entity template

string

Path

uuid
required

uuid

string

Responses
HTTP Code Description Schema

200

successful operation

< string, object > map

Produces
  • application/json

Update persistence

PUT /{repository}/persistence/{cetCode}/{uuid}
Parameters
Type Name Description Schema

Path

repository
required

string

Path

cetCode
required

Code of the custom entity template

string

Path

uuid
required

uuid

string

Body

body
optional

Map of body

< string, object > map

Responses
HTTP Code Description Schema

default

successful operation

No Content

Delete persistence by cet code

DELETE /{repository}/persistence/{cetCode}/{uuid}
Parameters
Type Name Description Schema

Path

repository
required

string

Path

cetCode
required

Code of the custom entity template

string

Path

uuid
required

uuid

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

List data for a given CET

POST /{repository}/persistence/{cetCode}/list
Parameters
Type Name Description Schema

Path

repository
required

string

Header

Base64-Encode
optional

Base 64 encode

boolean

Path

cetCode
required

Code of the custom entity template

string

Body

body
optional

Pagination configuration information

Responses
HTTP Code Description Schema

200

successful operation

< < string, object > map > array

Produces
  • application/json

SqlConfigurationRs

Create new or update an existing sqlConfiguration

POST /sql/configurations/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Data source configuration info

Responses
HTTP Code Description Schema

200

successful operation

Search for sqlConfiguration with a given code

GET /sql/configurations/{code}
Parameters
Type Name Description Schema

Path

code
required

code of the connection

string

Responses
HTTP Code Description Schema

200

successful operation

Removes an existing sqlConfiguration with a given code

DELETE /sql/configurations/{code}
Parameters
Type Name Description Schema

Path

code
required

code of the connection

string

Responses
HTTP Code Description Schema

200

successful operation

List sql configuration

GET /sql/configurations
Responses
HTTP Code Description Schema

200

successful operation

Update an existing sqlConfiguration

PUT /sql/configurations
Parameters
Type Name Description Schema

Body

body
optional

Data source configuration info

Responses
HTTP Code Description Schema

200

successful operation

Create a new sqlConfiguration

POST /sql/configurations
Parameters
Type Name Description Schema

Body

body
optional

Data source configuration info

Responses
HTTP Code Description Schema

200

successful operation

Initializes custom tables for the given configuration

POST /sql/configurations/{code}/initialize
Parameters
Type Name Description Schema

Path

code
required

Code of the configuration to initialize

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Export to a file

POST /sql/configurations/export
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

file

Produces
  • text/csv

  • application/xml

  • application/json

Import from multiple files

POST /sql/configurations/import
Parameters
Type Name Description Schema

Query

overwrite
optional

Whether to overwrite existing data

boolean

FormData

file
required

File contained serialized data

< file > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

BinaryStorageConfigurationRs

Create or update binary storage

POST /storages/binaries/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

Find binary storage by code

GET /storages/binaries/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the binary storage

string

Responses
HTTP Code Description Schema

200

successful operation

Remove binary storage by code

DELETE /storages/binaries/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the binary storage

string

Responses
HTTP Code Description Schema

200

successful operation

List of binary storages

GET /storages/binaries
Responses
HTTP Code Description Schema

200

successful operation

Update binary storage

PUT /storages/binaries
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

Create binary storage

POST /storages/binaries
Parameters
Type Name Description Schema

Body

body
optional

Binary storage information

Responses
HTTP Code Description Schema

200

successful operation

Export to a file

POST /storages/binaries/export
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

file

Produces
  • text/csv

  • application/xml

  • application/json

Import from multiple files

POST /storages/binaries/import
Parameters
Type Name Description Schema

Query

overwrite
optional

Whether to overwrite existing data

boolean

FormData

file
required

File contained serialized data

< file > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

FileSystemRs

Find binary by index and code repository and code cet and uuid and code cft

GET /fileSystem/binaries/{repositoryCode}/{cetCode}/{uuid}/{cftCode}
Parameters
Type Name Description Schema

Query

index
optional

Index

integer (int32)

Path

repositoryCode
required

Code of the repository

string

Path

cetCode
required

Code of the custom entity template

string

Path

uuid
required

uuid

string

Path

cftCode
required

Code of the custom field template

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Repository

Create or update repository

POST /storages/repositories/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Repository information

Responses
HTTP Code Description Schema

200

successful operation

Find repository by code

GET /storages/repositories/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

200

successful operation

Remove repository by code

DELETE /storages/repositories/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Query

forceDelete
optional

Whether to delete the children of the repository

boolean

Responses
HTTP Code Description Schema

200

successful operation

List of repositorys

GET /storages/repositories
Responses
HTTP Code Description Schema

200

successful operation

Update repository

PUT /storages/repositories
Parameters
Type Name Description Schema

Body

body
optional

Repository information

Responses
HTTP Code Description Schema

200

successful operation

Create repository

POST /storages/repositories
Parameters
Type Name Description Schema

Body

body
optional

Repository information

Responses
HTTP Code Description Schema

200

successful operation

Export to a file

POST /storages/repositories/export
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

file

Produces
  • text/csv

  • application/xml

  • application/json

Import from multiple files

POST /storages/repositories/import
Parameters
Type Name Description Schema

Query

overwrite
optional

Whether to overwrite existing data

boolean

FormData

file
required

File contained serialized data

< file > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

EndpointRs

Generates and returns the request schema of a given endpoint.

GET /endpoint/schema/{code}/request
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

200

successful operation

string

GET /endpoint

Parameters
Type Name Schema

Query

service
optional

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

PUT /endpoint

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

default

successful operation

No Content

POST /endpoint

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

default

successful operation

No Content

Generate open api json of the endpoint

GET /endpoint/openApi/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Generates and returns the response schema of a given endpoint.

GET /endpoint/schema/{code}/response
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

200

successful operation

string

Find endpoint by code

GET /endpoint/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

Delete endpoint

DELETE /endpoint/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Check exist an endpoint

HEAD /endpoint/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Get script of the endpoint

GET /endpoint/{code}.js
Parameters
Type Name Description Schema

Path

code
required

Code of the endpoint

string

Responses
HTTP Code Description Schema

200

successful operation

string

Produces
  • application/javascript

WorkflowRs

Create or update workflow

POST /admin/workflow/createOrUpdate
Parameters
Type Name Description Schema

Body

body
optional

Workflow information

Responses
HTTP Code Description Schema

200

successful operation

Find workflow by entity

GET /admin/workflow/findByEntity
Parameters
Type Name Description Schema

Query

baseEntityName
optional

Name of the base entity

string

Responses
HTTP Code Description Schema

200

successful operation

Find history workflow by code and from status and to status

GET /admin/workflow/history
Parameters
Type Name Description Schema

Query

entityInstanceCode
optional

Code of the entity instance

string

Query

workflowCode
optional

Code of the workflow

string

Query

fromStatus
optional

From status

string

Query

toStatus
optional

To status

string

Responses
HTTP Code Description Schema

200

successful operation

Remove workflow by code

DELETE /admin/workflow/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the workflow

string

Responses
HTTP Code Description Schema

200

successful operation

Find workflow by code

GET /admin/workflow
Parameters
Type Name Description Schema

Query

code
optional

Code of the workflow

string

Responses
HTTP Code Description Schema

200

successful operation

Update workflow

PUT /admin/workflow
Parameters
Type Name Description Schema

Body

body
optional

Workflow information

Responses
HTTP Code Description Schema

200

successful operation

Create workflow

POST /admin/workflow
Parameters
Type Name Description Schema

Body

body
optional

Workflow information

Responses
HTTP Code Description Schema

200

successful operation

Execute workflow

POST /admin/workflow/execute
Parameters
Type Name Description Schema

Query

baseEntityName
optional

Name of the base entity

string

Query

entityInstanceCode
optional

Code of the entity instance

string

Query

workflowCode
optional

Code of the workflow

string

Responses
HTTP Code Description Schema

200

successful operation

GET /admin/workflow/list

Responses
HTTP Code Description Schema

200

successful operation

Definitions

FunctionDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

testSuite
optional

Name of test suite

string

inputs
optional

Input parameters

< FunctionIO > array

outputs
optional

List of outputs

< FunctionIO > array

samples
optional

Example input / outputs

< Sample > array

generateOutputs
optional

Whether to generate outputs or not

boolean

FunctionIO

Name Schema

name
optional

string

type
optional

string

description
optional

string

Sample

Name Schema

inputs
optional

< string, object > map

outputs
optional

< string, object > map

ActionStatus

Name Description Schema

status
optional

Status of the api response

enum (SUCCESS, FAIL)

errorCode
optional

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
optional

Message return by an api request

string

getjson
optional

string

FileUploadForm

Name Schema

data
optional

< string (byte) > array

filename
optional

string

FileDto

Name Description Schema

name
optional

Physical file name in the system

string

lastModified
optional

Last date this file is modified

string (date-time)

directory
optional

boolean

GetFilesResponseDto

Name Description Schema

actionStatus
optional

files
optional

List of files information

< FileDto > array

CommunicationRequestDto

Name Description Schema

meveoInstanceCode
required

Code of the meveo instance

string

macAddress
required

Mac address of the meveo instance

string

subject
required

Subject of the meveo instance

string

body
optional

Body of the meveo instance

string

additionnalInfo1
optional

Additionnal info 1

string

additionnalInfo2
optional

Additionnal info 2

string

additionnalInfo3
optional

Additionnal info 3

string

additionnalInfo4
optional

Additionnal info 4

string

vaild
optional

boolean

EmailTemplateDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

media
optional

The type of message channel

enum (POSTAL_MAIL, EMAIL, SMS, IM, FAX, VOICE, WEBSERVICE, QUEUE, FTP_FILE, CFT_FILE, DATABASE)

tagStartDelimiter
optional

Use to parse an expression language

string

tagEndDelimiter
optional

End of the expression language

string

startDate
optional

Start date

string (date-time)

endDate
optional

End date

string (date-time)

type
optional

Template for this message

enum (DUNNING, INVOICE, OTHER)

subject
required

Subject of the email

string

htmlContent
optional

Html content of the email

string

textContent
optional

Text content of the email

string

EmailTemplateResponseDto

Name Schema

actionStatus
optional

emailTemplate
optional

EmailTemplatesResponseDto

Name Schema

actionStatus
optional

emailTemplates
optional

< EmailTemplateDto > array

MeveoInstanceDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

productName
optional

The product name

string

productVersion
optional

The product version

string

owner
optional

The owner

string

md5
optional

The md 5

string

status
optional

The status

enum (UNKNOWN, PARENT, CHILD, PARTNER)

creationDate
optional

The creation date

string (date-time)

updateDate
optional

The update date

string (date-time)

keyEntreprise
optional

The key entreprise

string

macAddress
optional

The mac address

string

machineVendor
optional

The machine vendor

string

installationMode
optional

The installation mode

string

nbCores
optional

The nb cores

string

memory
optional

The memory

string

hdSize
optional

The hd size

string

osName
optional

The os name

string

osVersion
optional

The os version

string

osArch
optional

The os arch

string

javaVmVersion
optional

The java vm version

string

javaVmName
optional

The java vm name

string

javaVendor
optional

The java vendor

string

javaVersion
optional

The java version

string

asVendor
optional

The as vendor

string

asVersion
optional

The as version

string

url
required

The url

string

authUsername
optional

The auth username

string

authPassword
optional

The auth password

string

user
optional

The user

string

customer
optional

The customer

string

MeveoInstanceResponseDto

Name Schema

actionStatus
optional

meveoInstance
optional

MeveoInstancesResponseDto

Name Description Schema

actionStatus
optional

meveoInstances
optional

List of meveo instances information

< MeveoInstanceDto > array

RemoteRepositoryDto

Name Description Schema

code
optional

Code of remote repisitory

string

url
optional

The url of remote repisitory

string

MavenConfigurationDto

Name Description Schema

mavenExecutablePath
optional

Maven executable path

string

mavenRepositories
optional

List of maven repositories

< string > array

InputStream

Type : object

MavenConfigurationUploadForm

Name Description Schema

data
optional

Zipped maven content

filename
optional

string

groupId
optional

string

artifactId
optional

string

version
optional

string

classifier
optional

string

MavenConfigurationResponseDto

Name Description Schema

actionStatus
optional

mavenConfiguration
optional

Maven configuration information

RemoteRepositoriesRespondseDto

Name Description Schema

actionStatus
optional

remoteRepositories
optional

List of remote repositories information

CustomEntityCategoryDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

name
required

Name of the custom entity category

string

CustomEntityCategoryResponseDto

Name Description Schema

actionStatus
optional

customEntityCategory
optional

Custom entity category information

CustomEntityCategoriesResponseDto

Name Description Schema

actionStatus
optional

paging
optional

customEntityCategories
optional

List of custom entity categories

PagingAndFiltering

Name Description Schema

fullTextFilter
optional

Full text search filter

string

filters
optional

Search filters

< string, object > map

fields
optional

Data retrieval options/fieldnames separated by a comma

string

offset
optional

Offset from record number

integer (int32)

limit
optional

Number of items to retrieve

integer (int32)

sortBy
optional

Sort by a field

string

sortOrder
optional

Sort order

enum (ASCENDING, DESCENDING)

totalNumberOfRecords
optional

Total number of records

integer (int32)

CustomEntityInstanceDto

Name Description Schema

code
required

Code of the custom entity instance

string

description
optional

Description of the custom entity instance

string

cetCode
required

Code of the custom entity template

string

disabled
optional

Whether to disable

boolean

customFields
optional

Custom fields information

CustomFieldDto

Name Description Schema

code
required

Code use as the identity of this entity

string

valueDate
optional

The date value

string (date-time)

valuePeriodStartDate
optional

Period’s start date

string (date-time)

valuePeriodEndDate
optional

Period’s end date

string (date-time)

valuePeriodPriority
optional

Period’s priority

integer (int32)

stringValue
optional

String value

string

dateValue
optional

Date value

integer (int64)

longValue
optional

Long value

integer (int64)

doubleValue
optional

Double value

number (double)

listValue
optional

List value

mapValue
optional

Map value

< string, CustomFieldValueDto > map

entityReferenceValue
optional

Entity reference value

valueConverted
optional

A transient object. Contains a converted value from DTO to some object when it is applicable

object

indexType
optional

The type of index

enum (STORE_ONLY, INDEX, STORE_ONLY_NEO4J, INDEX_NEO4J, INDEX_NOT_ANALYZE)

booleanValue
optional

Boolean value

boolean

empty
optional

boolean

CustomFieldValueDto

Name Description Schema

value
optional

Object value representation of the custom field value

object

empty
optional

boolean

CustomFieldsDto

Name Schema

customField
optional

< CustomFieldDto > array

inheritedCustomField
optional

< CustomFieldDto > array

empty
optional

boolean

EntityReferenceDto

Name Description Schema

classname
required

Classname of this entity

string

code
required

Code of this entity

string

id
required

Id of this entity

integer (int64)

empty
optional

boolean

CustomEntityInstanceResponseDto

Name Description Schema

actionStatus
optional

customEntityInstance
optional

Custom entity instance information

CustomEntityInstancesResponseDto

Name Description Schema

actionStatus
optional

customEntityInstances
optional

List of custom entity instances

CustomFieldMatrixColumnDto

Name Description Schema

columnUse
required

The column use

enum (USE_KEY, USE_VALUE)

position
required

Display position

integer (int32)

code
required

Unique field for this entity
Length : 0 - 20

string

label
required

Display label
Length : 0 - 50

string

keyType
required

Type of key for this matrix

enum (STRING, TEXT_AREA, LONG, DOUBLE, RON)

CustomFieldTemplateDto

Name Description Schema

code
required

Code of the custom field template

string

description
required

Description of the custom field template

string

languageDescriptions
optional

List of language descriptions information

fieldType
required

Value type

enum (STRING, DATE, LONG, DOUBLE, LIST, ENTITY, TEXT_AREA, CHILD_ENTITY, MULTI_VALUE, EXPRESSION, BOOLEAN, EMBEDDED_ENTITY, BINARY)

accountLevel
optional

The account level

string

appliesTo
optional

Applies to

string

defaultValue
optional

Default value

string

useInheritedAsDefaultValue
optional

Whether to inherit value be used as default value instead if available

boolean

storageType
required

Value storage type

enum (SINGLE, LIST, MAP, MATRIX)

valueRequired
optional

Whether to require value

boolean

versionable
optional

Whether to versionable value

boolean

triggerEndPeriodEvent
optional

Whether to fire Period end event when value period is over

boolean

calendar
optional

Calendar associated to value versioning periods

string

cacheValueTimeperiod
optional

Cache value time period

integer (int32)

entityClazz
optional

Entity class and CET code for a reference to entity or child entity type fields

string

listValues
optional

List of values for LIST type field

< string, string > map

allowEdit
optional

Whether to change value when editing a previously saved entity

boolean

hideOnNew
optional

Whether to do not show/apply field on new entity creation

boolean

maxValue
optional

Maximum value to validate long and double values

integer (int64)

minValue
optional

Minimum value to validate long and double values

integer (int64)

regExp
optional

Regular expression to validate string values

string

cacheValue
optional

Whether to cache value

boolean

contentTypes
optional

List of content types

< string > array

fileExtensions
optional

List of file extensions

< string > array

maxFileSizeAllowedInKb
optional

Max files size allowed in kb

integer (int64)

filePath
optional

File path

string

saveOnExplorer
optional

Whether to save on explorer

boolean

guiPosition
optional

Gui position

string

relationshipName
optional

Name of relationship

string

relationship
optional

Code of relationship

string

expressionSeparator
optional

Expression separator

string

identifier
optional

Whether we can use this field as the identifier of the entity

boolean

mapKeyType
optional

Key format of a map for map type fields

enum (STRING, TEXT_AREA, LONG, DOUBLE, RON)

applicableOnEl
optional

EL expression to evaluate when field is applicable

string

storages
optional

List of storage types

< enum (SQL, NEO4J) > array

samples
optional

List of samples

< string > array

summary
optional

Whether to summary

boolean

indexType
optional

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
optional

Tags assigned to custom field template

string

displayFormat
optional

Display format

string

unique
optional

Whether to unique

boolean

entityClazzCetCode
optional

string

filter
optional

Whether to filter

boolean

matrixColumns
optional

A list of columns matrix consists of

childEntityFieldsForSummary
optional

A list of child entity fields to be displayed in a summary table of child entities

< string > array

LanguageDescriptionDto

Name Description Schema

languageCode
optional

The language code

string

description
optional

The description

string

GetCustomFieldTemplateReponseDto

Name Description Schema

actionStatus
optional

customFieldTemplate
optional

Custom field template information

CustomRelationshipTemplateDto

Name Description Schema

code
required

Code of the custom relationship template

string

name
optional

Name of the custom relationship template

string

description
optional

Description of the custom relationship template

string

direction
optional

Relationship direction type

enum (OUTGOING, INCOMING, BIDIRECTIONAL)

startNodeKeys
optional

List of start node keys

< string > array

endNodeKeys
optional

List of end node keys

< string > array

availableStorages
optional

List of available storages where the custom relationship instances should be stored

< enum (SQL, NEO4J) > array

sourceNameSingular
optional

Name of the field that will be added to the source entity to refer the most recent target entity

string

sourceNamePlural
optional

Name of the field that will be added to the source entity to refer every target entities

string

targetNameSingular
optional

Name of the field that will be added to the target entity to refer the most recent source entity

string

targetNamePlural
optional

Name of the field that will be added to the target entity to refer every source entities

string

graphQlTypeName
optional

Name of graphQl type

string

unique
optional

boolean

fields
optional

List of custom fields information

startNodeCode
required

Start node code

string

endNodeCode
required

End node code

string

CustomRelationshipTemplateResponseDto

Name Description Schema

actionStatus
optional

customRelationshipTemplate
optional

Custom relationship template information

CustomRelationshipTemplatesResponseDto

Name Description Schema

actionStatus
optional

customRelationshipTemplates
optional

List of custom relationship templates information

CustomTableDataDto

Name Description Schema

sqlConnectionCode
optional

Code of SqlConnection

string

customTableCode
optional

Custom table/custom entity (or relation) template code

string

overwrite
optional

Should data be overwritten (deleted all data first) instead of appended to existing values. Defaults to false if omitted.

boolean

records
optional

A list of values with field name as map’s key and field value as map’s value

CustomTableDataResponseDto

Name Description Schema

actionStatus
optional

paging
optional

customTableData
optional

Search within custom table results

CustomTableRecordDto

Name Description Schema

values
optional

Hashmap of values

< string, object > map

EntityCustomActionDto

Name Description Schema

code
required

Code of entity custom action

string

description
optional

Description of entity custom action

string

appliesTo
optional

Entity action applies to

string

applicableOnEl
optional

EL expression when action button should be visible.

string

label
optional

Button label

string

labelsTranslated
optional

Button label translations

script
optional

Script instance information

guiPosition
optional

Gui position

string

MavenDependencyDto

Name Description Schema

groupId
optional

The groupId

string

artifactId
optional

The artifactId

string

version
optional

The version

string

classifier
optional

The classifier

string

coordinates
optional

The coordinates

string

PermissionDto

Name Description Schema

permission
optional

The permission. Should be a very or prefix with a verb.

string

name
optional

The name use to identify this permission

string

RoleDto

Name Description Schema

name
required

Name of the role

string

description
optional

Description of the role

string

permission
optional

List of permissions information

< PermissionDto > array

roles
optional

List of roles information

< RoleDto > array

ScriptInstanceDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

testSuite
optional

Name of test suite

string

inputs
optional

Input parameters

< FunctionIO > array

outputs
optional

List of outputs

< FunctionIO > array

samples
optional

Example input / outputs

< Sample > array

generateOutputs
optional

Whether to generate outputs or not

boolean

type
optional

enum (JAVA, ES5)

script
required

string

executionRoles
optional

The execution roles.

< RoleDto > array

sourcingRoles
optional

The sourcing roles

< RoleDto > array

error
optional

Whether the script has compilation errors

boolean

mavenDependencies
optional

The maven dependencies

< MavenDependencyDto > array

importScriptInstances
optional

The import script instances

< ScriptInstanceDto > array

CustomEntityTemplateDto

Name Description Schema

code
required

Code of custom entity template

string

superTemplate
optional

Super template

string

name
required

Name of custom entity template

string

description
optional

Description of custom entity template

string

prePersistScripCode
optional

Code of the pre-persist script instance

string

customEntityCategoryCode
optional

Code of the custom entity category

string

availableStorages
optional

List of storages where cfts can be stored

< enum (SQL, NEO4J) > array

neo4jStorageConfiguration
optional

Neo4J storage configuration information

sqlStorageConfiguration
optional

SQL storage configuration

samples
optional

List of samples

< string > array

fields
optional

List of custom field templates information

actions
optional

List of entity custom actions information

CustomEntityTemplateUniqueConstraintDto

Name Description Schema

code
required

The code of this dto

string

appliesTo
optional

Applies this template to this entity’s code

string

description
required

Desscription of this dto

string

cypherQuery
required

Cypher query for this entity

string

trustScore
optional

Trust store for this entity

integer (int32)

applicableOnEl
optional

Applies this unique constraint using this EL expression.

string

order
required

Order value use when sorting a list of this entity

integer (int32)

GraphQLQueryField

Name Schema

fieldName
optional

string

fieldType
optional

string

multivalued
optional

boolean

query
optional

string

Mutation

Name Schema

code
optional

string

parameters
optional

< string, string > map

cypherQuery
optional

string

Neo4JStorageConfigurationDto

Name Schema

labels
optional

< string > array

primitiveEntity
optional

boolean

primitiveType
optional

enum (STRING, DATE, LONG, DOUBLE)

graphqlQueryFields
optional

< GraphQLQueryField > array

mutations
optional

< Mutation > array

uniqueConstraints
optional

SQLStorageConfiguration

Name Schema

storeAsTable
required

boolean

EntityCustomizationDto

Name Description Schema

classname
required

The classname

string

fields
optional

List of custom field templates information

actions
optional

List of entity custom actions information

EntityCustomizationResponseDto

Name Description Schema

actionStatus
optional

entityCustomization
optional

Entity customization information

BusinessEntityDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

BusinessEntityResponseDto

Name Schema

actionStatus
optional

businessEntities
optional

< BusinessEntityDto > array

CustomEntityTemplateResponseDto

Name Description Schema

actionStatus
optional

customEntityTemplate
optional

Custom entity template information

CustomEntityTemplatesResponseDto

Name Description Schema

actionStatus
optional

customEntityTemplates
optional

List of custom entity templates

EntityCustomActionResponseDto

Name Schema

actionStatus
optional

entityAction
optional

GraphQLRequest

Name Schema

query
optional

string

operationName
optional

string

variables
optional

< string, object > map

PersistenceDto

Name Description Schema

discriminator
optional

Type of the object to persist

string

source
optional

Source of relation

string

target
optional

Target of relation

string

type
optional

Type of the relation or entity

string

name
optional

Unique name of the entity in the given context

string

properties
optional

Map of properties to attach to the object, key references the CFT code

< string, object > map

ChartDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

measurableQuantity
optional

Measurable quantity information

width
optional

The width

string

height
optional

The height

string

style
optional

The style

string

styleClass
optional

The style class

string

extender
optional

The extender

string

visible
optional

Whether to visible

boolean

MeasurableQuantityDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

theme
optional

The theme

string

dimension1
optional

The dimension 1

string

dimension2
optional

The dimension 2

string

dimension3
optional

The dimension 3

string

dimension4
optional

The dimension 14

string

editable
optional

The editable

boolean

additive
optional

The additive

boolean

sqlQuery
optional

The sql query

string

cypherQuery
optional

The cypher query

string

measurementPeriod
optional

The measurement period

enum (DAILY, WEEKLY, MONTHLY, YEARLY)

lastMeasureDate
optional

The last measure date

integer (int64)

codeOnly
optional

boolean

BarChartDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

measurableQuantity
optional

Measurable quantity information

width
optional

The width

string

height
optional

The height

string

style
optional

The style

string

styleClass
optional

The style class

string

extender
optional

The extender

string

visible
optional

Whether to visible

boolean

legendPosition
optional

The legend position

enum (n, s, e, w)

barPadding
optional

The bar padding

integer (int32)

barMargin
optional

The bar margin

integer (int32)

orientation
optional

The orientation

enum (vertical, horizontal)

stacked
optional

Enables stacked display of bars

boolean

min
optional

Minimum boundary value

number (double)

max
optional

Maximum boundary value

number (double)

breakOnNull
optional

Whether line segments should be broken at null value

boolean

xaxisLabel
optional

The xaxis label

string

yaxisLabel
optional

The yaxis label

string

xaxisAngle
optional

Angle of the x-axis ticks

integer (int32)

yaxisAngle
optional

The yaxis angle

integer (int32)

legendCols
optional

The legend cols

integer (int32)

legendRows
optional

The legend rows

integer (int32)

zoom
optional

Enables plot zooming

boolean

animate
optional

Enables animation on plot rendering

boolean

showDataTip
optional

Defines visibility of datatip

boolean

datatipFormat
optional

Template string for datatips

string

PieChartDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

measurableQuantity
optional

Measurable quantity information

width
optional

The width

string

height
optional

The height

string

style
optional

The style

string

styleClass
optional

The style class

string

extender
optional

The extender

string

visible
optional

Whether to visible

boolean

filled
optional

The filled

boolean

legendPosition
optional

The legend position

enum (n, s, e, w)

seriesColors
optional

The series colors

string

diameter
optional

The diameter

integer (int32)

sliceMargin
optional

The slice margin

integer (int32)

shadow
optional

The shadow

boolean

showDataLabels
optional

The show data labels

boolean

legendCols
optional

The legend cols

integer (int32)

legendRows
optional

The legend rows

integer (int32)

LineChartDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

measurableQuantity
optional

Measurable quantity information

width
optional

The width

string

height
optional

The height

string

style
optional

The style

string

styleClass
optional

The style class

string

extender
optional

The extender

string

visible
optional

Whether to visible

boolean

filled
optional

The filled

boolean

legendPosition
optional

The legend position

enum (n, s, e, w)

seriesColors
optional

The series colors

string

shadow
optional

The shadow

boolean

minX
optional

The min X

integer (int32)

maxX
optional

The max X

integer (int32)

minY
optional

The min Y

integer (int32)

maxY
optional

The max Y

integer (int32)

breakOnNull
optional

Whether line segments should be broken at null value

boolean

xaxisLabel
optional

The xaxis label

string

yaxisLabel
optional

The yaxis label

string

xaxisAngle
optional

Angle of the x-axis ticks

integer (int32)

yaxisAngle
optional

The yaxis angle

integer (int32)

stacked
optional

Whether to stack series

boolean

zoom
optional

Enables plot zooming

boolean

animate
optional

Enables animation on plot rendering

boolean

showDataTip
optional

Defines visibility of datatip

boolean

datatipFormat
optional

Template string for datatips

string

legendCols
optional

The legend cols

integer (int32)

legendRows
optional

The legend rows

integer (int32)

GetChartResponse

Name Description Schema

actionStatus
optional

chartDto
optional

Chart information

GetMeasurableQuantityResponse

Name Description Schema

actionStatus
optional

measurableQuantityDto
optional

Measurable quantity information

GetListMeasurableQuantityResponse

Name Description Schema

actionStatus
optional

listMeasurableQuantityDto
optional

List of measurable quantities information

FilterDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

shared
optional

Whether this filter is shared

boolean

inputXml
optional

The input xml

string

ReportExtractDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

scriptType
required

The script type

enum (JAVA, SQL)

filenameFormat
required

The filename format

string

category
optional

The category

string

scriptInstanceCode
optional

Code of the script instance

string

sqlQuery
optional

The sql query

string

params
optional

Map of params

< string, string > map

startDate
optional

The start date

string (date-time)

endDate
optional

The end date

string (date-time)

RunReportExtractDto

Name Description Schema

code
required

The code

string

params
optional

Map of params

< string, string > map

ReportExtractResponseDto

Name Description Schema

actionStatus
optional

reportExtract
optional

Report extract information

ReportExtractsResponseDto

Name Description Schema

actionStatus
optional

reportExtracts
optional

List of report extracts information

< ReportExtractDto > array

GitRepositoryDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

readingRoles
optional

List of reading roles that allows a user to make pull, fetch and clone actions

< string > array

writingRoles
optional

List of writing roles that allows a user to make commit, merge and push actions

< string > array

remoteOrigin
optional

Remote origin url if the repository is hosted somewhere else than locally

string

remoteUsername
optional

Remote username to use when making action with distant repository

string

remotePassword
optional

Remote password to use when making action with distant repository

string

meveoRepository
optional

Whether the remote repository is hosted in a meveo instance

boolean

currentBranch
optional
read-only

string

branches
optional
read-only

< string > array

remote
optional

boolean

GitRepositoryUploadForm

Name Description Schema

data
optional

Zipped repository content

repository
optional

Repository information

UserHierarchyLevelDto

Name Description Schema

code
required

The code

string

description
optional

The description

string

parentLevel
optional

The parent level

string

childLevels
optional

List of user hierarchy levels information

orderLevel
optional

The order level

integer (int64)

UserHierarchyLevelsDto

Name Description Schema

actionStatus
optional

paging
optional

userHierarchyLevels
optional

List of user hierarchy levels information

UserHierarchyLevelResponseDto

Name Description Schema

actionStatus
optional

userHierarchyLevel
optional

User hierarchy level information

CalendarDateIntervalDto

Name Description Schema

intervalBegin
optional

Beginning interval

integer (int32)

intervalEnd
optional

Ending interval

integer (int32)

CalendarDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

calendarType
required

Calendar type

enum (YEARLY, DAILY, PERIOD, INTERVAL, INTERSECT, UNION)

days
optional

List of days in year

< DayInYearDto > array

hours
optional

List of hours in day

< HourInDayDto > array

periodLength
optional

Period length

integer (int32)

periodUnit
optional

Period measurement unit

enum (MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND)

nbPeriods
optional

Number of periods

integer (int32)

joinCalendar1Code
optional

Code of the first calendar to intersect/union

string

joinCalendar2Code
optional

Code of the second calendar to intersect/union

string

intervalType
optional

Calendar interval type

enum (DAY, HOUR, WDAY)

intervals
optional

List of intervals

DayInYearDto

Name Description Schema

day
required

Day value

integer (int32)

month
required

Month value of this object

enum (JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER)

HourInDayDto

Name Description Schema

hour
required

The hour

integer (int32)

min
required

The min

integer (int32)

GetCalendarResponse

Name Description Schema

actionStatus
optional

calendar
optional

Calendar information

CalendarsDto

Name Description Schema

calendar
optional

List of calendar information

< CalendarDto > array

ListCalendarResponse

Name Description Schema

actionStatus
optional

calendars
optional

List of calendars information

CountryIsoDto

Name Description Schema

countryCode
required

Code of the country

string

description
optional

Description of the country

string

nationality
optional

The nationality

string

languageDescriptions
optional

List of language descriptions information

currencyCode
required

Code of the currency

string

languageCode
required

Code of the language

string

GetCountryIsoResponse

Name Description Schema

actionStatus
optional

country
optional

Country information

GetCountriesIsoResponse

Name Description Schema

actionStatus
optional

countries
optional

List of countries information

< CountryIsoDto > array

CountryDto

Name Description Schema

countryCode
required

Code of the country

string

name
optional

Name of the country

string

currencyCode
required

Code of the currency

string

languageCode
optional

Code of the language

string

GetCountryResponse

Name Description Schema

actionStatus
optional

country
optional

Country information

CurrencyIsoDto

Name Description Schema

code
required

Code of the currency

string

description
optional

Description of the currency

string

GetCurrencyIsoResponse

Name Description Schema

actionStatus
optional

currency
optional

Currency information

GetCurrenciesIsoResponse

Name Description Schema

actionStatus
optional

currencies
optional

List of currencies information

< CurrencyIsoDto > array

CurrencyDto

Name Description Schema

code
required

Code of the currency

string

description
optional

Description of the currency

string

GetCurrencyResponse

Name Description Schema

actionStatus
optional

currency
optional

Currency information

GetFilterResponseDto

Name Description Schema

actionStatus
optional

filter
optional

Filter information

LanguageIsoDto

Name Description Schema

code
required

Code of the language

string

description
optional

Description of the language

string

GetLanguageIsoResponse

Name Description Schema

actionStatus
optional

language
optional

Language information

GetLanguagesIsoResponse

Name Description Schema

actionStatus
optional

languages
optional

List of languages information

< LanguageIsoDto > array

LanguageDto

Name Description Schema

code
required

Code of the language

string

description
optional

Description of the language

string

GetLanguageResponse

Name Description Schema

actionStatus
optional

language
optional

Language information

MailerConfigurationDto

Name Description Schema

host
required

The host

string

port
required

The port

integer (int32)

userName
required

The user name

string

password
required

The password

string

tls
required

The tls

boolean

PermissionResponseDto

Name Description Schema

actionStatus
optional

permissionsDto
optional

Permissions information

PermissionsDto

Name Description Schema

permission
optional

List of permissions

< PermissionDto > array

ProviderDto

Name Description Schema

code
required

Code of the provider

string

description
optional

The description

string

currency
optional

The currency

string

country
optional

The country

string

language
optional

The country

string

multiCurrency
optional

The multi currency

boolean

multiCountry
optional

The multi country

boolean

multiLanguage
optional

The multi language

boolean

userAccount
optional

The user account

string

enterprise
optional

The enterprise

boolean

levelDuplication
optional

The level duplication

boolean

rounding
optional

The rounding

integer (int32)

prepaidReservationExpirationDelayinMillisec
optional

The prepaid reservation expiration delayin millisec

integer (int64)

discountAccountingCode
optional

Code of the discount accounting

string

email
optional

The email

string

recognizeRevenue
optional

The recognize revenue

boolean

customFields
optional

Custom fields information

GetProviderResponse

Name Description Schema

actionStatus
optional

provider
optional

Provider information

ProvidersDto

Name Description Schema

actionStatus
optional

paging
optional

providers
optional

List of providers information

< ProviderDto > array

RolesDto

Name Description Schema

actionStatus
optional

paging
optional

roles
optional

List of roles information

< RoleDto > array

GetRoleResponse

Name Description Schema

actionStatus
optional

roleDto
optional

Role information

ScriptInstanceErrorDto

Name Description Schema

lineNumber
optional

The line number

integer (int64)

columnNumber
optional

The column number

integer (int64)

message
required

string

ScriptInstanceReponseDto

Name Description Schema

actionStatus
optional

compilationErrors
optional

The compilation errors

GetScriptInstanceResponseDto

Name Description Schema

actionStatus
optional

scriptInstance
optional

Script instance information

SecuredEntityDto

Name Description Schema

code
required

Code of this entity

string

entityClass
required

The entity class

string

UserDto

Name Description Schema

username
required

The username

string

password
optional

Password used when creating keycloak user

string

email
required

The email

string

firstName
optional

The first name

string

lastName
optional

The last name

string

roles
optional

List of roles

< string > array

externalRoles
optional

The external roles

< RoleDto > array

securedEntities
optional

The secured entities

< SecuredEntityDto > array

role
optional

The role

string

userLevel
optional

The user level

string

createdAt
optional

The created at

string (date-time)

lastLoginDate
optional

The last login date

string (date-time)

sshPrivateKey
optional

Ssh private key

string

sshPublicKey
optional

Ssh public key

string

RSAKeyPair

Name Schema

privateKey
optional

string

publicKey
optional

string

UsersDto

Name Description Schema

actionStatus
optional

paging
optional

users
optional

List of users information

< UserDto > array

GetUserResponse

Name Description Schema

actionStatus
optional

user
optional

User information

FieldsNotImportedStringCollectionDto

Name Schema

fieldsNotImported
optional

< string > array

ImportExportResponseDto

Name Description Schema

actionStatus
optional

executionId
optional

The execution id

string

summary
optional

Summary of entities imported/exported per entity class

< string, integer (int32) > map

fieldsNotImported
optional

Stores a list of field names that were not imported because of differences between original and current model

exceptionMessage
optional

Occurred exception message

string

failureMessage
optional

string

failureMessageKey
optional

string

done
optional

boolean

failed
optional

boolean

InputPart

Name Schema

bodyAsString
optional

string

mediaType
optional

headers
optional

< string, < string > array > map

contentTypeFromMessage
optional

boolean

MediaType

Name Schema

type
optional

string

subtype
optional

string

parameters
optional

< string, string > map

wildcardSubtype
optional

boolean

wildcardType
optional

boolean

MultipartFormDataInput

Name Schema

formDataMap
optional

< string, < InputPart > array > map

formData
optional

< string, InputPart > map

preamble
optional

string

parts
optional

< InputPart > array

JobInstanceDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

jobCategory
required

Job category type

enum (RATING, INVOICING, IMPORT_HIERARCHY, DWH, ACCOUNT_RECEIVABLES, WALLET, UTILS, MEDIATION, EXPORT, TEST)

jobTemplate
required

Job template

string

followingJob
optional

Following job to execute

string

parameter
optional

Parameter to job execution

string

customFields
optional

Custom fields information

timerCode
optional

Job scheduling timer code

string

runOnNodes
optional

What cluster nodes job could/should run on

string

limitToSingleNode
optional

Limit to single node

boolean

JobInstanceResponseDto

Name Description Schema

actionStatus
optional

jobInstanceDto
optional

Contains job instance information

JobExecutionResultDto

Name Description Schema

id
required

Job execution result identifier.

integer (int64)

jobInstanceId
optional

Job instance identifier

integer (int64)

runningOnNodes
optional

Nodes that job is CURRENTLY running.

string

startDate
optional

Job start date

string (date-time)

endDate
optional

Job end date

string (date-time)

nbItemsToProcess
optional

Number of items to process

integer (int64)

nbItemsCorrectlyProcessed
required

Number of items that were processed correctly

integer (int64)

nbItemsProcessedWithWarning
required

Number of items that were processed with warning

integer (int64)

nbItemsProcessedWithError
required

Number of items that were not processed due to some error

integer (int64)

done
required

Is job execution done - if False, job should be repeated again to finish processing

boolean

report
optional

Jon execution report/summary

string

jobInstanceCode
optional

JobInstance code

string

JobExecutionResultResponseDto

Name Description Schema

actionStatus
optional

jobExecutionResultDto
optional

Contains job execution result information

TimerEntityDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

hour
required

The hour

string

minute
required

The minute

string

second
required

The second

string

year
required

The year

string

month
required

The month

string

dayOfMonth
required

The day of month

string

dayOfWeek
required

The day of week

string

TimerEntityResponseDto

Name Description Schema

actionStatus
optional

timerEntity
optional

Timer entity information

JobInstanceInfoDto

Name Description Schema

timerName
optional

The timer name

string

code
required

Code of job instance info

string

lastTransactionDate
optional

The last transaction date

string (date-time)

invoiceDate
optional

The invoice date

string (date-time)

billingCycle
optional

The billing cycle

string

forceExecution
optional

Ignore a check if job is currently running and launch it anyway

boolean

GetTimerEntityResponseDto

Name Description Schema

actionStatus
optional

timerEntity
optional

Timer entity information

MeveoModulePatchDto

Name Description Schema

moduleCode
required

The module code

string

scriptInstance
required

Script executed before and after this patch is applied.

sourceVersion
required

This patch can be apply from this version
Pattern : "^(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$"

string

targetVersion
required

This patch can be apply up to this version
Pattern : "^(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$"

string

MeveoModuleDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

license
required

The license type

enum (APACHE, BSD3_N, BSD3_R, BSD2_S, FREE_BSD, GPL, AGPL, LGPL, MIT, MOZ, CDDL, EPL, OPEN, COM)

logoPicture
optional

The logo picture

string

logoPictureFile
optional

The logo picture file

< string (byte) > array

script
optional

Script instance information

currentVersion
optional

The current version

string

meveoVersionBase
optional

The meveo version base
Pattern : "^(?<major>\\d+\\.)?(?<minor>\\d+\\.)?(?<patch>\\*|\\d+)$"

string

meveoVersionCeiling
optional

The meveo version ceiling
Pattern : "^(?<major>\\d+\\.)?(?<minor>\\d+\\.)?(?<patch>\\*|\\d+)$"

string

codeOnly
optional

boolean

inDraft
optional

boolean

transient
optional

boolean

moduleItems
optional

List of module items information

< MeveoModuleItemDto > array

moduleDependencies
optional

List of module dependencies information

patches
optional

List of patch linked to this module

moduleFiles
optional

The module files

< string > array

MeveoModuleItemDto

Name Description Schema

dtoClassName
required

Simple class name to of this module

string

dtoData
required

Linked list value representation of this object when module is uninstalled. Otherwise, it represents the object.

object

ModuleDependencyDto

Name Description Schema

code
required

The module code

string

description
required

The module description

string

currentVersion
required

The current version

string

ModuleUploadForm

Name Description Schema

data
optional

Zipped module with files

filename
optional

string

MeveoModuleDtoResponse

Name Description Schema

actionStatus
optional

module
optional

Module information

Neo4jConfigurationDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

neo4jUrl
optional

Neo4j url

string

neo4jLogin
optional

Neo4j login

string

neo4jPassword
optional

Neo4j password

string

Neo4jConfigurationResponseDto

Name Description Schema

actionStatus
optional

neo4jConfiguration
optional

Neo4j configuration information

Neo4jConfigurationsResponseDto

Name Description Schema

actionStatus
optional

neo4jConfigurations
optional

List of neo4j configurations information

JobTriggerDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

classNameFilter
required

The class name filter

string

eventTypeFilter
required

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
optional

The el filter

string

scriptInstanceCode
optional

Code of the script instance

string

scriptParams
optional

Map of script params

< string, string > map

counterTemplate
optional

The counter template

string

priority
optional

The priority

integer (int32)

jobParams
optional

Map of job params

< string, string > map

jobInstance
required

The job instance

string

GetJobTriggerResponseDto

Name Description Schema

actionStatus
optional

jobTriggerDto
optional

Job trigger information

NotificationDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

classNameFilter
required

The class name filter

string

eventTypeFilter
required

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
optional

The el filter

string

scriptInstanceCode
optional

Code of the script instance

string

scriptParams
optional

Map of script params

< string, string > map

counterTemplate
optional

The counter template

string

priority
optional

The priority

integer (int32)

NotificationHistoriesDto

Name Description Schema

notificationHistory
optional

List of notification histories

NotificationHistoriesResponseDto

Name Description Schema

actionStatus
optional

notificationHistories
optional

Notification histories information

NotificationHistoryDto

Name Description Schema

notification
optional

The notification

string

entityClassName
optional

The entity class name

string

entityCode
optional

The entity code

string

serializedEntity
optional

The serialized entity

string

nbRetry
optional

The nb retry

integer (int32)

result
optional

Result of notification

string

date
optional

Date when this notification happened

string (date-time)

status
optional

enum (SENT, TO_RETRY, FAILED, CANCELED)

InboundRequestDto

Name Description Schema

contentLength
optional

integer (int32)

contentType
optional

The content type

string

protocol
optional

The protocol

string

scheme
optional

The scheme

string

remoteAddr
optional

The remote addr

string

remotePort
optional

The remote port

integer (int32)

method
optional

The method

string

authType
optional

The auth type

string

pathInfo
optional

The path info

string

requestURI
optional

The request URI

string

responseContentType
optional

The response content type

string

responseEncoding
optional

The response encoding

string

InboundRequestsDto

Name Description Schema

inboundRequest
optional

List of inbound requests

< InboundRequestDto > array

InboundRequestsResponseDto

Name Description Schema

actionStatus
optional

inboundRequests
optional

Inbound requests information

GetNotificationResponseDto

Name Description Schema

actionStatus
optional

notificationDto
optional

Notification information

WebHookDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

classNameFilter
required

The class name filter

string

eventTypeFilter
required

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
optional

The el filter

string

scriptInstanceCode
optional

Code of the script instance

string

scriptParams
optional

Map of script params

< string, string > map

counterTemplate
optional

The counter template

string

priority
optional

The priority

integer (int32)

httpProtocol
optional

The http protocol

enum (HTTPS, HTTP)

host
required

The host

string

port
required

The port

integer (int32)

page
required

The page

string

httpMethod
required

Http method

enum (HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_DELETE)

username
optional

The username

string

password
optional

The password

string

headers
optional

Map of headers

< string, string > map

params
optional

Map of params

< string, string > map

GetWebHookNotificationResponseDto

Name Description Schema

actionStatus
optional

webhookDto
optional

Web hook information

PersistedItem

Name Schema

code
optional

string

name
optional

string

uuid
optional

string

properties
optional

< string, object > map

PaginationConfiguration

Name Schema

firstRow
optional

integer (int32)

numberOfRows
optional

integer (int32)

randomize
optional

boolean

fullTextFilter
optional

string

filters
optional

< string, object > map

sortOrdering
optional

< string, string > map

fetchFields
optional

< string > array

sortField
optional

string

ordering
optional

enum (ASCENDING, DESCENDING, UNSORTED)

graphQlQuery
optional

string

sorted
optional

boolean

ascendingSorting
optional

boolean

orderings
optional

< string, string > map

SqlConfigurationDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

driverClass
optional

The driver class use to load this datasource

string

url
optional

The url of this datasource. jdbc:postgresql://localhost:5432/meveo.

string

username
optional

This datasource’s username

string

password
optional

This datasource’s password

string

dialect
optional

The dialect, if supported

string

SqlConfigurationResponseDto

Name Description Schema

actionStatus
optional

sqlConfiguration
optional

The sql configuration dto.

SqlConfigurationsResponseDto

Name Schema

actionStatus
optional

sqlConfigurations
optional

BinaryStorageConfigurationDto

Name Description Schema

code
required

Code of the binary storage
Length : 0 - 255

string

rootPath
required

Root path
Length : 0 - 255

string

BinaryStorageConfigurationResponseDto

Name Description Schema

actionStatus
optional

binaryStorageConfiguration
optional

Binary storage configuration information

BinaryStorageConfigurationsResponseDto

Name Description Schema

actionStatus
optional

binaryStorageConfigurations
optional

List of binary storage configurations information

RepositoryDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

sqlConfigurationCode
optional

string

parentCode
optional

Code of the parent

string

binaryStorageConfigurationCode
optional

Code of the binary storage configuration

string

neo4jConfigurationCode
optional

Code of the neo4j configuration

string

dataSeparationType
optional

Data separation type

enum (LOGICAL, PHYSICAL)

path
optional

Physical ath

string

forceDelete
optional

Whether to delete the children of the repository

boolean

RepositoryResponseDto

Name Description Schema

actionStatus
optional

repository
optional

Repository information

RepositoriesResponseDto

Name Description Schema

actionStatus
optional

repositories
optional

List of repositories information

< RepositoryDto > array

EndpointDto

Name Description Schema

active
optional

Whether this entity is active

boolean

code
required

Business entity’s code

string

description
optional

Description of the business entity

string

updatedCode
optional

Use when updating the code of the business entity

string

serviceCode
required

Code of the technical service

string

synchronous
required

synchronous

boolean

method
required

Http method of the endpoint

enum (GET, DELETE, POST)

parameterMappings
required

Parameter mappings information

pathParameters
optional

List of endpoint path parameters

< string > array

roles
optional

Roles

< string > array

jsonataTransformer
optional

JSONata query to transform the serialized result

string

returnedVariableName
optional

Name of the returned context variable

string

serializeResult
optional

Whether to serialize the result of the endpoint

boolean

contentType
optional

Content type of the response

string

TSParameterMappingDto

Name Schema

serviceParameter
required

string

multivalued
required

string

parameterName
optional

string

defaultValue
required

string

valueRequired
optional

boolean

WFActionDto

Name Description Schema

uuid
required

workflow’s id

string

actionEl
required

expression to trigger when condition is true

string

priority
optional

order of this action

integer (int32)

conditionEl
optional

expression to evaluate to trigger an action

string

WFDecisionRuleDto

Name Description Schema

name
optional

Name of the decision. Use for display.

string

value
optional

Value of the decision

string

WFTransitionDto

Name Description Schema

uuid
optional

id of this transition

string

fromStatus
required

Status before the transition

string

toStatus
required

Status after the transition

string

conditionEl
optional

Condition to perform this transition

string

priority
optional

Order in which to perform this transition

integer (int32)

description
optional

The description

string

listWFActionDto
optional

List of actions to perform

< WFActionDto > array

listWFDecisionRuleDto
optional

List of decision rules to execute

< WFDecisionRuleDto > array

WorkflowDto

Name Description Schema

code
optional

Code of workflow

string

description
optional

Description of workflow

string

wfType
optional

The type

string

enableHistory
optional

If history is save when executing this workflow

boolean

listWFTransitionDto
optional

List of transitions associated with this workflow

< WFTransitionDto > array

WorkflowsResponseDto

Name Schema

actionStatus
optional

workflows
optional

< WorkflowDto > array

WorkflowHistoryActionDto

Name Description Schema

action
optional

Action to perform

string

result
optional

Result of the action

string

WorkflowHistoryDto

Name Description Schema

actionDate
optional

Date when this action is executed

string (date-time)

workflowCode
optional

Code of workflow

string

entityInstanceCode
optional

Code of entity instance

string

fromStatus
optional

Status before the transition

string

toStatus
optional

Status after the transition

string

listWorkflowHistoryActionDto
optional

List of actions performed

WorkflowHistoryResponseDto

Name Schema

actionStatus
optional

workflowHistories
optional

< WorkflowHistoryDto > array

WorkflowResponseDto

Name Schema

actionStatus
optional

workflow
optional