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