Name | Type | Description |
event required | path[integer] | The event index to update. |
action | query[string | the action string (like assessed, failed, and so on) |
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. |
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). |
Name | Type | Description |
cfg | path[string] | Type of configuration items to return. |
Name | Type | Description |
id required | path[integer] | Damage report identifier. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Damage report identifier. |
att_id required | path[string] | Attachment name/identifier. |
unnamed required | data | Attachment data. |
Name | Type | Description |
id required | path[integer] | Damage report identifier. |
att_id required | path[string] | Attachment name/identifier. |
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. |
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. |
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 |
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 |
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. |
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. |
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. |
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. |
Name | Type | Description |
class required | path[string] | Condition class name |
id required | path[integer] | Condition index |
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. |
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. |
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. |
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. |
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. |
Name | Type | Description |
handle required | path[hande] | Handle of the device to get conditions for; for example, 148.1001. |
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. |
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. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Crew key. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Crew key. |
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. |
Name | Type | Description |
id required | path[integer] | Crew key. |
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. |
Name | Type | Description |
as-user optional | path[string] | User name, defaults to authenticated user. |
Name | Type | Description |
device-id required | query[string] | Device alias. |
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. |
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. |
Name | Type | Description |
handles required | data | The conductor handles to update. |
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. |
Name | Type | Description |
id required | path[string] | The device handle in the format: class.index |
Name | Type | Description |
handle | path{handle} | Handle of the device to get the last known location of (for example, 147.1234) |
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. |
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. |
Name | Type | Description |
handles required | data | The conductor handles to update. |
Name | Type | Description |
device-id required | query[string] | Device alias search string (can contain SQL wildcard characters). |
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. |
Name | Type | Description |
dir-name | path[string] | Name of the OPERATIONS_MODEL subdirector |
file-name | path[string] | Name of the file to retrieve |
Name | Type | Description |
qt required | query[string] | Query type. Valid values: • da: damage report • event: event • incident: call or other incident • truck: truck dispatch location • <condition class name> |
condition-cls required | query[integer] | Condition class. This parameter is not used. |
condition-idx required | query[integer] | Condition index. |
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. |
Name | Type | Description |
target required | query[string] | NMS user this HLM should be delivered to |
msg required | data | JSON representation of the HLM |
Attribute | Type | Description |
from | string | Message sender |
to | string | NMS tool this HLM should be delivered to |
message | string | The message text |
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. |
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. |
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. |
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. |
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. |
Name | Type | Description |
partitions required | data | A list of partitions (integers). |
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. |
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. |
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 |
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. |
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 |
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 |
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. |
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. |
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. |
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 |
Name | Type | Description |
sub-id | path[string] | A subscription ID from the GET:mobile/subscribe-partition-changes call. |
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. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Event index |
restore optional | query[boolean] | Whether outage should be confirmed or restored. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Event ID |
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. |
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. |
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. |
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. |
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. |
Name | Type | Description |
id required | path[integer] | Event ID |
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. |
Name | Type | Description |
logEntry required | data[string] | Log message |
Name | Type | Description |
logEntry required | data[string] | Log message |