# paths./devices/{deviceId}/memos.post.requestBody.description
The request body should be a standard JSON object with the following properties.

text

The text of the memo to add.

Required

userEmail

The email address of the user adding the memo.

Optional.
Note: This property is used to post a memo on behalf of another user. If not supplied, then the user assoicated with the subscription is used.

# paths./wells/{wellId}/memos.post.requestBody.description
The request body should be a standard JSON object with the following properties.

text

The text of the memo to add.

Required

userEmail

The email address of the user adding the memo.

Optional.
Note: This property is used to post a memo on behalf of another user. If not supplied, then the user assoicated with the subscription is used.

# paths./wells/{wellId}/memos.get.parameters[].description
Inclusive starting time for memos to return.

# paths./wells/{wellId}/memos.get.parameters[].description
Exclusive ending time for memos to return.

# paths./wells/{wellId}/memos.get.parameters[].description
Include memos for related devices.

Note: Must be true/false, not 1/0.

# paths./devices/{devicesId}/memos.get.description
Gets the memos for the specified device.

# paths./devices/{devicesId}/memos.get.parameters[].description
Inclusive starting time for memos to return.

# paths./devices/{devicesId}/memos.get.parameters[].description
Exclusive ending time for memos to return.

# paths./devices.get.description
Gets the list of devices.

Note: This method can only be called when the API key being used has access to only one organization. Attempting to call this method when the API key has access to multiple organizations will result in a 401 Unauthorized response. The GetDevicesForOrganization method should be used instead.

# paths./organizations/{organizationId}/devices.get.description
Gets the list of devices for the specified organization.

# paths./memos.get.description
Gets the list of memos for the specified time range.

# paths./memos.get.parameters[].description
Inclusive starting time for memos to return.

# paths./memos.get.parameters[].description
Exclusive ending time for memos to return.

# paths./memos.get.parameters[].description
Timestamp property used for startDate/endDate range. Event | Created | Modified. (Default: Event)

# paths./memos.get.parameters[].description
1-based page number of results to return. (Default 1)

# paths./memos.get.parameters[].description
Number of memos to return per page. (Default 400)

# paths./memos.get.parameters[].description
ID of the organization. If left blank, returns memos for all organizations. Format - Guid

# paths./organizations/{organizationId}/users.get.description
Gets the list of users for the specified organization.

# paths./wells/{wellId}/devices.get.description
Gets the devices for the specified well.

# paths./wells.get.description
Gets the list of wells.

Note: This method can only be called when the API key being used has access to only one organization. Attempting to call this method when the API key has access to multiple organizations will result in a 401 Unauthorized response. The GetWellsForOrganization method should be used instead.

# paths./organizations/{organizationId}/wells.get.description
Gets the list of wells for the specified organization.

# paths./{eventType}/events/more.get.description
Retrieves additional pages of events from a previous call to GetEvents.

# paths./{eventType}/events/more.get.parameters[].description
Type of event. Alarm | Diagnostic | DataQuality

# paths./{eventType}/events/more.get.parameters[].description
Token specifying the search results from a previous call to GetDeviceEvents or GetWellEvents.

# paths./{eventType}/events/more.get.parameters[].description
1-based page number of events to return. (Default 1)

# paths./{eventType}/events/more.get.parameters[].description
Number of events to return per page. (Default 400)

# paths./events/devices.get.description
Gets device events for the specified time range, optionally filtered by device or organization.

# paths./events/devices.get.parameters[].description
Inclusive starting time for events to return.

# paths./events/devices.get.parameters[].description
Exclusive ending time for events to return.

# paths./events/devices.get.parameters[].description
Type of event. Alarm | Diagnostic | DataQuality

# paths./events/devices.get.parameters[].description
Timestamp property used for startDate/endDate range. EventStart | EventEnd | Created | Modified. (Default: EventStart)

# paths./events/devices.get.parameters[].description
ID of the device. If left blank, returns events for all devices. Format - Guid

# paths./events/devices.get.parameters[].description
ID of the organization. If left blank, returns events for all organizations. Format - Guid

# paths./events/devices.get.parameters[].description
1-based page number of events to return. (Default 1)

# paths./events/devices.get.parameters[].description
Number of events to return per page. (Default 400)

# paths./events/wells.get.description
Gets well events for the specified time range, optionally filtered by well or organization.

# paths./events/wells.get.parameters[].description
Inclusive starting time for events to return.

# paths./events/wells.get.parameters[].description
Exclusive ending time for events to return.

# paths./events/wells.get.parameters[].description
Type of event. Alarm | Diagnostic | DataQuality

# paths./events/wells.get.parameters[].description
Timestamp property used for startDate/endDate range. EventStart | EventEnd | Created | Modified. (Default: EventStart)

# paths./events/wells.get.parameters[].description
ID of the well. If left blank, returns events for all wells. Format - Guid

# paths./events/wells.get.parameters[].description
ID of the organization. If left blank, returns events for all organizations. Format - Guid

# paths./events/wells.get.parameters[].description
1-based page number of events to return. (Default 1)

# paths./events/wells.get.parameters[].description
Number of events to return per page. (Default 400)

# paths./alarms.get.description
Gets the list of alarm events for the specified time range.

# paths./{eventType}/events.get.description
Gets events of the specified type from the system for the specified time range. Supported event types include Alarm, Diagnostic, and DataQuality. May optionally filter events by object type, object id, and/or organization.

# paths./{eventType}/events.get.parameters[].description
Type of event. Alarm | Diagnostic | DataQuality

# paths./{eventType}/events.get.parameters[].description
Inclusive starting time for events to return.

# paths./{eventType}/events.get.parameters[].description
Exclusive ending time for events to return.

# paths./{eventType}/events.get.parameters[].description
Timestamp property used for startTime/endTime range. EventStart | EventEnd | Created | Modified | EventAcknowledged. (Default: EventStart)

# paths./{eventType}/events.get.parameters[].description
ID of the object. If left blank, returns events for all objects. Format - Guid

# paths./{eventType}/events.get.parameters[].description
Type of the object. Required if objectId is specified. Device | Well

# paths./{eventType}/events.get.parameters[].description
ID of the organization. If left blank, returns events for all organizations. Format - Guid

# paths./{eventType}/events.get.parameters[].description
1-based page number of events to return. (Default 1)

# paths./{eventType}/events.get.parameters[].description
Number of events to return per page. (Default 400)

# paths./runtickets.get.description
Gets the list of run tickets for the specified time range. The startDate and endDate must be in the ISO 8601 format.

# paths./runtickets.get.parameters[].description
Inclusive starting time for run tickets to return. The startDate must be in the ISO 8601 format.

# paths./runtickets.get.parameters[].description
Exclusive ending time for run tickets to return. The endDate must be in the ISO 8601 format.

# paths./datareport/{reportName}.get.description
Runs the specified report and returns the data

# paths./datareport/{reportName}.get.parameters[].description
The (inclusive) start time of the data to be returned

# paths./datareport/{reportName}.get.parameters[].description
The (exclusive) end time of the data to be returned