Resources
 
POST /dmg‑rest/event‑update/{event}
Update all active customer damage reports for the passed event, using the passed action.
Parameters
Name
Type
Description
event
required
path[integer]
The event index to update.
action
query[string
the action string (like assessed, failed, and so on)
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /dmg-rest/reports
Retrieves damage reports or given query parameters.
Supported query types:
• Location - returns damage reports within the given radius from the specified location. Parameters lat, long, and rad are required for this query type.
• Patrol - returns damage reports associated with the given patrol event. Parameter patrol is request for this query type.
• Event - returns damage reports associated with the given event. Parameter event is request for this query type.
Note: Parameters from different query types cannot be mixed (for example, it is not possible to request damage reports for a patrol event which are location near specific point).
Parameters
Name
Type
Description
lat
query[floating-point]
Latitude of the location.
long
query[floating-point]
Longitude of the location.
rad
query[floating-point]
Radius in meters.
event
query[integer]
Event index.
patrol
query[integer]
Patrol event index.
device
query[string]
Device handle.
 
Success Response
• Code: 200
Content: Array of JSON objects representing damage reports.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /dmg-rest/reports
Creates new damage report.
Parameters
Name
Type
Description
unnamed
required
data1
JSON representation of a damage report.
action
query[string]
State transition action when saving damage report (for example, assess).
1 'data' parameters represent the body of a POST or PUT request. Such parameters do not have a name thus 'unnamed' in the list of parameters.

Success Response
• Code: 201 Created
Content: JSON representation of the created damage report.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /dmg-rest/reports/config/{cfg}
Parameters
Name
Type
Description
cfg
path[string]
Type of configuration items to return.
 
Available types of configuration items:
• repair-times: damage assessment repair time configuration from the DAMAGE_REPAIR_TIMES_VIEW database view
• asset_statuses: records from the MESSAGE_CODE_LOOKUP where MESSAGE_TOPIC equals 'DA_ASSET_STATUS'
• asset_conditions: records from the MESSAGE_CODE_LOOKUP where MESSAGE_TOPIC equals 'DA_ASSET_CONDITION'
• phases: phase labels from PHASE_BITMAP_LOOKUP table
Success Response
• Code: 200
Array of JSON objects representing requested configuration items.
• Code: 204 No Content.
Nothing found for the requested configuration type.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /dmg-rest/reports/{id}
Retrieves existing damage report by id.
Parameters
Name
Type
Description
id
required
path[integer]
Damage report identifier.
Success Response
• Code: 200
Content: JSON or XML representation of a damage report.
Error Response
• Code: 204
No Content. Damage report with the given identifier were not found.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /dmg-rest/reports/{id}
Updates existing damage report.
Parameters
Name
Type
Description
id
required
path[integer]
Damage report identifier.
action
query[string]
State transition action when saving damage report (for example, assess).
unnamed
required
data
JSON representation of a damage report.
Success Response
• Code: 200
Content: JSON representation of a damage report.
Error Response
• Code: 204 No Content.
Damage report with the given identifier were not found.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /dmg-rest/reports/{id}/attachments/{att_id}
Retrieves content of an existing damage report attachment.
Parameters
Name
Type
Description
id
required
path[integer]
Damage report identifier.
att_id
required
path[string]
Attachment name/identifier.
w
query[string]
If image, reduce width to w pixels.
h
query[string]
If image, reduce height to h pixels.
Success Response
• Code: 200
Content: Binary attachment data (e.g., image)
Error Response
• Code: 204
No Content. Requested attachment does not exist.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
PUT /dmg-rest/reports/{id}/attachments/{att_id}
Uploads contents of a damage report attachment.
Note: This API only uploads the binary attachment data to the server. The list of attachments is part of the damage report itself.
Parameters
Name
Type
Description
id
required
path[integer]
Damage report identifier.
att_id
required
path[string]
Attachment name/identifier.
unnamed
required
data
Attachment data.
Success Response
• Code: 201 Created
Error Response
• Code: 204 No Content.
Requested attachment does not exist.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
DELETE /dmg-rest/reports/{id}/attachments/{att_id}
Deletes a damage report attachment.
Parameters
Name
Type
Description
id
required
path[integer]
Damage report identifier.
att_id
required
path[string]
Attachment name/identifier.
Success Response
• Code: 204 No Content
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /dmg-rest/reports/required-parts
Retrieves list of required parts and materials which are configured in NMS.
Parameters
None.
Success Response
• Code: 200
Content: Array of JSON objects representing all known required parts
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/application/{name}/{arch}
Returns the latest version of the application for the given Application Name and Architecture in .zip format.
Parameters
Name
Type
Description
name
path[string]
Name of the application (OMA).
arch
path[string]
Architecture of the application. Can be one of these values: ANDROID, IOS, WIN10, BROWSER.
Response
• Code: 200
The return data will be the application in .zip format. If there is no version available matching the app Name and App Architecture, an exception is returned.
GET /mobile/application/{name}/{arch}/{version}
Returns the application for the given Application Name, Application version and Architecture in .zip format.
Parameters
Name
Type
Description
name
path[string]
Name of the application (OMA).
arch
path[string]
Architecture of the application. Can be one of these values: ANDROID, IOS, WIN10, BROWSER.
version
path[integer]
Version of the application.
Response
• Code: 200
The return data will be the application in .zip format. If there is no application matching the app Name, app Version and App Architecture, an exception is returned.
GET /mobile/application-version/{name}/{arch}
Returns the latest version number of the application for the given Application Name and Architecture.
Parameters
Name
Type
Description
name
path[string]
Name of the application (OMA).
arch
path[string]
Architecture of the application. Can be one of these values: ANDROID, IOS, WIN10, BROWSER
Response
• Code: 200
The return data will be the latest application version number. If there is no version available matching the app Name and App Architecture, a -1 is returned.
GET /mobile/application-versions/{name}/{arch}
Returns a list of available version numbers of the application for the given Application Name and Architecture.
Parameters
Name
Type
Description
name
path[string]
Name of the application (OMA).
arch
path[string]
Architecture of the application. Can be one of these values: ANDROID, IOS, WIN10, BROWSER
Response
• Code: 200
The return data will be a list of integers for the version numbers of the application that are available. If there is no version available matching the app Name and App Architecture, an empty list is returned.
GET /mobile/attachments/{report-type}/{report-id}/{attachment-id}
Get attachment from the nms_attachments table for the given report.
Parameters
Name
Type
Description
report-type
path[string]
Report type to get attachment for; for example, DA or TE.
report-id
required
path[integer]
Report index to get attachment for
attachment-id
required
path[string]
Attachment ID of requested attachment.
w
optional
query[Integer]
If image, reduce the width to this value, if not provided, no reduction.
h
optional
query[Integer]
If image, reduce the height to this value, if not provided, no reduction.
Success Response
Content: byte[] of the attachment data
• Code: 200
Content: The return value will be the attachment.
Error Response
• Code: 500 Unspecified service error has occurred.
Content: May describe the issue encountered.s
PUT /mobile/attachments/{report-type}/{report-id}/{attachment-id}
Put a new attachment from the nms_attachments table for the given report.
Parameters
Name
Type
Description
report-type
path[string]
Report type to get attachment for; for example, DA or TE.
report-id
required
path[integer]
Report index to get attachment for
attachment-id
required
path[string]
Attachment ID of requested attachment. Must be unique for the given report ID.
uri
optional
query[uri]
URI to use for a link attachment
desc
optional
query[string]
Description to use for the attachment.
attachment
data[byte[]]
Data used for the attachment. Not used for link attachments.
Response
• Content: Identifier of the created or updated attachment.
• Code: 201 The attachment was successfully saved
• Code: 500 Unspecified service error has occurred.
Content may describe the issue encountered.
DELETE /mobile/attachments/{report-type}/{report-id}/{attachment-id}
Delete an attachment from the nms_attachments table for the given report.
Parameters
Name
Type
Description
report-type
path[string]
Report type to delete attachment for; for example, DA or TE.
report-id
required
path[integer]
Report index to delete attachment for
attachment-id
required
path[string]
Attachment ID of attachment to delete.
Success Response
• Code: 204 The request was completed.
Error Response
• Code: 500 Unspecified service error has occurred.
Content may describe the issue encountered.
POST /mobile/condition/{class}
Create a condition with the given class, status, and text for the given device.
Parameters
Name
Type
Description
class
path[string]
Name of the class of conditions
status
query[integer]
Status of the class
dev-class
query[integer]
Handle Class number of the device
dev-index
query[integer]
Handle Index number of the device
text
path[string]
Text to be saved with the condition
phases
optional
query[integer]
Phases of device to apply the condition to. Defaults to 0.
node
optional
query[integer]
Phases of device to apply the condition to. Defaults to "0.0".
external-id
optional
query[string]
External ID to give the condition.
ignore-authority
optional
query[boolean]
Ignore checking for user authority when creating the condition. Defaults to True
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Returns the condition index of the new condition created.
GET /mobile/condition/{class}/{id}
Return condition details given the condition class and id.
Parameters
Name
Type
Description
class
required
path[string]
Condition class name
id
required
path[integer]
Condition index
Success Response
• Code: 200
Content: Condition details including handle, affected device handle, node, who created, class name, partition, when created, condition status, phases, ncg, x/y coordinates, application string, text, condition specific data, and external id.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
DELETE /mobile/condition/{class}/{id}
Deletes the given condition.
Parameters
Name
Type
Description
class
required
path[string]
Condition class name
id
required
path[integer]
Condition index
phases
optional
query[integer]
Phases of device to apply the condition to. Defaults to 0.
ignore-authority
optional
query[boolean]
Ignore checking for user authority when creating the condition. Defaults to True.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None.
PUT /mobile/condition/{class}/{id}/{status}
Updates the given condition's status to the given status.
Parameters
Name
Type
Description
class
path[string]
Class Name of the condition
id
path[integer]
Id of the condition
status
path[integer]
The new status of the condition
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Response
• Code: 200:
Content: None.
PUT /mobile/condition/{class}/{id}/text/{text}
Updates the text value of a given condition.
Parameters
Name
Type
Description
class
required
path[string]
Condition class name
id
required
path[integer]
Condition index
text
required
path[string]
Text value to update to condition
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/conditions
Retrieves conditions for given geographical area.
Parameters
Name
Type
Description
lat1
required
query[floating-point]
Latitude of the top left corner of the area
lat2
required
query[floating-point]
Latitude of the bottom right corner of the area.
long1
required
query[floating-point]
Longitude of the top left corner of the area
long2
required
query[floating-point]
Longitude of the bottom right corner of the area
qt
optional
query[string]
Query type.
Valid values:
• da: damage reports
• event: events
• incident: calls and other incidents
• truck: truck dispatch locations
All conditions are returned if this parameter is not provided.
Success Response
• Code: 200
Content: Array of JSON objects representing conditions.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/conditions/{class}
Returns a list of conditions for the requesting authentication user name of the given condition class.
Parameters
Name
Type
Description
class
path[string]
Name of the class of conditions.
as-user
optional
query[string]
Query for conditions created by the specified user instead of the authentication user.
Response
• Code: 200
The return data will be a list of conditions
GET /mobile/conditions/device/{handle}
Returns a list of conditions on the specified device handle
Parameters
Name
Type
Description
handle
required
path[hande]
Handle of the device to get conditions for; for example, 148.1001.
Response
• Code: 200
The return data will be a list of conditions.
PUT /mobile/confirm-services
Update service and secondary events for the given list of services.
Parameters
Name
Type
Description
action
required
query[service, secondary, restore, groupable]
Action to perform on the list of customer updates.
crew
optional
query[integer]
Crew key of the crew to be assigned to newly created events.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
updates
required
data[updates]
A list of customer service updates.
Example
[{"cust_id":"2001637-2001637-2001637","address":"10586 MOGADORE AVE NW, Lake Twp., OH, 44685","ctype":"","comment":"confirmed outage","device":{"class_number":207,"app":0,"instance_number":2217},"event":{"class_number":800,"app":0,"instance_number":2750},"bitmask":0}]
Success Response
• Code: 200
Content: OK
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified service error has occurred
GET /mobile/confirm-services/{handle}
Get a list of customers with secondary and service outage details for the given device or event handle.
Parameters
Name
Type
Description
handle
required
path[Handle string]
Handle of a device or event to get the customers for.
max-supply-nodes
optional
query[integer]
Maximum number of supply nodes to return the customer list from. Defaults to 100.
Response
• Code: 200
The return value will be a object of customer IDs with a list of customer details. The details will include one for the customerId and additional customer details is the customer is involved with an existing service or secondary event.
• Code: 204
No customers for the given device or event handle
• Code: 500
Unspecified service error has occurred
GET /mobile/control-zones
Retrieves list of control zones NMS.
Parameters
None.
Success Response
• Code: 200
Content: Array of JSON objects representing all NMS control zones
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/create-new-account
Creates new account with the specified username and password. The server checks whether the provided user key is valid and have not exhausted its account creation quota.
Parameters
Name
Type
Description
new-user-key
required
query[string]
User key.
platform
optional
query[string]
The device type used to create the account, will be added to the user log, defaults to blank.
uuid
optional
query[string]
The device uuid used to create the account, will be added to the user log.
Success Response
• Code: 200
Content: User information in JSON format. If account creation is unsuccessful negative value is returned in the userId field.
Error Response
• Code: 500 Internal Server Error
Unspecified error has occurred.
Note: This request does not require Authorization header.
POST /mobile/crew
Update crew information. This is a stub API and not yet implemented.
Parameters
Name
Type
Description
crew
data
Mobile Crew Information
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: updated Mobile Crew information
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Errors
Unspecified error has occurred
GET /mobile/crews
Retrieves list of crews present in NMS. Depending on permissions of the mobile user either all or only MDT crews are returned.
Parameters
None.
Success Response
• Code: 200
Content: Array of JSON objects representing crews.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crews/{id}
Retrieves information for a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
Success Response
• Code: 200
Content: Crew information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crews/{id}/assignments
Retrieves list of current assignments for a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
include-unsent-assignments
optional
query[boolean]
If value is true, include events assigned to the crew, but not yet sent to the crew.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/assign
Adds assignment of a crew to an event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Event index.
as-user
optional
query[string]
User to do the API call as. Calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000.
mark-sent
optional
query[boolean]
Mark the event as sent to the crew. Default is false.
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew, but not yet sent to the crew.
include-related
optional
query[boolean]
If value is true, assign related events for the crew too.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/dispatch
Places a crew en-route to an event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Event index.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000.
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew but not yet sent to the crew.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/onsite
Places a crew onsite for an event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Event index.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000.
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew, but not yet sent to the crew.
onsite-flag
optional
query[boolean]
If true, mark the crew status as on-site. If false, if the crew was on site, this will transition them to en route. Default is true.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/unassign
Removes assignment of a crew to an event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Event index.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew, but not yet sent to the crew.
include-related
optional
query[boolean]
If value is true, undispatch related events for the crew too.
Success Response
• Code: 200
Content: Array of JSON objects representing remaining crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/undispatch
Makes a crew no longer en-route or onsite for an event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Event index.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000.
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew but not yet sent to the crew.
include-related
optional
query[boolean]
If value is true, undispatch related events for the crew too.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/undispatch-and-assign
Makes a crew no longer en-route or onsite for an event but keeps the assignment of the crew to the event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[string]
A list of comma separated event indices.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew, but not yet sent to the crew.
suspend
optional
query[string]
Whether to suspend the event and crew, when applicable. If no other crews are assigned to the event, it will transition to the SUS state. If the crew is not assigned to other events, the crew will become Suspended.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/assignments/{event-id}/undispatch-and-assign-and-dispatch/{new-event-id}
Places crew en-route to a different event.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
event-id
required
path[integer]
Original event index.
new-event-id
required
path[integer]
New event index.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
time
optional
query[long]
Time the assignment change occurred. Zero means current time. The value is the number of milliseconds since 1 January 1970 00:00:00.000.
include-unsent-assignments
optional
query[boolean]
If value is true, in the return value, include events assigned to the crew, but not yet sent to the crew.
Success Response
• Code: 200
Content: Array of JSON objects representing crew assignments.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crews/{id}/availability
Retrieves the current availability information for a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
Success Response
• Code: 200
Content: Crew availability information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/availability
Updates the current availability information for a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
unnamed
required
data
Crew availability information in JSON format
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: Crew availability information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crews/{id}/status
Retrieves the current status of a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
Success Response
• Code: 200
Content: Crew status information in JSON format. Possible crew statuses: Inactive, OnShift, OffShift.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /mobile/crews/{id}/status
Updates current status of a crew.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
unnamed
required
data
Crew status information in JSON format.
Valid crew statuses:
• OnShift
• OffShift
• Inactive
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: Crew status information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crews/user
Retrieves crew information for a mobile user.
Parameters
Name
Type
Description
as-user
optional
path[string]
User name, defaults to authenticated user.
Success Response
• Code: 200
Content: Crew information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/crew-types
Retrieves list of crew types configured in NMS.
Parameters
None.
Success Response
• Code: 200
Content: Array of JSON objects representing crew types.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/damage-device-details
Retrieves device information for given alias.
Parameters
Name
Type
Description
device-id
required
query[string]
Device alias.
Success Response
• Code: 200
Content: Device information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/dataset/{table}
Get records from the given table where the key-field matches the key-value based on the match type. The table must appear in the mobile_datasets whilelist table.
Parameters
Name
Type
Description
table
required
path[string]
Table name to return record for.
key-field
required
query[string]
Field name to use as the selection criteria for the returned records.
key-value
required
query[string]
value matched to the key-field as the selection criteria for the returned records.
match-type
optional
query[string]
The match type to use. Options:
equals, not-equals, like, not-like, or all.
Default value is equals.
max-rows
optional
query[integer]
Limit the number of rows returned to this value. Default value is 100.
lat-long
optional
query[boolean]
Add Lat/Long attributes to the data as possible.
Response
• Code: 200 The return value will a list of record sets.
• Code: 500 Unspecified service error has occurred.
Content may describe the issue encountered.
PUT /mobile/dataset/{table}
Replace records for the given table where the key-field equals the key-value. The table must appear in the mobile_datasets whilelist table.
Parameters
Name
Type
Description
table
required
path[string]
Table name to update record for.
key-field
required
query[string]
Field name to use as the selection criteria for the returned records.
key-value
required
query[string]
Value matched to the key-field as the selection criteria for the returned records.
data
required
data
List of records (EBJResultSet) to replace in the database dataset with selection_set, column_names and serialVersionUID set. Column widths and type not required.
Success Response
• Code: 200 OK
Error Response
• Code: 500 Internal Server Error
Content may describe the issue encountered.
PUT /mobile/device/assess
Updates the passed conductors to the assessed state.
Parameters
Name
Type
Description
handles
required
data
The conductor handles to update.
Response
• Code: 200 No content returned
POST /mobile/device/{handle}/trace
Request a server trace from the given device handle.
Parameters
Name
Type
Description
handle
path[handle]
Handle of the device to initiate the trace from.
Format: class.index (for example, 147.1234).
type
query[string]
Type of trace to perform. Can be one of the following: source, all, opens, or classes.
phase
query[integer]
Phases to perform trace on. Numbers may include 1 for A phase, 2, for B phase, 3 for AB phases, 4 for C phase, 5 for AC phases, 6 for BC phases and 7 for ABC phases.
direction
query[string]
The direction to trace, can be one of the following: all, up, down.
data
data
List of Stop Class Names.
Response
Java TraceResults in JSON format including list of endpoints, list of traced objects, and list of abnormal open switches
GET /mobile/device/{id}/info
Returns information about a given device given a device handle.
Parameters
Name
Type
Description
id
required
path[string]
The device handle in the format: class.index
 
Success Response
• Code: 200
Content: Returns information about the device including alias, phases, closed phases, fully open flag, fully closed flag.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/device/{handle}/last_known_location
Returns the last known location of the given device handle.
Parameters
Name
Type
Description
handle
path{handle}
Handle of the device to get the last known location of (for example, 147.1234)
Success Response
• Code: 200
Content: Returns information about the device including coordinates, partition and coordinate system.
Error Response
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/device/{id}/lookahead/{operation}/{phases}
Returns look ahead data about the requested operation on the given device.
Parameters
Name
Type
Description
id
required
path[string]
The device handle in the format: class.index
operation
required
path[string]
Operation to perform on the device, either open or close
phases
required
path[integer]
Integer representation of the phases to operate. For example, 1=A, 2=B, 3=AB, 4=C, 5=AC, 6=BC, 7=ABC.
Success Response
• Code: 200
Content: Returns Look Ahead Information including device information, alias, phases, customers affected by phase, ato customers affected by phase, condition, abnormal devices, critical customers, and DERs.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/device/{id}/operate/{operation}/phases/{phases}/time/{time}
Performs the operation on the given phases for a device.
Parameters
Name
Type
Description
id
required
path[string]
The device handle in the format: class.index
operation
required
path[string]
Operation to perform on the device, either open or close
phases
required
path[integer]
Integer representation of the phases to operate. For example, 1=A, 2=B, 3=AB, 4=C, 5=AC, 6=BC, 7=ABC.
time
required
path[long]
Time the operation was requested. 0 = current time.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
crew-id
optional
query[integer]
The crew key, if any resulting newly created Real Outage should be assigned to the crew.
nested
optional
query[string] (Y|N)
Whether to create a nested outage (when applicable)
onsite
optional
query[string]
(Y|N)
Whether the passed crew should also be set to Onsite for the resulting event.
sheet
optional
query[integer]
Switch sheet ID associated with this control operation.
step
optional
query[integer]
Switch step ID associated with this control operation.
Success Response
• Code: 200
Content: Operation successful
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
PUT /mobile/device/unassess
Updates the passed conductors to clear the assessed state.
Parameters
Name
Type
Description
handles
required
data
The conductor handles to update.
Response
• 200: No content returned
GET /mobile/devices
Retrieves information for devices matching given device alias search string.
Parameters
Name
Type
Description
device-id
required
query[string]
Device alias search string (can contain SQL wildcard characters).
Success Response
• Code: 200
Content: Array of JSON objects representing device information.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/feeders
Retrieves list of feeders with attributes (h_cls, h_idx, feeder_name, substation_name, color, group_num, and abnormal_color).
Parameters
Name
Type
Description
Option
optional
query[string]
If "name", return feeder information structured by feeder name using the server cache. If "handle", return feeder information structured by feeder FID handle using the server cache. Otherwise, return a feeder information from the feeders table as a database dump.
Success Response
• Code: 200
Content: Array of JSON objects representing all NMS feeders
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/file/:dir_name /:file_name
Returns the requested file from the given OPERATION_MODEL subdirectory in JSON format.
Parameters
Name
Type
Description
dir-name
path[string]
Name of the OPERATIONS_MODEL subdirector
file-name
path[string]
Name of the file to retrieve
Success Response
• Code: 200
Content: JSON file format
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/get-permissions
Retrieves permissions of the mobile user.
Parameters
Name
Type
Description
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
userType
optional
query[string]
Limit permission based on user type. Default to blank.
Success Response
• Code: 200
Content: List of permissions assigned to the mobile user.
GET /mobile/geographic‑partitions
Retrieves a set of geographic partitions.
Parameters
None.
Success Response
• Code: 200
Content: Set of geographic partitions including map name, handle, and minimum-bounding-rectangle.
POST /mobile/hlm
Sends high-level message (HLM) to NMS.
Parameters
Name
Type
Description
target
required
query[string]
NMS user this HLM should be delivered to
msg
required
data
JSON representation of the HLM
HLM JSON Format
Attribute
Type
Description
from
string
Message sender
to
string
NMS tool this HLM should be delivered to
message
string
The message text
Example
POST https://nms.example.com:7102/nms-ws/mobile/hlm?target=nms2
{
"from": "nms1",
"message": "test",
"to": "CallEntry"
}
Required Permissions
Send HLM
Success Response
• Code: 204 No Content
Content: None
Error Response
• Code: 400 Bad Request
Either 'target' or 'msg' parameter is empty.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/device/{id}/customers
Get a list of customers associated with a device id, including downstream devices. The call will take a device handle and a maximum number of SND's to get customers for.
Parameters
Name
Type
Description
id
path[handle string]
Handle of the device to get customers (for example, 123.1001).
max-supply-nodes
query[integer]
Maximum number of SND's to get customers for.
use-nominal-if-deenergized
optional
query[boolean]
If the device is in a deenergized section of the model, use nominal energization to fine downstream devices.
summarize-if-limit
optional
query[boolean]
If the number of SNDs exceeds the limit, return a summary instead.
summarize-if-limit-with-crit-customers
optional
query[boolean]
If the number of SNDs exceeds the limit and returning a summary, include a list of critical customers if that list of SNDs does not exceed the limit.
Response
• Code: 200
The return value will be the list of customers in JSON double array format, where the first record of the array will be the field names, and the rest of the array will be records of just values. It is up to the client to reformat the return value into true JSON objects.
GET /mobile/{id}/customer-summary
Get a summary of critical customers associated with a device id, including downstream devices. The call will take a device handle to get customers for.
Parameters
Name
Type
Description
id
path[handle string]
Handle of the device to get customers (for example, 123.1001).
use-nominal-if-deenergized
optional
 
path[handle string]
If the device is in a deenergized section of the model, use nominal energization to fine downstream devices.
Response
• Code: 200
Content: The return value will be the list of customers in JSON double array format, where the first record of the array will be the field names, and the rest of the array will be records of just values. It is up to the client to reformat the return value into true JSON objects.
GET /mobile/lookup-types/{table}/{keyField}/{valueField}
Get a set of look up values from a table with specified integer key field and string value field. The table must be in the read_only_tables, inserted from the [project]_readonly.sql file. The table must also be in the mobile_lookup_types_tables table, inserted generally from the [project]_mobile_crew.sql file.
Parameters
See description for path parameter details.
HLM JSON Format
Example
GET https://nms.example.com:7102/nms-ws/mobile/lookup-types/crew_mobile_carriers/type_num/carrier
Returns, in JSON format:
[
{"id":0,"value":" "},
{"id":1,"value":"ATT"},
{"id":2,"value":"Verizon"},
{"id":3,"value":"T-Mobile"},
{"id":4,"value":"Sprint"},
{"id":5,"value":"US Cellular"},
{"id":10,"value":"Other"}
]
Required Permissions
None
Success Response
• Code: 200 Ok
Content: JSON lookup types with "id" and "value" pairs.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/maps
Retrieves list of map definition objects.
Parameters
None.
Success Response
• Code: 200
Content: Array of JSON objects representing map definitions.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/maps/{mapname}
Returns the requested map in GeoJSON format.
Parameters
Name
Type
Description
mapname
required
path[string]
Name of the map to retrieve.
compression
optional, defaults to 'Y'
query[string]
Indicates if the returned map is to be compressed or not by given value, Y or N.
Success Response
• Code: 200
Content: GeoJSON map.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/messages-partition-changes/{sub-id}
Given a subscription ID, get an object from NMS server containing the request status and an array of all partition changes including items like real time switch status, model builds, and condition changes.
Parameters
Name
Type
Description
sub-id
path[string]
A subscription ID from the GET:mobile/subscribe-partition-changes call.
counter
optional
query[integer]
Counter of subscription changes received. Defaults to -1.
Response
Will return an object containing the request status and an array of all partition changes including items like real time switch status, model builds, and condition changes. Will also include a boolean indicator, geojsonIndex, which will be true if the geojson index map has been updated on the server.
POST /mobile/mobile-user-logout
Notifies NMS that mobile user has logged out.
Parameters
None.
Success Response
• Code: 204 No Content
Content: None
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/mobile-user-validation
Performs validation of user credentials.
Parameters
Name
Type
Description
platform
optional
query[string]
he device type used to create the account, will be added to the user log, defaults to blank.
uuid
optional
query[string]
The device uuid used to create the account, will be added to the user log.
Success Response
• Code: 200
Content: User information in JSON format. If validation is unsuccessful value -2 is returned in the userId field.
Error Response
• Code: 500 Internal Server Error
Unspecified error has occurred.
Note: This request does not require Authorization header.
POST /mobile/partition/statuses
Given a list of partitions, return the real-time statuses and states of the electrical objects in the partitions by partition.
Parameters
Name
Type
Description
partitions
required
data
A list of partitions (integers).
Success Response
• Code: 200
Content: State and Status information by partition in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/nms-status
Returns status of the NMS system. Plain text string 'up' is returned if NMS is accessible and all critical services are operational. Otherwise returns plan text string 'down'.
Parameters
None.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/set-current-crew/{id}
Sets crew associated with this mobile user.
Parameters
Name
Type
Description
id
required
path[integer]
Crew key.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: Crew information in JSON format.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /mobile/subscribe-partition-changes
Subscribe to the NMS server for all partition changes including items like real time switch status, model builds, and condition changes.
Parameters
None
Response
Will return a subscription ID string to be used to get the changes and to unsubscribe.
GET /mobile/switch-sheets/assignments/{crew-key}
Returns a list of Mobile Switch Sheets associated to the given crew key
Parameters
Name
Type
Description
crew-key
required
path[integer]
Crew Key
returnStepsInTreeFormat
optional
query[boolean]
If specified, return data in tree format, otherwise will return in flat format. Default is false.
Success Response
• Code: 200
Content: A list of Mobile Switch Sheets, each sheet contains a sheet id, list of attribute/values, a list of steps, and a list of switch sheet associated document names and descriptions.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/switch-sheet/{sheet-cls}/{sheet-idx}
Returns a list of Mobile Switch Sheets associated to the given crew key.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
sheet class number
sheet-idx
required
path[integer]
sheet index number
steps-in-tree-format
optional
query[true/false]
whether to return the steps as a tree or a simple list. Default: false
Success Response
• Code: 200
Content: A Switch Sheet
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
PUT /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/document
Add a document to a switching sheet.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
unnamed
required
data
Document to add
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: Attachment Document details
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/document/{document-id}
Get an attached document from a switching sheet given the document ID.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
document-id
required
path[integer]
Document ID
Success Response
• Code: 200
Content: document requested
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/report
Get a formatted report for the given switching sheet.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
format
query[string]
Format of the report:
pdf (default)
html
options
query[string]
Content of the report, use the following content values fallowed by true or false for inclusion in the report, default value is true for all:
SHOW_EC:true;
SHOW_AL:true;
EXTERNAL_DOCUMENTS:true;
SHOW_SAFETY:true;
SHOW_REQUEST:true;
SHOW_IC:true;
SHOW_STEPS:true
 
Success Response
• Code: 200
Content: content of report
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}
Updates status and fields of a switch sheet step.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
step-cls
required
path[integer]
Step class number
step-idx
required
path[integer]
Step index number
action
optional
query[string]
Step transition action: complete_step, abort_step, fail_step
update-fields
optional
query[string]
Step fields that have changes: comments, switching_desc, step_details, executed_time.
time
query[long]
Time when the switch step update occurred.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
 
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}/details
Updates comments, switching description, step details, mobile status, or mobile status date of a switch sheet step.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
step-cls
required
path[integer]
Step class number
step-idx
required
path[integer]
Step index number
update-fields
optional
query[string]
Step fields that have changes, space separated:
COMMENTS, SWITCHING_DESC, STEP_DETAILS, MOBILE_STATUS, MOBILE_STATUS_TIME.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
switch-step
required
data
Switch step object that changes are applied to.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}/location
Update location (address) of a step of a switching plan.
Parameters
Name
Type
Description
sheet-cls
required
path[integer]
Sheet class number
sheet-idx
required
path[integer]
Sheet index number
step-cls
required
path[integer]
Step class number
step-idx
required
path[integer]
Step index number
unnamed
required
data
New location (Address) of the step.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: number indicating a count of the number of step that had this device location updated.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/transition
Transition the given switch sheet using the transition action name provided. Update sheet log with comment, user, and time as provided.
Parameters
Name
Type
Description
sheet-cls
path[integer]
Sheet class number
sheet-idx
path[integer]
Sheet index number
action
query[string]
Transition action to perform
comment
query[string]
Comment to add to the sheet log
time
query[long]
Time when the transition happened
as-user
query[string]
User to do the API call as.
The calling user must have "Allow as-user Parameter" mobile permission
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/unsubscribe-partition-changes/{sub-id}
Unsubscribe from the NMS server for partition changes.
Parameters
Name
Type
Description
sub-id
path[string]
A subscription ID from the GET:mobile/subscribe-partition-changes call.
Response
Will return an object containing the request status.
PUT /mobile/user-profile/{field-name}/{value}
Updates the requesting users profile for the given field-name with the given value.
Parameters
Name
Type
Description
field-name
required
path[string]
Profile field to update.
Names include:
• First name
• Last name
• Email
• Phone
• Company
value
required
path[string]
Value to set field to.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: User information including all profile value
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /mobile/version
Get the version of the mobile application.
Parameters
None.
Success Response
• Code: 200
Content: Version information for the NMS Application Server and the NMS Mobile Server including items like build date, build tag, project name, NMS version, and server host name.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /trbl-rest/config/{cfg}
Retrieves NMS Trouble Management configuration items.
Parameters
Name
Type
Description
cfg
optional
path[string]
Configuration type. One of the following:
• picklist: event completion choices, from the PICKLIST_GUI table.
• trouble-queue: trouble queue options, from the RAPID_REFERRAL table.
• crew-members: crew member type options, from the CREW_MEMBER_CLASSES table.
• te-state-actions: All act_key, act_name from the TE_STATE_ACTIONS configuration table. This can be used to determine which state transitions are valid for a given event.
Success Response
• Code: 200
Content: JSON representation of the requested configuration item.
Error Response
• Code: 204 No Content
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
PUT /trbl-rest/event/{id}/confirm-outage
Will confirm open the device associated with a probable outage Event.
Parameters
Name
Type
Description
id
required
path[integer]
Event Idx
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/event/{id}/confirm-pso
Allows to convert a single-call PSO into CSVO and restore CSVO and CSCO events.
Parameterss
Name
Type
Description
id
required
path[integer]
Event index
restore
optional
query[boolean]
Whether outage should be confirmed or restored.
Success Response
• Content: None.
• Code: 204
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/event/{id}/log
Add an Event Log entry to the given event.
Parameters
Name
Type
Description
id
required
path[integer]
Event ID
logEntry
required
data[string]
Log message
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/event/{id}/log-once
Add an Event Log entry to the given event; verify it has not already been added before.
Parameters
Name
Type
Description
id
required
path[integer]
Event ID
logEntry
required
data[string]
Log message
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
PUT /trbl-rest/event/{id}/release-all
Release all crews from the event
Parameters
Name
Type
Description
id
required
path[integer]
Event ID
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/event/{id}/state-transition
Request a state transition for the passed event.
Parameters
Name
Type
Description
id
required
path[integer]
Event ID
action
required
data[string]
The TE state action to be used to transition the event.
alarms
optional
query[string]
Comma separated list of alarm indices.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/events/all-events
Retrieves a list of events with the given indexes.
Parameters
Name
Type
Description
unnamed
required
data
List of event ids in JSON format.
max_calls
query[integer]
Maximum number of calls to return about the event. Default: 10.
trace_to_switch
query[char]
Y/N
If value is Y, will also trace to the first upstream switch and store that. Default: N.
Success Response
• Code: 200
Content: JSON representation of NMS events
Error Response
• Code: 204 No Content
Event with the given indexes were not found.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
GET /trbl-rest/events/{id}
Retrieves an event with the given index.
Parameters
Name
Type
Description
id
required
path[integer]
Event index.
max_calls
query[integer]
Maximum number of calls to return about the event. Default: 10.
include_all_related_events
optional
query[boolean]
If value is true, include all related events too.
extended
query[char]
If value is 'Y', will return the NMS TroubleEvent structure in addition to the Event structure.
trace_to_switch
query[char]
Y/N
If value is Y, will also trace to the first upstream switch and store that in the upstreamSwitch Event field.
Success Response
• Code: 200
Content: JSON representation of an NMS event or the NMS Event and TroubleEvent.
Error Response
• Code: 204 No Content
Event with the given index was not found.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /trbl-rest/events/{id}
Updates information for an event. The following event fields can be updated: case notes, ERT, Event Details picklists. Event can also be restored and completed.
Parameters
Name
Type
Description
id
required
path[integer]
Event index.
unnamed
required
data
Event information in JSON format.
as-user
optional
query[string]
User to do the API call as. The calling user must have "Allow as-user Parameter" mobile permission.
Success Response
• Code: 204 No Content
Error Response
• Code: 400 Bad Request
Event index mismatch between resource URL and body.
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /trbl-rest/events/{id}/associate
Associates fuzzy event to a device.
Parameters
Name
Type
Description
id
required
path[integer]
Event index
unnamed
required
data[json]
Device handle
as-user
optional
query[string]
The user to do the API call as. The calling user must have the 'Allow as‑user Parameter' mobile permission.
Payload Example
{
"app": 0,
"classNumber": 206,
"instanceNumber": 2149
}
Success Response
• Code: 204
Content: No Content
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
GET /trbl-rest/events/{id}/customers
Get the customer information for the passed event index. This includes all custom fields from the CES_CUSTOMERS table.
Parameters
Name
Type
Description
id
required
path[integer]
Event ID
Success Response
• Code: 200
Content: double array of customer information.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
PUT /trbl-rest/events/{id}/trouble-queue
Updates trouble queue(s) for an event.
Parameters
Name
Type
Description
id
required
path[integer]
Event index.
unnamed
required
data
Array of trouble queue codes.
comment
optional
query[string]
Comment
source
optional
query[string]
Update source. Written into the field in the JOBS table specified by the "workQueueSourceField" configuration rule.
as-user
optional
query[string]
User to do the API call as. The calling user must have the 'Allow as-user Parameter' mobile permission.
Payload Example
["SRV", "LNE", "EVL"]
Success Response
• Code: 204 No Content
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request.
• Code: 500 Internal Server Error
Unspecified error has occurred.
POST /trbl-rest/user-log
Add an User Log entry to the given event.
Parameters
Name
Type
Description
logEntry
required
data[string]
Log message
 
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred
POST /trbl-rest/user-log-once
Add an User Log entry to the given event; verify it has not already been added before.
Parameters
Name
Type
Description
logEntry
required
data[string]
Log message
 
Success Response
• Code: 200
Content: None.
Error Response
• Code: 401 Unauthorized
User is not authorized to perform the request
• Code: 500 Internal Server Error
Unspecified error has occurred