hello | |||||||
| Module: | Core | Route: | / | Request: | GET | Function: | hello |
| Displays a little api help, automatically generated reading comments in function files. | |||||||
hello | |||||||
| Module: | Core | Route: | /test/hello | Request: | GET | Function: | hello |
| Displays a little api help, automatically generated reading comments in function files. | |||||||
corsPreflight | |||||||
| Module: | Core | Route: | /** | Request: | OPTIONS | Function: | corsPreflight |
| |||||||
userLogin | |||||||
| Module: | Core | Route: | /api/v1/auth/login | Request: | POST | Function: | userLogin |
getPermissionsToUser | |||||||
| Module: | Administration | Route: | /api/v1/permissions/user/:user_id | Request: | GET | Function: | getPermissionsToUser |
| |||||||
editPermission | |||||||
| Module: | Administration | Route: | /api/v1/permissions/:code | Request: | PUT | Function: | editPermission |
bc.. | |||||||
addPermission | |||||||
| Module: | Administration | Route: | /api/v1/addpermission | Request: | POST | Function: | addPermission |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
deletePermission | |||||||
| Module: | Administration | Route: | /api/v1/permissions/:id | Request: | DELETE | Function: | deletePermission |
| |||||||
getPermissionsToRole | |||||||
| Module: | Administration | Route: | /api/v1/permissions/role/:id | Request: | GET | Function: | getPermissionsToRole |
| |||||||
getAllPemissions | |||||||
| Module: | Administration | Route: | /api/v1/permissions/:code/:fields | Request: | GET | Function: | getAllPemissions |
| |||||||
getPermissionsTree | |||||||
| Module: | Administration | Route: | /api/v1/permissionstree | Request: | POST | Function: | getPermissionsTree |
| |||||||
daemonStart | |||||||
| Module: | Core | Route: | /api/v1/daemons/start/:did | Request: | PUT | Function: | daemonStart |
daemonStop | |||||||
| Module: | Core | Route: | /api/v1/daemons/stop/:did | Request: | PUT | Function: | daemonStop |
daemonEnable | |||||||
| Module: | Core | Route: | /api/v1/daemons/enable/:did | Request: | PUT | Function: | daemonEnable |
daemonDisable | |||||||
| Module: | Core | Route: | /api/v1/daemons/disable/:did | Request: | PUT | Function: | daemonDisable |
getTranslations | |||||||
| Module: | Core | Route: | /api/v1/misc/translations/:lang | Request: | GET | Function: | getTranslations |
getModuleSource | |||||||
| Module: | Core | Route: | /api/v1/misc/modules/** | Request: | GET | Function: | getModuleSource |
getModules | |||||||
| Module: | Core | Route: | /api/v1/misc/moduleslist | Request: | GET | Function: | getModules |
getPayloads | |||||||
| Module: | Core | Route: | /api/v1/misc/payloadslist | Request: | GET | Function: | getPayloads |
getSchedulerJobs | |||||||
| Module: | Core | Route: | /api/v1/misc/schedulerjobslist/:module | Request: | GET | Function: | getSchedulerJobs |
getCodelist | |||||||
| Module: | Core | Route: | /api/v1/misc/codelists/** | Request: | GET | Function: | getCodelist |
getCodelists | |||||||
| Module: | Core | Route: | /api/v1/misc/codelist/names | Request: | GET | Function: | getCodelists |
getDataList | |||||||
| Module: | Core | Route: | /api/v1/misc/datalist/:view/:field | Request: | GET | Function: | getDataList |
getStatesList | |||||||
| Module: | Core | Route: | /api/v1/misc/stateslist/:objectname/:allowedfrom | Request: | GET | Function: | 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: | Core | Route: | /api/v1/misc/upload | Request: | POST | Function: | uploadFile |
removeFile | |||||||
| Module: | Core | Route: | /api/v1/misc/remove/:filename | Request: | DELETE | Function: | removeFile |
analizeCsvFields | |||||||
| Module: | Core | Route: | /api/v1/misc/analyzecsv/:filename | Request: | GET | Function: | analizeCsvFields |
getObjects | |||||||
| Module: | Core | Route: | /api/v1/misc/objects | Request: | GET | Function: | getObjects |
getObject | |||||||
| Module: | Core | Route: | /api/v1/misc/objects/:object | Request: | GET | Function: | getObject |
updateObject | |||||||
| Module: | Core | Route: | /api/v1/misc/objects/:code | Request: | PUT | Function: | updateObject |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
createObjectMap | |||||||
| Module: | Core | Route: | /api/v1/misc/objects/map/new | Request: | POST | Function: | createObjectMap |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
getObjectMaps | |||||||
| Module: | Core | Route: | /api/v1/misc/objects/map/:object | Request: | GET | Function: | getObjectMaps |
updateObjectMap | |||||||
| Module: | Core | Route: | /api/v1/misc/objects/map/:id | Request: | PUT | Function: | updateObjectMap |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
getStateLog | |||||||
| Module: | Core | Route: | /api/v1/misc/statelog/:obj/:id | Request: | GET | Function: | getStateLog |
importData | |||||||
| Module: | Core | Route: | /api/v1/misc/importdata | Request: | POST | Function: | importData |
importDataReadFile | |||||||
| Module: | Core | Route: | /api/v1/misc/importdatarf | Request: | POST | Function: | importDataReadFile |
importDataPostRecord | |||||||
| Module: | Core | Route: | /api/v1/misc/importdatapr | Request: | POST | Function: | importDataPostRecord |
getForms | |||||||
| Module: | Core | Route: | /api/v1/assets/forms | Request: | GET | Function: | getForms |
getForms | |||||||
| Module: | Core | Route: | /api/v1/assets/forms/:id | Request: | GET | Function: | getForms |
getForm | |||||||
| Module: | Core | Route: | /api/v1/assets/form/:form_name | Request: | GET | Function: | getForm |
saveForm | |||||||
| Module: | Core | Route: | /api/v1/assets/forms/edit/:id | Request: | POST | Function: | saveForm |
deleteAsset | |||||||
| Module: | Core | Route: | /api/v1/assets/delete/:id | Request: | DELETE | Function: | deleteAsset |
Accepts parameter :id on DELETE requestid should be the role id to delete (can be a list, comma separated) cURL example: | |||||||
getTable | |||||||
| Module: | Core | Route: | /api/v1/assets/table/:table_name | Request: | GET | Function: | getTable |
allTables | |||||||
| Module: | Core | Route: | /api/v1/assets/tables | Request: | GET | Function: | allTables |
saveTable | |||||||
| Module: | Core | Route: | /api/v1/assets/tables/edit/:id | Request: | POST | Function: | saveTable |
cloneAsset | |||||||
| Module: | Core | Route: | /api/v1/assets/clone/:id | Request: | GET | Function: | cloneAsset |
getFormComponents | |||||||
| Module: | Core | Route: | /api/v1/assets/formcomponents | Request: | GET | Function: | getFormComponents |
getAssetParameters | |||||||
| Module: | Core | Route: | /api/v1/assets/parameters/:form_name | Request: | GET | Function: | getAssetParameters |
createEventsFiletype | |||||||
| Module: | Core | Route: | /api/v1/admin/events/new/ | Request: | POST | Function: | createEventsFiletype |
bc.. | |||||||
generateToken | |||||||
| Module: | Core | Route: | /api/v1/generate/token | Request: | POST | Function: | generateToken |
getUserTokens | |||||||
| Module: | Core | Route: | /api/v1/user/tokens/:id | Request: | GET | Function: | getUserTokens |
removeToken | |||||||
| Module: | Core | Route: | /api/v1/token/remove/:id | Request: | DELETE | Function: | removeToken |
documentationasdlkfjasldkfj | |||||||
getMeta | |||||||
| Module: | Core | Route: | /api/v1/misc/meta/:object/:id | Request: | GET | Function: | getMeta |
getRoles | |||||||
| Module: | Administration | Route: | /api/v1/roles/:id | Request: | GET | Function: | getRoles |
addRole | |||||||
| Module: | Administration | Route: | /api/v1/role | Request: | POST | Function: | addRole |
Accepts only one POST argument:
Example request with cURL: | |||||||
updateRole | |||||||
| Module: | Administration | Route: | /api/v1/role/:id | Request: | PUT | Function: | updateRole |
Accepts only one POST argument:
Example request with cURL: | |||||||
deleteRole | |||||||
| Module: | Administration | Route: | /api/v1/roles/:id | Request: | DELETE | Function: | deleteRole |
Accepts parameter :id on DELETE requestid should be the role id to delete (can be a list, comma separated) cURL example: | |||||||
getUsers | |||||||
| Module: | Administration | Route: | /api/v1/users/:id | Request: | GET | Function: | getUsers |
Get usersAccepted argument ?limit, order, offset | |||||||
getUserRoles | |||||||
| Module: | Administration | Route: | /api/v1/users/roles/:id | Request: | GET | Function: | getUserRoles |
createUser | |||||||
| Module: | Administration | Route: | /api/v1/users/new | Request: | POST | Function: | createUser |
bc.. | |||||||
updateUser | |||||||
| Module: | Administration | Route: | /api/v1/users/:id | Request: | PUT | Function: | updateUser |
updateSettings | |||||||
| Module: | Administration | Route: | /api/v1/user/settings/:id | Request: | PUT | Function: | updateSettings |
assignRolesToUser | |||||||
| Module: | Administration | Route: | /api/v1/users/roles | Request: | POST | Function: | 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: | |||||||
deleteUser | |||||||
| Module: | Administration | Route: | /api/v1/users/:id | Request: | DELETE | Function: | deleteUser |
Delete user(s)Accepted argument :[] (list of ids) bc.. | |||||||
removeRoleFromUser | |||||||
| Module: | Administration | Route: | /api/v1/uroles/:id | Request: | DELETE | Function: | removeRoleFromUser |
getUserRoles | |||||||
| Module: | Administration | Route: | /api/v1/uroles/:id | Request: | GET | Function: | getUserRoles |
getUserSettings | |||||||
| Module: | Administration | Route: | /api/v1/user/settings/:module | Request: | GET | Function: | getUserSettings |
saveUserSettings | |||||||
| Module: | Administration | Route: | /api/v1/user/save/:module | Request: | PUT | Function: | saveUserSettings |
getCodeListOptions | |||||||
| Module: | Administration | Route: | /api/v1/admin/codelists/:cl/:id | Request: | GET | Function: | getCodeListOptions |
updCodeListOption | |||||||
| Module: | Administration | Route: | /api/v1/admin/codelists/:cl/:id | Request: | PUT | Function: | updCodeListOption |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
addCodeListOption | |||||||
| Module: | Administration | Route: | /api/v1/admin/codelists/:cl/ | Request: | POST | Function: | addCodeListOption |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
delCodeListOption | |||||||
| Module: | Administration | Route: | /api/v1/admin/codelists/:cl/:id | Request: | DELETE | Function: | delCodeListOption |
bc.. —data “{\permission_name\“permission_name\”,\permission_namespace\“permission_namespace\”,\module\“module\”,\permission_description\“permission_description\”,\permission_type\“permission_type\”,\icon\“icon\”,\order\” \ | |||||||
publishCodelists | |||||||
| Module: | Administration | Route: | /api/v1/admin/publish/codelists/ | Request: | GET | Function: | publishCodelists |
getDaemonsList | |||||||
| Module: | Administration | Route: | /api/v1/daemons/:id | Request: | GET | Function: | getDaemonsList |
Get registry entitiesAccepted argument ?limit, order, offset | |||||||
addDaemon | |||||||
| Module: | Administration | Route: | /api/v1/daemons/ | Request: | POST | Function: | addDaemon |
bc.. | |||||||
updDaemon | |||||||
| Module: | Administration | Route: | /api/v1/daemons/:id | Request: | PUT | Function: | updDaemon |
delDaemon | |||||||
| Module: | Administration | Route: | /api/v1/daemons/:id | Request: | DELETE | Function: | delDaemon |
getSchedulerList | |||||||
| Module: | Administration | Route: | /api/v1/scheduler/jobs/:row | Request: | GET | Function: | getSchedulerList |
addSchedulerJob | |||||||
| Module: | Administration | Route: | /api/v1/scheduler/:row | Request: | POST | Function: | addSchedulerJob |
delSchedulerJob | |||||||
| Module: | Administration | Route: | /api/v1/scheduler/delete/:row | Request: | DELETE | Function: | delSchedulerJob |
enableSchedulerJob | |||||||
| Module: | Administration | Route: | /api/v1/scheduler/enable/:row | Request: | PUT | Function: | enableSchedulerJob |
disableSchedulerJob | |||||||
| Module: | Administration | Route: | /api/v1/scheduler/disable/:row | Request: | PUT | Function: | disableSchedulerJob |
getAssetData | |||||||
| Module: | Administration | Route: | /api/v2/assets/asset/:id | Request: | GET | Function: | getAssetData |
crtAsset | |||||||
| Module: | Administration | Route: | /api/v2/assets/asset/ | Request: | POST | Function: | crtAsset |
updAssetData | |||||||
| Module: | Administration | Route: | /api/v2/assets/asset/:id | Request: | PUT | Function: | updAssetData |
getAssetDataByName | |||||||
| Module: | Administration | Route: | /api/v2/assets/get/:name | Request: | GET | Function: | getAssetDataByName |
getDutyDuties | |||||||
| Module: | Duty | Route: | /api/v1/duty/duties/:id | Request: | GET | Function: | getDutyDuties |
documentationasdlkfjasldkfj | |||||||
addDutyDuties | |||||||
| Module: | Duty | Route: | /api/v1/duty/duties | Request: | POST | Function: | addDutyDuties |
documentationasdlkfjasldkfj | |||||||
updDutyDuties | |||||||
| Module: | Duty | Route: | /api/v1/duty/duties/:id | Request: | PUT | Function: | updDutyDuties |
documentationasdlkfjasldkfj | |||||||
delDutyDuties | |||||||
| Module: | Duty | Route: | /api/v1/duty/duties/:id | Request: | DELETE | Function: | delDutyDuties |
documentationasdlkfjasldkfj | |||||||
strDuty | |||||||
| Module: | Duty | Route: | /api/v1/duty/start/:id | Request: | PUT | Function: | strDuty |
comDuty | |||||||
| Module: | Duty | Route: | /api/v1/duty/complete/:id | Request: | PUT | Function: | comDuty |
setMobileMeta | |||||||
| Module: | Duty | Route: | /api/v1/duty/meta/:id | Request: | PUT | Function: | setMobileMeta |
addUserDuty | |||||||
| Module: | Duty | Route: | /api/v1/duty/user/ | Request: | PUT | Function: | addUserDuty |
getUserDuties | |||||||
| Module: | Duty | Route: | /api/v1/duty/user/duties | Request: | GET | Function: | getUserDuties |
assignDutyToUser | |||||||
| Module: | Duty | Route: | /api/v1/duty/user/assign | Request: | GET | Function: | assignDutyToUser |
afterhookDutyASG | |||||||
| Module: | Duty | Route: | /api/v1/duty/after/assign/:id | Request: | GET | Function: | afterhookDutyASG |
hafterHookDutyCom | |||||||
| Module: | Duty | Route: | /api/v1/duty/after/ | Request: | PUT | Function: | hafterHookDutyCom |
getDutyReminders | |||||||
| Module: | Duty | Route: | api/v1/duty/reminders/:id | Request: | GET | Function: | getDutyReminders |
documentationasdlkfjasldkfj | |||||||
addDutyReminders | |||||||
| Module: | Duty | Route: | api/v1/duty/reminders/ | Request: | POST | Function: | addDutyReminders |
updDutyReminders | |||||||
| Module: | Duty | Route: | api/v1/duty/reminders/:id | Request: | PUT | Function: | updDutyReminders |
documentationasdlkfjasldkfj | |||||||
delDutyReminders | |||||||
| Module: | Duty | Route: | api/v1/duty/reminders/:id | Request: | DELETE | Function: | delDutyReminders |
documentationasdlkfjasldkfj | |||||||
getDutyActivities | |||||||
| Module: | Duty | Route: | api/v1/activities/retrieve/:id | Request: | GET | Function: | getDutyActivities |
getRegistryEntries | |||||||
| Module: | Registry | Route: | /api/v1/registry/:id | Request: | GET | Function: | getRegistryEntries |
documentationasdlkfjasldkfj | |||||||
addRegistryEntries | |||||||
| Module: | Registry | Route: | /api/v1/registry | Request: | POST | Function: | addRegistryEntries |
updRegistryEntries | |||||||
| Module: | Registry | Route: | /api/v1/registry/:id | Request: | PUT | Function: | updRegistryEntries |
documentationasdlkfjasldkfj | |||||||
delRegistryEntries | |||||||
| Module: | Registry | Route: | /api/v1/registry/:id | Request: | DELETE | Function: | delRegistryEntries |
documentationasdlkfjasldkfj | |||||||
getRegistryEntities | |||||||
| Module: | Registry | Route: | /api/v1/registry/tregistry/:type | Request: | GET | Function: | getRegistryEntities |
Get registry entitiesAccepted argument ?limit, order, offset | |||||||
getRegistryEntitiesList | |||||||
| Module: | Registry | Route: | /api/v1/registry/registrylist/:type | Request: | GET | Function: | getRegistryEntitiesList |
Get registry entitiesAccepted argument ?limit, order, offset | |||||||
searchRegistryEntries | |||||||
| Module: | Registry | Route: | /api/v1/registry/search/:params | Request: | GET | Function: | searchRegistryEntries |
dbRegistryTransfer | |||||||
| Module: | Registry | Route: | /api/v1/registry/db/transfer | Request: | POST | Function: | dbRegistryTransfer |
getProfileDetails | |||||||
| Module: | Self | Route: | /api/v1/self/details/ | Request: | GET | Function: | getProfileDetails |
updProfileDetails | |||||||
| Module: | Self | Route: | /api/v1/self/details/ | Request: | PUT | Function: | updProfileDetails |
documentationasdlkfjasldkfj | |||||||
userStatus | |||||||
| Module: | Self | Route: | /api/v1/misc/status/ | Request: | PUT | Function: | userStatus |
expireUser | |||||||
| Module: | Self | Route: | /api/v1/self/daemon/ | Request: | GET | Function: | expireUser |
createExternalUser | |||||||
| Module: | Self | Route: | /api/v1/self/registration/ | Request: | POST | Function: | createExternalUser |
userExistsCheck | |||||||
| Module: | Self | Route: | /api/v1/self/userexists/:username | Request: | GET | Function: | userExistsCheck |
getUserDetails | |||||||
| Module: | Self | Route: | /api/v1/self/user/details/:id | Request: | GET | Function: | getUserDetails |
getSettings | |||||||
| Module: | Shape | Route: | /api/v1/assets/settings/:setting | Request: | GET | Function: | getSettings |
getSetting | |||||||
| Module: | Shape | Route: | /api/v1/assets/setting/:type/:name | Request: | GET | Function: | 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: | Shape | Route: | /api/v1/assets/settings/:id | Request: | PUT | Function: | saveSettings |
getSettingValue | |||||||
| Module: | Shape | Route: | /api/v1/assets/settingvalue/:type/:name | Request: | GET | Function: | 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: | Shape | Route: | /api/v1/shape/config/ | Request: | POST | Function: | crtShapeSetting |
getStashFiles | |||||||
| Module: | Stash | Route: | /api/v1/stash/files/:id | Request: | GET | Function: | getStashFiles |
documentationasdlkfjasldkfj | |||||||
addStashFiles | |||||||
| Module: | Stash | Route: | /api/v1/stash/files | Request: | POST | Function: | 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: | Stash | Route: | /api/v1/stash/files/:id | Request: | PUT | Function: | updStashFiles |
documentationasdlkfjasldkfj | |||||||
delStashFiles | |||||||
| Module: | Stash | Route: | /api/v1/stash/files/:id | Request: | DELETE | Function: | delStashFiles |
documentationasdlkfjasldkfj | |||||||
setStashObject | |||||||
| Module: | Stash | Route: | /api/v1/stash/object/ | Request: | PUT | Function: | setStashObject |