hello

Module:CoreRoute:/Request:GETFunction:hello
Displays a little api help, automatically generated reading comments in function files.
 

hello

Module:CoreRoute:/test/helloRequest:GETFunction:hello
Displays a little api help, automatically generated reading comments in function files.
 

corsPreflight

Module:CoreRoute:/**Request:OPTIONSFunction:corsPreflight

curl --header "Content-Type: application/json" \
--request POST \
--data "{\"username\":\"test\",\"password\":\"password\",\"email\":\"email@test.com\"}" \
http://localhost:8081/api/users
 

userLogin

Module:CoreRoute:/api/v1/auth/loginRequest:POSTFunction:userLogin
 

getPermissionsToUser

Module:AdministrationRoute:/api/v1/permissions/user/:user_idRequest:GETFunction:getPermissionsToUser

curl --header "Content-Type: application/json" \
--request GET \
 

editPermission

Module:AdministrationRoute:/api/v1/permissions/:codeRequest:PUTFunction:editPermission

bc..
curl —header “Content-Type: application/json” \
—request POST \
—each parameter is optional
—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

addPermission

Module:AdministrationRoute:/api/v1/addpermissionRequest:POSTFunction:addPermission

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

deletePermission

Module:AdministrationRoute:/api/v1/permissions/:idRequest:DELETEFunction:deletePermission

curl --header "Content-Type: application/json" \
--request DELETE \
 

getPermissionsToRole

Module:AdministrationRoute:/api/v1/permissions/role/:idRequest:GETFunction:getPermissionsToRole

curl --header "Content-Type: application/json" \
--request POST \
 

getAllPemissions

Module:AdministrationRoute:/api/v1/permissions/:code/:fieldsRequest:GETFunction:getAllPemissions

curl --header "Content-Type: application/json" \
--request GET \
 

getPermissionsTree

Module:AdministrationRoute:/api/v1/permissionstreeRequest:POSTFunction:getPermissionsTree

curl --header "Content-Type: application/json" \
--request GET \
 

daemonStart

Module:CoreRoute:/api/v1/daemons/start/:didRequest:PUTFunction:daemonStart
 

daemonStop

Module:CoreRoute:/api/v1/daemons/stop/:didRequest:PUTFunction:daemonStop
 

daemonEnable

Module:CoreRoute:/api/v1/daemons/enable/:didRequest:PUTFunction:daemonEnable
 

daemonDisable

Module:CoreRoute:/api/v1/daemons/disable/:didRequest:PUTFunction:daemonDisable
 

getTranslations

Module:CoreRoute:/api/v1/misc/translations/:langRequest:GETFunction:getTranslations
 

getModuleSource

Module:CoreRoute:/api/v1/misc/modules/**Request:GETFunction:getModuleSource
 

getModules

Module:CoreRoute:/api/v1/misc/moduleslistRequest:GETFunction:getModules
 

getPayloads

Module:CoreRoute:/api/v1/misc/payloadslistRequest:GETFunction:getPayloads
 

getSchedulerJobs

Module:CoreRoute:/api/v1/misc/schedulerjobslist/:moduleRequest:GETFunction:getSchedulerJobs
 

getCodelist

Module:CoreRoute:/api/v1/misc/codelists/**Request:GETFunction:getCodelist
 

getCodelists

Module:CoreRoute:/api/v1/misc/codelist/namesRequest:GETFunction:getCodelists
 

getDataList

Module:CoreRoute:/api/v1/misc/datalist/:view/:fieldRequest:GETFunction:getDataList
 

getStatesList

Module:CoreRoute:/api/v1/misc/stateslist/:objectname/:allowedfromRequest:GETFunction:getStatesList
* function to get a list of statuses * param string $objectname where the group of states belongs * param string $allowedfrom the starting status in order to get only the status allowed to * * @return string a formatted json with a key ‘list’ with the list of the statuses, * optional key ‘result’ with additional metadata of the statasues
 

uploadFile

Module:CoreRoute:/api/v1/misc/uploadRequest:POSTFunction:uploadFile
 

removeFile

Module:CoreRoute:/api/v1/misc/remove/:filenameRequest:DELETEFunction:removeFile
 

analizeCsvFields

Module:CoreRoute:/api/v1/misc/analyzecsv/:filenameRequest:GETFunction:analizeCsvFields
 

getObjects

Module:CoreRoute:/api/v1/misc/objectsRequest:GETFunction:getObjects
 

getObject

Module:CoreRoute:/api/v1/misc/objects/:objectRequest:GETFunction:getObject
 

updateObject

Module:CoreRoute:/api/v1/misc/objects/:codeRequest:PUTFunction:updateObject

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

createObjectMap

Module:CoreRoute:/api/v1/misc/objects/map/newRequest:POSTFunction:createObjectMap

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

getObjectMaps

Module:CoreRoute:/api/v1/misc/objects/map/:objectRequest:GETFunction:getObjectMaps
 

updateObjectMap

Module:CoreRoute:/api/v1/misc/objects/map/:idRequest:PUTFunction:updateObjectMap

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

getStateLog

Module:CoreRoute:/api/v1/misc/statelog/:obj/:idRequest:GETFunction:getStateLog
 

importData

Module:CoreRoute:/api/v1/misc/importdataRequest:POSTFunction:importData
 

importDataReadFile

Module:CoreRoute:/api/v1/misc/importdatarfRequest:POSTFunction:importDataReadFile
 

importDataPostRecord

Module:CoreRoute:/api/v1/misc/importdataprRequest:POSTFunction:importDataPostRecord
 

getForms

Module:CoreRoute:/api/v1/assets/formsRequest:GETFunction:getForms
 

getForms

Module:CoreRoute:/api/v1/assets/forms/:idRequest:GETFunction:getForms
 

getForm

Module:CoreRoute:/api/v1/assets/form/:form_nameRequest:GETFunction:getForm
 

saveForm

Module:CoreRoute:/api/v1/assets/forms/edit/:idRequest:POSTFunction:saveForm
 

deleteAsset

Module:CoreRoute:/api/v1/assets/delete/:idRequest:DELETEFunction:deleteAsset

Accepts parameter :id on DELETE request

id should be the role id to delete (can be a list, comma separated)

cURL example:

curl --header "Content-Type: application/json" \
--request DELETE -w "\n" \
devapi.vreserver.com/api/roles/4,5
 

getTable

Module:CoreRoute:/api/v1/assets/table/:table_nameRequest:GETFunction:getTable
 

allTables

Module:CoreRoute:/api/v1/assets/tablesRequest:GETFunction:allTables
 

saveTable

Module:CoreRoute:/api/v1/assets/tables/edit/:idRequest:POSTFunction:saveTable
 

cloneAsset

Module:CoreRoute:/api/v1/assets/clone/:idRequest:GETFunction:cloneAsset
 

getFormComponents

Module:CoreRoute:/api/v1/assets/formcomponentsRequest:GETFunction:getFormComponents
 

getAssetParameters

Module:CoreRoute:/api/v1/assets/parameters/:form_nameRequest:GETFunction:getAssetParameters
 

getAssetFromObject

Module:CoreRoute:/api/v1/misc/assetfromobject/:table/:id/:field/Request:GETFunction:getAssetFromObject
 

createEventsFiletype

Module:CoreRoute:/api/v1/admin/events/new/Request:POSTFunction:createEventsFiletype

bc..
curl —header “Content-Type: application/json” \
—request POST \

 

generateToken

Module:CoreRoute:/api/v1/generate/tokenRequest:POSTFunction:generateToken
 

getUserTokens

Module:CoreRoute:/api/v1/user/tokens/:idRequest:GETFunction:getUserTokens
 

removeToken

Module:CoreRoute:/api/v1/token/remove/:idRequest:DELETEFunction:removeToken

documentation

asdlkfjasldkfj

 

getMeta

Module:CoreRoute:/api/v1/misc/meta/:object/:idRequest:GETFunction:getMeta
 

searchLookupTerm

Module:CoreRoute:/api/v1/misc/lookup/:type/:param/:valueRequest:GETFunction:searchLookupTerm

documentation

asdlkfjasldkfj

 

getRoles

Module:AdministrationRoute:/api/v1/roles/:idRequest:GETFunction:getRoles
 

addRole

Module:AdministrationRoute:/api/v1/roleRequest:POSTFunction:addRole

Accepts only one POST argument:

role_name

Example request with cURL:

curl --header "Content-Type: application/json" \
--request POST -w "\n" \
--data "{\"role_name\":\"marketing\"}" \
devapi.vreserver.com/api/roles
 
 

updateRole

Module:AdministrationRoute:/api/v1/role/:idRequest:PUTFunction:updateRole

Accepts only one POST argument:

role_name

Example request with cURL:

curl --header "Content-Type: application/json" \
--request POST -w "\n" \
--data "{\"role_name\":\"marketing\"}" \
devapi.vreserver.com/api/roles
 
 

deleteRole

Module:AdministrationRoute:/api/v1/roles/:idRequest:DELETEFunction:deleteRole

Accepts parameter :id on DELETE request

id should be the role id to delete (can be a list, comma separated)

cURL example:

curl --header "Content-Type: application/json" \
--request DELETE -w "\n" \
devapi.vreserver.com/api/roles/4,5
 

getUsers

Module:AdministrationRoute:/api/v1/users/:idRequest:GETFunction:getUsers

Get users

Accepted argument ?limit, order, offset
limit, order and offset can be passed to limit retrieved user list as GET method.


curl 
/api/v1/users
 

getUserRoles

Module:AdministrationRoute:/api/v1/users/roles/:idRequest:GETFunction:getUserRoles
 

createUser

Module:AdministrationRoute:/api/v1/users/newRequest:POSTFunction:createUser

bc..
curl —header “Content-Type: application/json” \
—request POST \
—data “{\username\“test\”,\password\“password\”,\email\“email@test.com\”}” \
http://localhost:8081/api/users

 

updateUser

Module:AdministrationRoute:/api/v1/users/:idRequest:PUTFunction:updateUser
 

updateSettings

Module:AdministrationRoute:/api/v1/user/settings/:idRequest:PUTFunction:updateSettings
 

assignRolesToUser

Module:AdministrationRoute:/api/v1/users/rolesRequest:POSTFunction:assignRolesToUser

Accepted arguments:

This function works with two arguments: “user_id” and “roles” (array of roles id’s to assign to user)

Warning!

This will delete all previous roles and add new ones to user.

Example request:

curl --header "Content-Type: application/json" \
--request POST -w "\n" \
--data "{\"user_id\":\"2\",\"roles\":[1,2]}" \
devapi.vreserver.com/api/roles/user_role
 

deleteUser

Module:AdministrationRoute:/api/v1/users/:idRequest:DELETEFunction:deleteUser

Delete user(s)

Accepted argument :[] (list of ids)
Just pass a list of ids as parameter in the URL to trigger user(s) deletion.

bc..
curl —request DELETE \
/api/v1/users/3,4

 

removeRoleFromUser

Module:AdministrationRoute:/api/v1/uroles/:idRequest:DELETEFunction:removeRoleFromUser
 

getUserRoles

Module:AdministrationRoute:/api/v1/uroles/:idRequest:GETFunction:getUserRoles
 

getUserSettings

Module:AdministrationRoute:/api/v1/user/settings/:moduleRequest:GETFunction:getUserSettings
 

saveUserSettings

Module:AdministrationRoute:/api/v1/user/save/:moduleRequest:PUTFunction:saveUserSettings
 

checkUserExistance

Module:AdministrationRoute:/api/v1/user/checkexistance/:scope/:stringRequest:GETFunction:checkUserExistance
 

getCodeListOptions

Module:AdministrationRoute:/api/v1/admin/codelists/:cl/:idRequest:GETFunction:getCodeListOptions
 

updCodeListOption

Module:AdministrationRoute:/api/v1/admin/codelists/:cl/:idRequest:PUTFunction:updCodeListOption

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

addCodeListOption

Module:AdministrationRoute:/api/v1/admin/codelists/:cl/Request:POSTFunction:addCodeListOption

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

delCodeListOption

Module:AdministrationRoute:/api/v1/admin/codelists/:cl/:idRequest:DELETEFunction:delCodeListOption

bc..
curl —header “Content-Type: application/json” \
—request POST \

—data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \

 

publishCodelists

Module:AdministrationRoute:/api/v1/admin/publish/codelists/Request:GETFunction:publishCodelists
 

getDaemonsList

Module:AdministrationRoute:/api/v1/daemons/:idRequest:GETFunction:getDaemonsList

Get registry entities

Accepted argument ?limit, order, offset
limit, order and offset can be passed to limit retrieved user list as GET method.


curl 
/api/v1/users
 

addDaemon

Module:AdministrationRoute:/api/v1/daemons/Request:POSTFunction:addDaemon

bc..
curl —header “Content-Type: application/json” \
—request POST \
—data “{\username\“test\”,\password\“password\”,\email\“email@test.com\”}” \
http://localhost:8081/api/users

 

updDaemon

Module:AdministrationRoute:/api/v1/daemons/:idRequest:PUTFunction:updDaemon
 

delDaemon

Module:AdministrationRoute:/api/v1/daemons/:idRequest:DELETEFunction:delDaemon
 

getSchedulerList

Module:AdministrationRoute:/api/v1/scheduler/jobs/:rowRequest:GETFunction:getSchedulerList
 

addSchedulerJob

Module:AdministrationRoute:/api/v1/scheduler/:rowRequest:POSTFunction:addSchedulerJob
 

delSchedulerJob

Module:AdministrationRoute:/api/v1/scheduler/delete/:rowRequest:DELETEFunction:delSchedulerJob
 

enableSchedulerJob

Module:AdministrationRoute:/api/v1/scheduler/enable/:rowRequest:PUTFunction:enableSchedulerJob
 

disableSchedulerJob

Module:AdministrationRoute:/api/v1/scheduler/disable/:rowRequest:PUTFunction:disableSchedulerJob
 

getAssetData

Module:AdministrationRoute:/api/v2/assets/asset/:idRequest:GETFunction:getAssetData
 

crtAsset

Module:AdministrationRoute:/api/v2/assets/asset/Request:POSTFunction:crtAsset
 

updAssetData

Module:AdministrationRoute:/api/v2/assets/asset/:idRequest:PUTFunction:updAssetData
 

getAssetDataByName

Module:AdministrationRoute:/api/v2/assets/get/:nameRequest:GETFunction:getAssetDataByName
 

getDutyDuties

Module:DutyRoute:/api/v1/duty/duties/:idRequest:GETFunction:getDutyDuties

documentation

asdlkfjasldkfj

 

addDutyDuties

Module:DutyRoute:/api/v1/duty/dutiesRequest:POSTFunction:addDutyDuties

documentation

asdlkfjasldkfj

 

updDutyDuties

Module:DutyRoute:/api/v1/duty/duties/:idRequest:PUTFunction:updDutyDuties

documentation

asdlkfjasldkfj

 

delDutyDuties

Module:DutyRoute:/api/v1/duty/duties/:idRequest:DELETEFunction:delDutyDuties

documentation

asdlkfjasldkfj

 

crtDuty

Module:DutyRoute:/api/v1/duty/crt/:idRequest:PUTFunction:crtDuty
 

strDuty

Module:DutyRoute:/api/v1/duty/start/:idRequest:PUTFunction:strDuty
 

hldDuty

Module:DutyRoute:/api/v1/duty/hold/:idRequest:PUTFunction:hldDuty
 

comDuty

Module:DutyRoute:/api/v1/duty/complete/:idRequest:PUTFunction:comDuty
 

setMobileMeta

Module:DutyRoute:/api/v1/duty/meta/:idRequest:PUTFunction:setMobileMeta
 

addUserDuty

Module:DutyRoute:/api/v1/duty/user/Request:PUTFunction:addUserDuty
 

getUserDuties

Module:DutyRoute:/api/v1/duty/user/dutiesRequest:GETFunction:getUserDuties
 

assignDutyToUser

Module:DutyRoute:/api/v1/duty/user/assignRequest:GETFunction:assignDutyToUser
 

afterhookDutyASG

Module:DutyRoute:/api/v1/duty/after/assign/:idRequest:GETFunction:afterhookDutyASG
 

hafterHookDutyCom

Module:DutyRoute:/api/v1/duty/after/Request:PUTFunction:hafterHookDutyCom
 

getDutyReminders

Module:DutyRoute:api/v1/duty/reminders/:idRequest:GETFunction:getDutyReminders

documentation

asdlkfjasldkfj

 

addDutyReminders

Module:DutyRoute:api/v1/duty/reminders/Request:POSTFunction:addDutyReminders
 

updDutyReminders

Module:DutyRoute:api/v1/duty/reminders/:idRequest:PUTFunction:updDutyReminders

documentation

asdlkfjasldkfj

 

delDutyReminders

Module:DutyRoute:api/v1/duty/reminders/:idRequest:DELETEFunction:delDutyReminders

documentation

asdlkfjasldkfj

 

getDutyTasks

Module:DutyRoute:api/v1/duty/tasks/:idRequest:GETFunction:getDutyTasks

documentation

asdlkfjasldkfj

 

addDutyTasks

Module:DutyRoute:api/v1/duty/tasks/Request:POSTFunction:addDutyTasks

documentation

asdlkfjasldkfj

 

updDutyTasks

Module:DutyRoute:api/v1/duty/tasks/:idRequest:PUTFunction:updDutyTasks

documentation

asdlkfjasldkfj

 

delDutyTasks

Module:DutyRoute:api/v1/duty/tasks/:idRequest:DELETEFunction:delDutyTasks

documentation

asdlkfjasldkfj

 

getDutyActivities

Module:DutyRoute:api/v1/activities/retrieve/:idRequest:GETFunction:getDutyActivities
 

getDutyNews

Module:DutyRoute:api/v1/duty/news/:idRequest:GETFunction:getDutyNews

documentation

asdlkfjasldkfj

 

addDutyNews

Module:DutyRoute:api/v1/duty/news/Request:POSTFunction:addDutyNews
 

updDutyNews

Module:DutyRoute:api/v1/duty/news/:idRequest:PUTFunction:updDutyNews

documentation

asdlkfjasldkfj

 

delDutyNews

Module:DutyRoute:api/v1/duty/news/:idRequest:DELETEFunction:delDutyNews

documentation

asdlkfjasldkfj

 

getArticle

Module:DutyRoute:api/v1/select/news/:idRequest:GETFunction:getArticle

documentation

asdlkfjasldkfj

 

getDutyStates

Module:DutyRoute:/api/v1/duty/states/Request:GETFunction:getDutyStates
 

getDutyPipelines

Module:DutyRoute:api/v1/duty/pipelines/:idRequest:GETFunction:getDutyPipelines

documentation

asdlkfjasldkfj

 

addDutyPipelines

Module:DutyRoute:api/v1/duty/pipelines/Request:POSTFunction:addDutyPipelines

documentation

asdlkfjasldkfj

 

updDutyPipelines

Module:DutyRoute:api/v1/duty/pipelines/:idRequest:PUTFunction:updDutyPipelines

documentation

asdlkfjasldkfj

 

delDutyPipelines

Module:DutyRoute:api/v1/duty/pipelines/:idRequest:DELETEFunction:delDutyPipelines

documentation

asdlkfjasldkfj

 

getPipelinePhases

Module:DutyRoute:api/v1/pipeline/phases/:idRequest:GETFunction:getPipelinePhases
 

saveServiceTemplate

Module:DutyRoute:api/v1/service/template/:id/Request:PUTFunction:saveServiceTemplate
 

getLineupLicences

Module:LineupRoute:/api/v1/lineup/licences/:idRequest:GETFunction:getLineupLicences

documentation

asdlkfjasldkfj

 

addLineupLicences

Module:LineupRoute:/api/v1/lineup/licencesRequest:POSTFunction:addLineupLicences
 

updLineupLicences

Module:LineupRoute:/api/v1/lineup/licences/:idRequest:PUTFunction:updLineupLicences

documentation

asdlkfjasldkfj

 

delLineupLicences

Module:LineupRoute:/api/v1/lineup/licences/:idRequest:DELETEFunction:delLineupLicences

documentation

asdlkfjasldkfj

 

getLineupServers

Module:LineupRoute:/api/v1/lineup/servers/:idRequest:GETFunction:getLineupServers

documentation

asdlkfjasldkfj

 

addLineupServers

Module:LineupRoute:/api/v1/lineup/serversRequest:POSTFunction:addLineupServers
 

updLineupServers

Module:LineupRoute:/api/v1/lineup/servers/:idRequest:PUTFunction:updLineupServers

documentation

asdlkfjasldkfj

 

delLineupServers

Module:LineupRoute:/api/v1/lineup/servers/:idRequest:DELETEFunction:delLineupServers

documentation

asdlkfjasldkfj

 

getReservedServer

Module:LineupRoute:/api/v1/lineup/reserved/serverRequest:GETFunction:getReservedServer
 

serverIncrementLoad

Module:LineupRoute:/api/v1/Server/increment/loadRequest:POSTFunction:serverIncrementLoad
 

getLineupSystems

Module:LineupRoute:/api/v1/lineup/systems/:idRequest:GETFunction:getLineupSystems

documentation

asdlkfjasldkfj

 

addLineupSystems

Module:LineupRoute:/api/v1/lineup/systemsRequest:POSTFunction:addLineupSystems
 

updLineupSystems

Module:LineupRoute:/api/v1/lineup/systems/:idRequest:PUTFunction:updLineupSystems

documentation

asdlkfjasldkfj

 

delLineupSystems

Module:LineupRoute:/api/v1/lineup/systems/:idRequest:DELETEFunction:delLineupSystems

documentation

asdlkfjasldkfj

 

registerServer

Module:LineupRoute:/api/v1/lineup/register/server/:serveridRequest:POSTFunction:registerServer
 

registerSystem

Module:LineupRoute:/api/v1/lineup/register/system/:systemidRequest:POSTFunction:registerSystem
 

installProcedure

Module:LineupRoute:/api/v1/lineup/deploy/:actionRequest:POSTFunction:installProcedure
 

getLineupProducts

Module:LineupRoute:/api/v1/lineup/products/:idRequest:GETFunction:getLineupProducts

documentation

asdlkfjasldkfj

 

addLineupProducts

Module:LineupRoute:/api/v1/lineup/productsRequest:POSTFunction:addLineupProducts
 

updLineupProducts

Module:LineupRoute:/api/v1/lineup/products/:idRequest:PUTFunction:updLineupProducts

documentation

asdlkfjasldkfj

 

delLineupProducts

Module:LineupRoute:/api/v1/lineup/products/:idRequest:DELETEFunction:delLineupProducts

documentation

asdlkfjasldkfj

 

getLineupProductsVersions

Module:LineupRoute:/api/v1/lineup/products/versions/:idRequest:GETFunction:getLineupProductsVersions

documentation

asdlkfjasldkfj

 

addLineupProductsVersions

Module:LineupRoute:/api/v1/lineup/products/versions/Request:POSTFunction:addLineupProductsVersions
 

updLineupProductsVersions

Module:LineupRoute:/api/v1/lineup/products/versions/:idRequest:PUTFunction:updLineupProductsVersions

documentation

asdlkfjasldkfj

 

delLineupProductsVersions

Module:LineupRoute:/api/v1/lineup/products/versions/:idRequest:DELETEFunction:delLineupProductsVersions

documentation

asdlkfjasldkfj

 

getVersion

Module:LineupRoute:/api/v1/lineup/products/version/:idRequest:GETFunction:getVersion

documentation

asdlkfjasldkfj

 

updateSelectedLicences

Module:LineupRoute:/api/v1/licence/update/Request:PUTFunction:updateSelectedLicences
 

createSystemUpdateTask

Module:LineupRoute:/api/v1/sysytem/update/:idRequest:PUTFunction:createSystemUpdateTask
 

createSystemUninstallTask

Module:LineupRoute:/api/v1/sysytem/uninstall/:idRequest:PUTFunction:createSystemUninstallTask
 

getRegistryEntries

Module:RegistryRoute:/api/v1/registry/:idRequest:GETFunction:getRegistryEntries

documentation

asdlkfjasldkfj

 

addRegistryEntries

Module:RegistryRoute:/api/v1/registryRequest:POSTFunction:addRegistryEntries
 

updRegistryEntries

Module:RegistryRoute:/api/v1/registry/:idRequest:PUTFunction:updRegistryEntries

documentation

asdlkfjasldkfj

 

delRegistryEntries

Module:RegistryRoute:/api/v1/registry/:idRequest:DELETEFunction:delRegistryEntries

documentation

asdlkfjasldkfj

 

getRegistryEntities

Module:RegistryRoute:/api/v1/registry/tregistry/:typeRequest:GETFunction:getRegistryEntities

Get registry entities

Accepted argument ?limit, order, offset
limit, order and offset can be passed to limit retrieved user list as GET method.


curl 
/api/v1/users
 

getRegistryEntitiesList

Module:RegistryRoute:/api/v1/registry/registrylist/:typeRequest:GETFunction:getRegistryEntitiesList

Get registry entities

Accepted argument ?limit, order, offset
limit, order and offset can be passed to limit retrieved user list as GET method.


curl 
/api/v1/users
 

searchRegistryEntries

Module:RegistryRoute:/api/v1/registry/search/:paramsRequest:GETFunction:searchRegistryEntries
 

dbRegistryTransfer

Module:RegistryRoute:/api/v1/registry/db/transferRequest:POSTFunction:dbRegistryTransfer
 

getProfileDetails

Module:SelfRoute:/api/v1/self/details/Request:GETFunction:getProfileDetails
 

updProfileDetails

Module:SelfRoute:/api/v1/self/details/Request:PUTFunction:updProfileDetails

documentation

asdlkfjasldkfj

 

userStatus

Module:SelfRoute:/api/v1/misc/status/Request:PUTFunction:userStatus
 

expireUser

Module:SelfRoute:/api/v1/self/daemon/Request:GETFunction:expireUser
 

createExternalUser

Module:SelfRoute:/api/v1/self/registration/Request:POSTFunction:createExternalUser
 

userExistsCheck

Module:SelfRoute:/api/v1/self/userexists/:usernameRequest:GETFunction:userExistsCheck
 

getUserDetails

Module:SelfRoute:/api/v1/self/user/details/:idRequest:GETFunction:getUserDetails
 

activateExternalUser

Module:SelfRoute:/api/v1/self/verify/:tokenRequest:GETFunction:activateExternalUser
 

getProfileSettings

Module:SelfRoute:/api/v1/self/settings/:relatedRequest:GETFunction:getProfileSettings
 

updProfileSettings

Module:SelfRoute:/api/v1/self/settings/:relatedRequest:PUTFunction:updProfileSettings

documentation

asdlkfjasldkfj

 

userPasswordReset

Module:SelfRoute:/api/v1/self/passwordresetRequest:POSTFunction:userPasswordReset
 

userSetNewPassword

Module:SelfRoute:/api/v1/self/newpasswordRequest:POSTFunction:userSetNewPassword
 

getSettings

Module:ShapeRoute:/api/v1/assets/settings/:settingRequest:GETFunction:getSettings
 

getSetting

Module:ShapeRoute:/api/v1/assets/setting/:type/:nameRequest:GETFunction:getSetting
* This function is DEPRECATED * Returns field ‘value’ from a particular row in table ‘core_settings’ * Added field ‘json’ with encoded versioon of ‘value’ * param string $type required. value to match 'settyng_type' field * param string $name required. value to match ‘settyng_name’ field * @return string JSON with corresponding ‘value’ field otherwise returns ‘error’ true
 

saveSettings

Module:ShapeRoute:/api/v1/assets/settings/:idRequest:PUTFunction:saveSettings
 

getSettingValue

Module:ShapeRoute:/api/v1/assets/settingvalue/:type/:nameRequest:GETFunction:getSettingValue
* Returns field ‘value’ from a particular row in table ‘core_settings’ as a JSON string or as array * Added field ‘json’ with encoded versioon of ‘value’ * param string $type required. value to match 'settyng_type' field * param string $name required. value to match ‘settyng_name’ field * @return array|string $out. retruns ‘value’ field stored as JSON in key ‘value’ and as array in key ‘objValue’. * If some error occures key ‘error’ is TRUE otherwise is FALSE
 

crtShapeSetting

Module:ShapeRoute:/api/v1/shape/config/Request:POSTFunction:crtShapeSetting
 

getStashFiles

Module:StashRoute:/api/v1/stash/files/:idRequest:GETFunction:getStashFiles

documentation

asdlkfjasldkfj

 

addStashFiles

Module:StashRoute:/api/v1/stash/filesRequest:POSTFunction:addStashFiles
* Saves files in the “core_files” table and takes a mandatory “file” input which MUST be in a base_64 format. * Optional inputs may include “title”, “folder”, “objectID” and “objectType”. * If no “folder” is specified, the function will create a folder called with the current date and * save the file in the “files/(current date)” path. * The function extracts the mime from the base_64 format and saves the file with the appropriate file extension. * param $_POST['folder'] - if called from endpoint * param $folder – if called internally * param $_POST['objectId'] * param $objectId * param $_POST['objectType'] * param $objectType * param $_POST['title'] * param $title * param string $_POST['file'] - MANDATORY - if called from endpoint - the file in base64 format to be stored * param string $file – MANDATORY – if called internally – the file in base64 format to be stored * * return string $out - if called from endpoint - JSON with the body of the message in the key 'body', otherwise returns 'error' true * return array $out – if called internally
 

updStashFiles

Module:StashRoute:/api/v1/stash/files/:idRequest:PUTFunction:updStashFiles

documentation

asdlkfjasldkfj

 

delStashFiles

Module:StashRoute:/api/v1/stash/files/:idRequest:DELETEFunction:delStashFiles

documentation

asdlkfjasldkfj

 

setStashObject

Module:StashRoute:/api/v1/stash/object/Request:PUTFunction:setStashObject