TrackingLog
The Tracking Log controller.
API | Description |
---|---|
POST utils/v2/TrackingLog/CleanLog?daysToKeepData={daysToKeepData} |
Tracking log cleaning method. |
POST utils/TrackingLog?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/TrackingLog?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ScRequest
The Service Catalog Request controller.
API | Description |
---|---|
POST utils/v1/SCRequest/SCRequestSync |
The service catalog request sync. |
POST utils/ScRequest?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ScRequest?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ExternalShipment
The external shipment controller.
API | Description |
---|---|
POST utils/v2/ExternalShipment/UpdateStatus |
The update status. |
POST utils/v2/ExternalShipment/UpdateShipmentStatus |
Updates the shipment status. |
POST utils/v2/ExternalShipment/FixShipmentsCurrentStatus |
Fixes the shipments current status. |
ServiceNowCostCenter
The service now cost center controller.
API | Description |
---|---|
POST utils/v1/ServiceNowSync/CostCenterSync |
The cost center. |
POST utils/ServiceNowCostCenter?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ServiceNowCostCenter?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Comment
Comment controller.
API | Description |
---|---|
GET utils/v2/Comment/GetComments?serviceRequestEventId={serviceRequestEventId}&referenceNumber={referenceNumber}&commentCategoryName={commentCategoryName} |
Gets the comments for a specific service request event. |
POST utils/v2/Comment/AddComment?serviceRequestEventId={serviceRequestEventId}&referenceNumber={referenceNumber} |
Add a comment for a specific service request event. |
POST utils/v2/Comment/AcknowledgeComments |
The acknowledge comments. |
POST utils/Comment?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Comment?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ServiceRequestEventFiles
Methods to manage file uploads.
API | Description |
---|---|
POST utils/v2/ServiceRequestEvent/Upload |
Uploads file method. |
GET utils/v2/ServiceRequestEvent/GetFiles?requestId={requestId} |
Get a list with all files related with the Service Request Event. |
POST utils/ServiceRequestEventFiles?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ServiceRequestEventFiles?errorMessage={errorMessage}&status={status} |
The update many notifications. |
FieldService
Methods to manage the Field Service. A valid Token is required for any request.
ImportFromFTP
The import from ftp controller.
API | Description |
---|---|
POST utils/v2/FTPImport/ProcessFMPro |
The read. |
POST utils/ImportFromFTP?reactionId={reactionId} |
The execute reaction. It needs to be 'public' because the background job require a public methods. |
POST utils/ImportFromFTP?reactionId={reactionId}&recurringJobId={recurringJobId}&recurrentJobCronExpression={recurrentJobCronExpression} |
The execute recurrent reaction. |
POST utils/ImportFromFTP?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ImportFromFTP?errorMessage={errorMessage}&status={status} |
The update many notifications. |
SessionConnectionStatus
Connection Status controller.
API | Description |
---|---|
GET utils/v1/SessionConnectionStatus/Status?applicationName={applicationName} |
Gets the connection status from Service Now and DWPA Database. |
POST utils/SessionConnectionStatus?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/SessionConnectionStatus?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Reactions
The reactions controller.
API | Description |
---|---|
POST utils/v2/reactions/QueueAction |
The queue action. |
POST utils/v2/reactions/ReQueueJob?jobId={jobId}&restart={restart} |
The re queue job. |
POST utils/v2/reactions/StopRecurrentJob |
The stop recurrent job. |
POST utils/v2/reactions/RemoveAllRecurrentJobs |
The remove all recurrent jobs. |
POST utils/Reactions?reactionId={reactionId} |
The execute reaction. It needs to be 'public' because the background job require a public methods. |
POST utils/Reactions?reactionId={reactionId}&recurringJobId={recurringJobId}&recurrentJobCronExpression={recurrentJobCronExpression} |
The execute recurrent reaction. |
POST utils/Reactions?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Reactions?errorMessage={errorMessage}&status={status} |
The update many notifications. |
StockroomInventoryManagementProfile
The stockroom inventory management profile controller.
API | Description |
---|---|
POST utils/v2/StockRoomInventory/CreateInventorySnapshotReport |
The produce DWPA Pro file |
POST utils/StockroomInventoryManagementProfile?reactionId={reactionId} |
The execute reaction. It needs to be 'public' because the background job require a public methods. |
POST utils/StockroomInventoryManagementProfile?reactionId={reactionId}&recurringJobId={recurringJobId}&recurrentJobCronExpression={recurrentJobCronExpression} |
The execute recurrent reaction. |
POST utils/StockroomInventoryManagementProfile?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/StockroomInventoryManagementProfile?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Exception
The exception controller. NEX-4169
API | Description |
---|---|
POST utils/v2/Exception/ServiceRequestEvent/Open |
The open sre exception. NEX-4169 |
POST utils/v2/Exception/ServiceRequestEvent/Close |
The close sre exception. NEX-4169 |
POST utils/v2/Exception/ServiceRequestEvent/CloseAny |
The close all Service request event exception. NEX-4169 |
GET utils/v2/Exception/ExceptionTypes |
The get exception types. NEX-4169 |
GET utils/v2/Exception/ClosedReasons |
The get closed reasons. NEX-4169 |
GET utils/v2/Exception/ExceptionStatuses |
The get exception statuses. NEX-4169 |
POST utils/Exception?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Exception?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ExceptionTypeCatalogV3
The exception type catalog v 3 controller.
API | Description |
---|---|
GET utils/exceptionTypeCatalog |
The get. |
Authentication
Authentication Methods.
API | Description |
---|---|
POST utils/v1/Authentication/authenticate |
Authenticate if the credentials provided in the header are valid. This method use Basic Authentication (User:Password Base64 encoded). |
POST utils/v1/Authentication/authToken?token={token} |
Authenticate if the credentials provided in the token are valid. |
POST utils/Authentication?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Authentication?errorMessage={errorMessage}&status={status} |
The update many notifications. |
SecurityV3
The security controller.
API | Description |
---|---|
GET utils/Security |
Gets the information through the token header. |
GET utils/Security/{token} |
Gets the information through the token parameter. |
NotificationException
The notification exception controller.
API | Description |
---|---|
POST utils/v1/Notification/Exception |
The notify exception. |
POST utils/NotificationException?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/NotificationException?errorMessage={errorMessage}&status={status} |
The update many notifications. |
EquipmentConfigurationService
Equipment controller.
API | Description |
---|---|
POST utils/v2/EquipmentConfigurations |
The Update EquipmentConfiguration. |
POST utils/EquipmentConfigurationService?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/EquipmentConfigurationService?errorMessage={errorMessage}&status={status} |
The update many notifications. |
LoaderTest
The loader test controller.
API | Description |
---|---|
GET utils/v1/LoaderTest/Execute |
The execute. |
POST utils/v1/LoaderTest/GetActiveConnections |
The get active connections. |
POST utils/LoaderTest?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/LoaderTest?errorMessage={errorMessage}&status={status} |
The update many notifications. |
SlaException
The SLA Exception Controller class.
API | Description |
---|---|
POST utils/v1/SLAException/ExecuteRules |
Creates a new ticket based on the request. |
POST utils/SlaException?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/SlaException?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ScheduleEventGenerator
Schedule Event Generator Class.
API | Description |
---|---|
POST utils/v1/ScheduleEventGenerator/Execute?time={time} |
Create a new ticket based on the request. |
POST utils/v1/ScheduleEventGenerator/EquipmentExecution |
The equipment execution. |
POST utils/ScheduleEventGenerator?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ScheduleEventGenerator?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ContactService
The catalog controller.
API | Description |
---|---|
POST utils/v2/Contact/UpdatePhoneAndPersona |
The update phone and persona. |
GET utils/v2/Contact/GetContacts?firstName={firstName}&lastName={lastName}&email={email}&employeeId={employeeId}&customer={customer} |
Get the Contact. |
POST utils/ContactService?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ContactService?errorMessage={errorMessage}&status={status} |
The update many notifications. |
EquipmentGroupV3
The EquipmentGroup controller.
API | Description |
---|---|
GET utils/SREGroup/{customerId}/{groupName}/{scheduleBeginDate}/{scheduleEndDate} |
Gets the Equipment Group info through the Customer Id and other optional parameters. |
Users
User Controllers
API | Description |
---|---|
POST utils/v2/Users/DeleteBackgroundExportedFiles?data={data} |
The delete the exported files generated |
POST utils/Users?reactionId={reactionId} |
The execute reaction. It needs to be 'public' because the background job require a public methods. |
POST utils/Users?reactionId={reactionId}&recurringJobId={recurringJobId}&recurrentJobCronExpression={recurrentJobCronExpression} |
The execute recurrent reaction. |
POST utils/Users?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Users?errorMessage={errorMessage}&status={status} |
The update many notifications. |
PersonaV3
The Persona controller.
API | Description |
---|---|
GET utils/persona |
Gets the information through the token header. |
ApplicationCatalogService
Equipment controller.
API | Description |
---|---|
POST utils/v2/ApplicationCatalog/RefreshApplicationCatalog?CurrentUser={CurrentUser} |
The Update Application Catalog. |
POST utils/ApplicationCatalogService?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ApplicationCatalogService?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Areas
Areas controller
API | Description |
---|---|
GET api/v1/Areas/GetBuildingsInfo?city={city}&state={state}&building={building} |
The building search. |
GET api/v1/Areas/GetConferenceRoomInfo?building={building}&floor={floor}&room={room}&alias={alias} |
The conference room search. |
GET api/v1/Areas/GetDetailConferenceRoomInfo?building={building}&floor={floor}&room={room}&alias={alias} |
The detail conference room info. |
POST utils/Areas?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Areas?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ServiceNowIncident
Service Now Sync Controller Class.
API | Description |
---|---|
POST utils/v1/ServiceNowSync/IncidentsSync |
Method for getting incidents and sync with Service Request Event table. |
POST utils/ServiceNowIncident?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ServiceNowIncident?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Equipment
Equipment controller.
API | Description |
---|---|
GET utils/v1/Equipment/GetEquipmentTypes?equipmentTypeId={equipmentTypeId} |
Gets the equipment types and its corresponding classification data. |
GET utils/v1/Equipment/GetEquipmentCatalog |
The get equipment catalog. |
POST utils/Equipment?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Equipment?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Holiday
The holiday controller.
API | Description |
---|---|
POST utils/v1/Holiday/CheckFixed |
The check fixed. |
POST utils/Holiday?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Holiday?errorMessage={errorMessage}&status={status} |
The update many notifications. |
SchedulingCapacity
The scheduling capacity controller.
LocationService
The location service controller.
API | Description |
---|---|
GET utils/v2/Location/GetLocations?locationName={locationName}&street={street}&city={city}&state={state}&country={country} |
Get location. |
GET utils/v2/Location/GetStates?stateCode={stateCode}&countryCode={countryCode} |
Get states. |
GET utils/v2/Location/GetCountries?countryCode={countryCode} |
Get countries. |
POST utils/LocationService?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/LocationService?errorMessage={errorMessage}&status={status} |
The update many notifications. |
JobScheduler
The job scheduler controller.
API | Description |
---|---|
POST utils/v1/JobScheduler/Execute?time={time} |
The execute. |
POST utils/JobScheduler?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/JobScheduler?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ServiceNowSync
Service Now Sync Controller Class.
Customer
Customer Controller
API | Description |
---|---|
GET utils/v2/Customer/GetCustomerList?name={name} |
The get customer list. |
POST utils/Customer?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Customer?errorMessage={errorMessage}&status={status} |
The update many notifications. |
HardwareRule
The hardware rule controller.
API | Description |
---|---|
GET utils/v2/HardwareRule/GetHardwareRuleByServiceRequestEvent?referenceNumber={referenceNumber}&oid={oid} |
The get hardware rule by service request event. |
POST utils/HardwareRule?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/HardwareRule?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Catalog
The catalog controller.
API | Description |
---|---|
GET utils/v2/Catalog/GetPersonaList |
The get persona list. |
GET utils/v2/Catalog/GetDeviceRoleList |
The get device role list. |
GET utils/v2/Catalog/GetExceptionList |
The get exception list. |
GET utils/v2/Catalog/GetSREGroupsList?customerId={customerId}&groupName={groupName}&scheduleBeginDate={scheduleBeginDate}&scheduleEndDate={scheduleEndDate} |
The get service request event groups list. |
POST utils/Catalog?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Catalog?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ConnectionStatus
Connection Status controller.
API | Description |
---|---|
GET utils/v1/ConnectionStatus/Status?applicationName={applicationName} |
Gets the connection status from Service Now and DWPA Database. |
POST utils/v1/ConnectionStatus/HangFire?command={command} |
The endpoint was created to start or stop the HangFire manually in case that something fails |
POST utils/ConnectionStatus?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ConnectionStatus?errorMessage={errorMessage}&status={status} |
The update many notifications. |
DeviceRoleV3
The device role v 3 controller.
API | Description |
---|---|
GET utils/deviceRole |
Gets the information through the token header. |
Upload
Methods to manage file uploads.
API | Description |
---|---|
POST utils/v1/FieldService/UploadFile |
Uploads file method. |
POST utils/Upload?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Upload?errorMessage={errorMessage}&status={status} |
The update many notifications. |
EquipmentService
Equipment controller.
Audit
The audit controller.
API | Description |
---|---|
POST utils/v2/Audit/Clean?cutOffDate={cutOffDate}&userId={userId} |
The clean audit. |
POST utils/v2/Audit/CleanLog?cutOffDate={cutOffDate}&userId={userId} |
The clean log. |
POST utils/Audit?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Audit?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Location
The external services controller.
API | Description |
---|---|
GET utils/v1/External/Services/GetExternalLocation?locationNumber={locationNumber}&deliveryRoom={deliveryRoom} |
Method for getting locations from DWPA. |
POST utils/Location?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Location?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ExportToFTP
The import from ftp controller.
ServiceRequestEvent
The service request event controller. NEX-2386.
Administration
Administration Controller class.
API | Description |
---|---|
GET utils/v1/Administration/isConnected |
Determines whether the user has connection to the DB or not. |
POST utils/Administration?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Administration?errorMessage={errorMessage}&status={status} |
The update many notifications. |
CustomField
The custom field controller.
API | Description |
---|---|
GET utils/v2/CustomField/GetListValuesByName?customFieldName={customFieldName} |
The get list values by name. |
POST utils/v2/CustomField/SynchronizeCustomFields?serviceRequestId={serviceRequestId} |
Synchronizes custom field values with their corresponding node values. |
POST utils/CustomField?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/CustomField?errorMessage={errorMessage}&status={status} |
The update many notifications. |
ExternalServices
The external services controller.
API | Description |
---|---|
POST utils/v1/External/Services/SynchronizeEquipment |
The synchronize equipment. NEX-2401 |
POST utils/v1/External/Services/SyncSkuItems |
The synchronize SKU items. |
GET utils/v1/External/Services/SearchExternalEquipment?assetTag={assetTag}&checkNew={checkNew}&typeName={typeName} |
The search external equipment. |
GET utils/v1/External/Services/GetExternalContact?bemsId={bemsId} |
The search external contact. |
POST utils/v1/External/Services/DWPAPendingDisposal?serviceRequestId={serviceRequestId}¬ificationId={notificationId} |
Call DWPA Pending disposal method |
POST utils/v1/External/Services/CompleteAITReservation?serviceRequestId={serviceRequestId}¬ificationId={notificationId} |
Call Complete AIT Reservation method |
POST utils/ExternalServices?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/ExternalServices?errorMessage={errorMessage}&status={status} |
The update many notifications. |
Base
Base class for API Controllers. Contains basic methods and properties to be used in their delegates.
API | Description |
---|---|
POST utils/Base?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/Base?errorMessage={errorMessage}&status={status} |
The update many notifications. |
HangFireBase
The hang fire base controller.
API | Description |
---|---|
POST utils/HangFireBase?reactionId={reactionId} |
The execute reaction. It needs to be 'public' because the background job require a public methods. |
POST utils/HangFireBase?reactionId={reactionId}&recurringJobId={recurringJobId}&recurrentJobCronExpression={recurrentJobCronExpression} |
The execute recurrent reaction. |
POST utils/HangFireBase?description={description}¬ificationTraceId={notificationTraceId} |
The update Notification. |
POST utils/HangFireBase?errorMessage={errorMessage}&status={status} |
The update many notifications. |