CRM360° SystemApi Documentation

SystemApi Web API Help Page

Help WebApi Description

Users

Action Name Method Api Description
Login POST security/Users/Login?username={username}&password={password} Log a user and returns a validity token
ChangePassword PUT security/Users/ChangePassword?username={username}&password={password}&newPassword={newPassword} Change a user password
ResetPassword PUT security/Users/ResetPassword?username={username} Reset a user password

Me

Action Name Method Api Description
Get GET security/Me/Get Get a user using the validity token
GetPlatforms GET security/Me/GetPlatforms?includeSystem={includeSystem} Get a list of platform allowed for an authenticated user provided by validity token
SetPlatform POST security/Me/SetPlatform Creates a platform allowed for an authenticated user provided by validity token
DeletePlatform POST security/Me/DeletePlatform Deletes a platform allowed for an authenticated user provided by validity token
ValidProfileAccess GET security/Me/ValidProfileAccess?listProfileId[0]={listProfileId[0]}&listProfileId[1]={listProfileId[1]} Returns profil access validity for a list of profile ids
getListZones GET security/Me/getListZones Get list of user allowed zones
setListZones POST security/Me/setListZones Set list of user allowed zones
getListBrands GET security/Me/getListBrands Get list of user allowed brands
setListBrands POST security/Me/setListBrands Set list of user allowed brands
getListProfiles GET security/Me/getListProfiles Get list of user profiles
setListProfiles POST security/Me/setListProfiles Set list of user profiles
getListStores GET security/Me/getListStores Get list of user allowed stores
setListStores POST security/Me/setListStores Set list of user allowed stores

Shell

Action Name Method Api Description
GetTimezones GET security/Shell/GetTimezones Get a list of Timezone

Label

Action Name Method Api Description
Get GET translation/Get?labelId={labelId} get a translation for a given label id
GetAll GET translation/GetAll Get all translations for one language
GetList GET translation/GetList?key={key} Get a translation list for one language

LocalServices

Manage local services

Action Name Method Api Description
List GET ProcessManagement/Agent/Services/List Get a list of managed local services instance
Get GET ProcessManagement/Agent/Services/Get?name={name} Get a local service instance
Start GET ProcessManagement/Agent/Services/Start?name={name} Start a local service
Stop GET ProcessManagement/Agent/Services/Stop?name={name} Stop a local service
Restart GET ProcessManagement/Agent/Services/Restart?name={name} Restart a local service

Reschedule

Reschedule a Process

Action Name Method Api Description
OneTime POST ProcessManagement/Reschedule/OneTime Reschedule a process one time
Hourly POST ProcessManagement/Reschedule/Hourly Reschedule a process hourly
Daily POST ProcessManagement/Reschedule/Daily Reschedule a process daily
Weekly POST ProcessManagement/Reschedule/Weekly Reschedule a process weekly
MonthlyDayInMonth POST ProcessManagement/Reschedule/MonthlyDayInMonth Reschedule a process monthly (day in the month)
MonthlyWeekDay POST ProcessManagement/Reschedule/MonthlyWeekDay Reschedule a process monthly (week day)

Cancel

Action Name Method Api Description
Cancel POST ProcessManagement/Cancel Cancel a process

Workflow

Action Name Method Api Description
Resume POST ProcessManagement/Workflow/Resume Resume a Workflow from xml contract
ResumeFromIssue POST ProcessManagement/Workflow/ResumeFromIssue Resume a Workflow from an issue Id
Abort POST ProcessManagement/Workflow/Abort Abort a Workflow from xml contract
AbortFromIssue POST ProcessManagement/Workflow/AbortFromIssue Abort a Workflow from an issue Id