Jump to

• Request
• Response

Get Field Activity Summary

get

/rest/apis/meter/service/fieldActivities/{activityId}/summary

Request

Path Parameters

• activityId(required): string
  System-generated unique identifier for the field activity.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1FASummary

Type: object

Show Source

• _self: string
  _self
• activityId: string
  Maximum Length: 14

  System-generated unique identifier for the field activity.
• activityType: object activityType
  Activity Type
• appointmentInformation: object appointmentInformation
• appointmentWindow: object appointmentWindow
• bo: string
  Maximum Length: 30

  The business object (BO) of the Service Order Management Activity.
• boStatus: string
  Maximum Length: 12

  The current status code of the service order field activity.
• boStatusDescription: string
  Maximum Length: 254

  The current status description of the service order field activity.
• cancelReason: string
  Allowed Values: [ "M2-INCOMPLETE", "CUT", "SEVER", "D1-Undetermined", "NEARMR", "UNDETER", "CR", "INCMPLTE", "C1SR", "WFA", "D1-AutoDiscarded", "STRSTP", "DEVTST", "CXS" ]

  Cancel Reason: * `M2-INCOMPLETE` - INCOMPLETE, * `CUT` - Cut Canceled, * `SEVER` - Severance Canceled, * `D1-Undetermined` - Undetermined, * `NEARMR` - Near MR Completion Canceled, * `UNDETER` - Undetermined, * `CR` - Customer requested, * `INCMPLTE` - Incomplete, * `C1SR` - Activity Failed, * `WFA` - Wrong type of field act. type, * `D1-AutoDiscarded` - Auto Discarded, * `STRSTP` - Start Stop Canceled, * `DEVTST` - Device Test Canceled, * `CXS` - Canceled by external system
• cancelReasonDescription: string
  Maximum Length: 60

  Description
• creationDateTime: string (date-time)
  Create Date/Time
• emergency: string
  Allowed Values: [ "N ", "Y " ]

  A flag that indicates if the activity is an emergency or not. * `N ` - No, * `Y ` - Yes

  Example: N
• externalActivityDetails: object externalActivityDetails
• fieldTaskType: string
  Allowed Values: [ "D1-DisconnectItemSPAtSource", "D1-ConnectSPAtSourceAndTurnOn", "D1-DisconnectSPAtSource", "D1-DisconnectWarning", "D1-MaintainEquipment", "D1-ExchangeMeter", "D1-DisConnSPAtDvcAndRmveDvc", "D1-TurnOffItem", "D1-ConnSPAtSrceAndInstMtr", "D1-TurnOnMeter", "D1-CutForNonPayment", "D1-DisConnSPAtSrceAndRmveMtr", "D1-ReconnectItemforPayment", "D1-TurnOffMeter", "D1-ConnectSPAtMeterAndTurnOn", "D1-DisconnectSPAtDevice", "D1-ConnectSPAtDevice", "D1-InstallDevice", "D1-ConnSPAtDvcAndInstDvc", "D1-ConnSPAtSrceAndTurnOnDvc", "D1-TurnOnPilotLight", "D1-ConnectSPAtSource", "D1-DisconnectSPAtMeter", "D1-ConnSPAtSrceAndInstDvc", "D1-ConnectSPAtMeter", "D1-ServiceInvestigation", "D1-DisConnSPAtMtrAndRmveMtr", "D1-InstallMeter", "D1-ReconnectForPayment", "D1-ConnectSPAtDvcAndTurnOn", "D1-TrimTree", "D1-ConnSPAtMtrAndInstMtr", "D1-CutItemForNonPayment", "X1-InvestigateControllableDevice", "D1-RemoveMeter", "D1-ConnectSPAtSourceAndInstallMeter", "D1-TurnOnItem", "D1-ReadMeter", "D1-RemoveDevice", "D1-ExchangeDevice", "X1-InstallControllableDevice" ]

  A service order field activity's field task type defines details about the type of task to be performed and how the system will process the activity. * `D1-DisconnectItemSPAtSource` - Disconnect SP at Source Item, * `D1-ConnectSPAtSourceAndTurnOn` - Connect SP at Source and Turn On, * `D1-DisconnectSPAtSource` - Disconnect SP at Source, * `D1-DisconnectWarning` - Disconnect Warning, * `D1-MaintainEquipment` - Maintain SP and Meter Equipment, * `D1-ExchangeMeter` - Exchange Meter, * `D1-DisConnSPAtDvcAndRmveDvc` - Disconnect SP from Item and Remove Item, * `D1-TurnOffItem` - Turn Off Item, * `D1-ConnSPAtSrceAndInstMtr` - Connect SP at Source and Install Meter, * `D1-TurnOnMeter` - Turn On Meter, * `D1-CutForNonPayment` - Cut for Non Payment, * `D1-DisConnSPAtSrceAndRmveMtr` - Disconnect SP at Source and Remove Meter, * `D1-ReconnectItemforPayment` - Reconnect Item for Payment, * `D1-TurnOffMeter` - Turn Off Meter, * `D1-ConnectSPAtMeterAndTurnOn` - Connect SP at Meter and Turn On, * `D1-DisconnectSPAtDevice` - Disconnect SP from Item, * `D1-ConnectSPAtDevice` - Connect SP to Item, * `D1-InstallDevice` - Install Item, * `D1-ConnSPAtDvcAndInstDvc` - Connect SP to Item and Install Item, * `D1-ConnSPAtSrceAndTurnOnDvc` - Connect SP at Source and Turn On Item, * `D1-TurnOnPilotLight` - Turn On Pilot Light, * `D1-ConnectSPAtSource` - Connect SP at Source, * `D1-DisconnectSPAtMeter` - Disconnect SP at Meter, * `D1-ConnSPAtSrceAndInstDvc` - Connect SP at Source and Install Item, * `D1-ConnectSPAtMeter` - Connect SP at Meter, * `D1-ServiceInvestigation` - Service Investigation, * `D1-DisConnSPAtMtrAndRmveMtr` - Disconnect SP at Meter and Remove Meter, * `D1-InstallMeter` - Install Meter, * `D1-ReconnectForPayment` - Reconnect for Payment, * `D1-ConnectSPAtDvcAndTurnOn` - Connect SP to Item and Turn On, * `D1-TrimTree` - Trim Tree, * `D1-ConnSPAtMtrAndInstMtr` - Connect SP at Meter and Install Meter, * `D1-CutItemForNonPayment` - Cut Item for Non Payment, * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `D1-RemoveMeter` - Remove Meter, * `D1-ConnectSPAtSourceAndInstallMeter` - Connect SP at Source and Install Meter, * `D1-TurnOnItem` - Turn On Item, * `D1-ReadMeter` - Read Meter, * `D1-RemoveDevice` - Remove Item, * `D1-ExchangeDevice` - Exchange Item, * `X1-InstallControllableDevice` - Install Controllable Device

  Example: D1-ConnectSPAtMeterAndTurnOn
• fieldTaskTypeDescription: string
  Maximum Length: 60

  Description
• parentActivityDetails: object parentActivityDetails
• recipient: string
  Maximum Length: 30

  The field work system service provider to which the service order field activity is sent for scheduling and assignment.
• recommendedDeviceConfigurationType: object recommendedDeviceConfigurationType
  Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.
• requestInformation: object requestInformation
• servicePointDetails: object servicePointDetails
• statusDateTime: string (date-time)
  Status Date/Time

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"System-generated unique identifier for the field activity."
        },
        "servicePointDetails":{
            "type":"object",
            "properties":{
                "sp":{
                    "type":"object",
                    "properties":{
                        "spId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Service Point"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Unique identifier of the premise associated with the service point or customer location.",
                    "example":"7880087160"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The full mailing and/or physical address associated with the premise.",
                    "example":"123 Main St, San Francisco, CA 94105"
                },
                "servicePointTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "isMetered":{
                    "type":"boolean",
                    "description":"Indicates whether the service point usage is metered or not.",
                    "example":"true"
                },
                "servicePointStatusDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "installationDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date the service point connection was established at the premise or service point.",
                    "example":"2010-01-01"
                },
                "abolishedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date the service or premise record was removed / deactivated or no longer valid."
                },
                "sourceStatusDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service type defines the type of service associated with the service agreement type.",
                    "example":"E"
                },
                "serviceTypeDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Text description of the service type that can be displayed for users in their language.",
                    "example":"Electric"
                },
                "badgedDevice":{
                    "type":"object",
                    "properties":{
                        "deviceTypeDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Description"
                        },
                        "deviceInfo":{
                            "type":"string",
                            "maxLength":150,
                            "description":"Composite text containing device properties and status of installation and connection as displayed within the application.",
                            "example":"0G-PRAP - Electric Smart ConGen / Install Date/Time: 09-08-2025 12:00AM / Connected / Commissioned / 0G-PRAP - Electric Service Provider / Active"
                        },
                        "badgeNumber":{
                            "type":"string",
                            "maxLength":120,
                            "description":"Utility badge tag number assigned to a specific installed device or additional equipment that would normally be presented to a customer.",
                            "example":"EM-784392"
                        },
                        "deviceInstallationDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Date and time when the device was physically installed.",
                            "example":"2025-09-07T16:00:00-07:00"
                        },
                        "deviceStatus":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Current on/off status of the device.",
                            "example":"On"
                        },
                        "device":{
                            "type":"object",
                            "properties":{
                                "deviceId":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The device related to the service order field activity (if applicable)."
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        }
                    }
                },
                "unbadgedDevices":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Date/Time"
                            },
                            "unbadgedDevicesInfo":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "deviceTypeDescription":{
                                            "type":"string",
                                            "maxLength":60,
                                            "description":"Description of the type of device",
                                            "example":"10K mercury vapor"
                                        },
                                        "numberInstalled":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":0,
                                            "description":"Number of unbadged item(s) with an effective installation as of the current date.",
                                            "example":"1"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "fieldTaskType":{
            "type":"string",
            "enum":[
                "D1-DisconnectItemSPAtSource",
                "D1-ConnectSPAtSourceAndTurnOn",
                "D1-DisconnectSPAtSource",
                "D1-DisconnectWarning",
                "D1-MaintainEquipment",
                "D1-ExchangeMeter",
                "D1-DisConnSPAtDvcAndRmveDvc",
                "D1-TurnOffItem",
                "D1-ConnSPAtSrceAndInstMtr",
                "D1-TurnOnMeter",
                "D1-CutForNonPayment",
                "D1-DisConnSPAtSrceAndRmveMtr",
                "D1-ReconnectItemforPayment",
                "D1-TurnOffMeter",
                "D1-ConnectSPAtMeterAndTurnOn",
                "D1-DisconnectSPAtDevice",
                "D1-ConnectSPAtDevice",
                "D1-InstallDevice",
                "D1-ConnSPAtDvcAndInstDvc",
                "D1-ConnSPAtSrceAndTurnOnDvc",
                "D1-TurnOnPilotLight",
                "D1-ConnectSPAtSource",
                "D1-DisconnectSPAtMeter",
                "D1-ConnSPAtSrceAndInstDvc",
                "D1-ConnectSPAtMeter",
                "D1-ServiceInvestigation",
                "D1-DisConnSPAtMtrAndRmveMtr",
                "D1-InstallMeter",
                "D1-ReconnectForPayment",
                "D1-ConnectSPAtDvcAndTurnOn",
                "D1-TrimTree",
                "D1-ConnSPAtMtrAndInstMtr",
                "D1-CutItemForNonPayment",
                "X1-InvestigateControllableDevice",
                "D1-RemoveMeter",
                "D1-ConnectSPAtSourceAndInstallMeter",
                "D1-TurnOnItem",
                "D1-ReadMeter",
                "D1-RemoveDevice",
                "D1-ExchangeDevice",
                "X1-InstallControllableDevice"
            ],
            "description":"A service order field activity's field task type defines details about the type of task to be performed and how the system will process the activity.\n* `D1-DisconnectItemSPAtSource` - Disconnect  SP at Source Item,\n* `D1-ConnectSPAtSourceAndTurnOn` - Connect SP at Source and Turn On,\n* `D1-DisconnectSPAtSource` - Disconnect  SP at Source,\n* `D1-DisconnectWarning` - Disconnect Warning,\n* `D1-MaintainEquipment` - Maintain SP and Meter Equipment,\n* `D1-ExchangeMeter` - Exchange Meter,\n* `D1-DisConnSPAtDvcAndRmveDvc` - Disconnect SP from Item and Remove Item,\n* `D1-TurnOffItem` - Turn Off  Item,\n* `D1-ConnSPAtSrceAndInstMtr` - Connect SP at Source and Install Meter,\n* `D1-TurnOnMeter` - Turn On Meter,\n* `D1-CutForNonPayment` - Cut for Non Payment,\n* `D1-DisConnSPAtSrceAndRmveMtr` - Disconnect SP at Source and Remove Meter,\n* `D1-ReconnectItemforPayment` - Reconnect Item for Payment,\n* `D1-TurnOffMeter` - Turn Off  Meter,\n* `D1-ConnectSPAtMeterAndTurnOn` - Connect  SP at Meter and Turn On,\n* `D1-DisconnectSPAtDevice` - Disconnect SP from Item,\n* `D1-ConnectSPAtDevice` - Connect SP to Item,\n* `D1-InstallDevice` - Install Item,\n* `D1-ConnSPAtDvcAndInstDvc` - Connect SP to Item and Install Item,\n* `D1-ConnSPAtSrceAndTurnOnDvc` - Connect SP at Source and Turn On Item,\n* `D1-TurnOnPilotLight` - Turn On Pilot Light,\n* `D1-ConnectSPAtSource` - Connect SP at Source,\n* `D1-DisconnectSPAtMeter` - Disconnect SP at Meter,\n* `D1-ConnSPAtSrceAndInstDvc` - Connect SP at Source and Install Item,\n* `D1-ConnectSPAtMeter` - Connect SP at Meter,\n* `D1-ServiceInvestigation` - Service Investigation,\n* `D1-DisConnSPAtMtrAndRmveMtr` - Disconnect SP at Meter and Remove Meter,\n* `D1-InstallMeter` - Install Meter,\n* `D1-ReconnectForPayment` - Reconnect for Payment,\n* `D1-ConnectSPAtDvcAndTurnOn` - Connect  SP to Item and Turn On,\n* `D1-TrimTree` - Trim Tree,\n* `D1-ConnSPAtMtrAndInstMtr` - Connect SP at Meter and Install Meter,\n* `D1-CutItemForNonPayment` - Cut Item for Non Payment,\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `D1-RemoveMeter` - Remove Meter,\n* `D1-ConnectSPAtSourceAndInstallMeter` - Connect SP at Source and Install Meter,\n* `D1-TurnOnItem` - Turn On Item,\n* `D1-ReadMeter` - Read Meter,\n* `D1-RemoveDevice` - Remove Item,\n* `D1-ExchangeDevice` - Exchange Item,\n* `X1-InstallControllableDevice` - Install Controllable Device",
            "example":"D1-ConnectSPAtMeterAndTurnOn"
        },
        "fieldTaskTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "externalActivityDetails":{
            "type":"object",
            "properties":{
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Start Date/Time"
                },
                "comments":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Comments"
                },
                "instructions":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Optional instructions can be provided for the field worker."
                }
            }
        },
        "activityType":{
            "type":"object",
            "description":"Activity Type",
            "properties":{
                "activityType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Activity Type"
                },
                "activityTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Activity Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "bo":{
            "type":"string",
            "maxLength":30,
            "description":"The business object (BO) of the Service Order Management Activity."
        },
        "boStatus":{
            "type":"string",
            "maxLength":12,
            "description":"The current status code of the service order field activity."
        },
        "boStatusDescription":{
            "type":"string",
            "maxLength":254,
            "description":"The current status description of the service order field activity."
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "parentActivityDetails":{
            "type":"object",
            "properties":{
                "parentActivity":{
                    "type":"object",
                    "properties":{
                        "parentActivityId":{
                            "type":"string",
                            "maxLength":14,
                            "description":"Parent orchestration activity id."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "parentActivityTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "parentActivityStartDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Start Date/Time"
                }
            }
        },
        "appointmentWindow":{
            "type":"object",
            "properties":{
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Start date and time for the activity or appointment window.",
                    "example":"2025-09-07T16:00:00-07:00"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"End date and time for the activity or appointment window.",
                    "example":"2025-09-08T16:00:00-07:00"
                }
            }
        },
        "appointmentInformation":{
            "type":"object",
            "properties":{
                "takenBy":{
                    "type":"string",
                    "maxLength":32,
                    "description":"Identifier of the user or worker who \"took\" (accepted or initiated) the activity.",
                    "example":"EJONES"
                },
                "takenByUserName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"User Name"
                },
                "takenDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Date the activity was taken or accepted.",
                    "example":"2025-09-06"
                },
                "comments":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Comments"
                }
            }
        },
        "recipient":{
            "type":"string",
            "maxLength":30,
            "description":"The field work system service provider to which the service order field activity is sent for scheduling and assignment."
        },
        "requestInformation":{
            "type":"object",
            "properties":{
                "requester":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The requesting system service provider from which the request was received."
                },
                "requesterUserId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"ID of the user in the requesting system who created the field activity request.",
                    "example":"LWAYNE"
                },
                "requesterUserName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"User Name"
                },
                "requesterTransactionId":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier used by the external requesting system to correlate the transaction.",
                    "example":"3098684110"
                },
                "servicePointExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The Service Point Identifier in the Customer Care and Billing application data model."
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Represents a unique system-generated id for the activity in the requesting system."
                },
                "externalSPType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External service point type code as provided by the originating system.",
                    "example":"E-RES"
                },
                "faType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External field activity type code from the requesting system, often used for integration.",
                    "example":"SOM-START"
                }
            }
        },
        "cancelReason":{
            "type":"string",
            "enum":[
                "M2-INCOMPLETE",
                "CUT",
                "SEVER",
                "D1-Undetermined",
                "NEARMR",
                "UNDETER",
                "CR",
                "INCMPLTE",
                "C1SR",
                "WFA",
                "D1-AutoDiscarded",
                "STRSTP",
                "DEVTST",
                "CXS"
            ],
            "description":"Cancel Reason:\n* `M2-INCOMPLETE` - INCOMPLETE,\n* `CUT` - Cut Canceled,\n* `SEVER` - Severance Canceled,\n* `D1-Undetermined` - Undetermined,\n* `NEARMR` - Near MR Completion Canceled,\n* `UNDETER` - Undetermined,\n* `CR` - Customer requested,\n* `INCMPLTE` - Incomplete,\n* `C1SR` - Activity Failed,\n* `WFA` - Wrong type of field act. type,\n* `D1-AutoDiscarded` - Auto Discarded,\n* `STRSTP` - Start Stop Canceled,\n* `DEVTST` - Device Test Canceled,\n* `CXS` - Canceled by external system"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "recommendedDeviceConfigurationType":{
            "type":"object",
            "description":"Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.",
            "properties":{
                "recommendedDeviceConfigurationType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.",
                    "example":"E-AUTO-KWH-15MIN"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "emergency":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"A flag that indicates if the activity is an emergency or not.\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"N"
        }
    },
    "xml":{
        "name":"D1FASummary"
    }
}

Nested Schema : activityType

Type: object

Activity Type

Show Source

• _link: string
  _link
• activityType: string
  Maximum Length: 30

  Activity Type
• activityTypeDescription: string
  Maximum Length: 60

  Activity Type

{
    "type":"object",
    "description":"Activity Type",
    "properties":{
        "activityType":{
            "type":"string",
            "maxLength":30,
            "description":"Activity Type"
        },
        "activityTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Activity Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : appointmentInformation

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• takenBy: string
  Maximum Length: 32

  Identifier of the user or worker who "took" (accepted or initiated) the activity.

  Example: EJONES
• takenByUserName: string
  Maximum Length: 50

  User Name
• takenDate: string (date)
  Date the activity was taken or accepted.

  Example: 2025-09-06

{
    "type":"object",
    "properties":{
        "takenBy":{
            "type":"string",
            "maxLength":32,
            "description":"Identifier of the user or worker who \"took\" (accepted or initiated) the activity.",
            "example":"EJONES"
        },
        "takenByUserName":{
            "type":"string",
            "maxLength":50,
            "description":"User Name"
        },
        "takenDate":{
            "type":"string",
            "format":"date",
            "description":"Date the activity was taken or accepted.",
            "example":"2025-09-06"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        }
    }
}

Nested Schema : appointmentWindow

Type: object

Show Source

• endDateTime: string (date-time)
  End date and time for the activity or appointment window.

  Example: 2025-09-08T16:00:00-07:00
• startDateTime: string (date-time)
  Start date and time for the activity or appointment window.

  Example: 2025-09-07T16:00:00-07:00

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start date and time for the activity or appointment window.",
            "example":"2025-09-07T16:00:00-07:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End date and time for the activity or appointment window.",
            "example":"2025-09-08T16:00:00-07:00"
        }
    }
}

Nested Schema : externalActivityDetails

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• instructions: string
  Maximum Length: 4000

  Optional instructions can be provided for the field worker.
• startDateTime: string (date-time)
  Start Date/Time

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "instructions":{
            "type":"string",
            "maxLength":4000,
            "description":"Optional instructions can be provided for the field worker."
        }
    }
}

Nested Schema : parentActivityDetails

Type: object

Show Source

• parentActivity: object parentActivity
• parentActivityStartDateTime: string (date-time)
  Start Date/Time
• parentActivityTypeDescription: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "parentActivity":{
            "type":"object",
            "properties":{
                "parentActivityId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Parent orchestration activity id."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "parentActivityTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "parentActivityStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        }
    }
}

Nested Schema : recommendedDeviceConfigurationType

Type: object

Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.

Show Source

• _link: string
  _link
• recommendedDeviceConfigurationType: string
  Maximum Length: 30

  Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.

  Example: E-AUTO-KWH-15MIN

{
    "type":"object",
    "description":"Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.",
    "properties":{
        "recommendedDeviceConfigurationType":{
            "type":"string",
            "maxLength":30,
            "description":"Indicates the recommended device configuration type code for the device to be set or installed with this field activity if applicable.",
            "example":"E-AUTO-KWH-15MIN"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : requestInformation

Type: object

Show Source

• externalReferenceId: string
  Maximum Length: 36

  Represents a unique system-generated id for the activity in the requesting system.
• externalSPType: string
  Maximum Length: 30

  External service point type code as provided by the originating system.

  Example: E-RES
• faType: string
  Maximum Length: 30

  External field activity type code from the requesting system, often used for integration.

  Example: SOM-START
• requester: string
  Maximum Length: 30

  The requesting system service provider from which the request was received.
• requesterTransactionId: string
  Maximum Length: 120

  Identifier used by the external requesting system to correlate the transaction.

  Example: 3098684110
• requesterUserId: string
  Maximum Length: 8

  ID of the user in the requesting system who created the field activity request.

  Example: LWAYNE
• requesterUserName: string
  Maximum Length: 50

  User Name
• servicePointExternalId: string
  Maximum Length: 60

  The Service Point Identifier in the Customer Care and Billing application data model.

{
    "type":"object",
    "properties":{
        "requester":{
            "type":"string",
            "maxLength":30,
            "description":"The requesting system service provider from which the request was received."
        },
        "requesterUserId":{
            "type":"string",
            "maxLength":8,
            "description":"ID of the user in the requesting system who created the field activity request.",
            "example":"LWAYNE"
        },
        "requesterUserName":{
            "type":"string",
            "maxLength":50,
            "description":"User Name"
        },
        "requesterTransactionId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier used by the external requesting system to correlate the transaction.",
            "example":"3098684110"
        },
        "servicePointExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The Service Point Identifier in the Customer Care and Billing application data model."
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"Represents a unique system-generated id for the activity in the requesting system."
        },
        "externalSPType":{
            "type":"string",
            "maxLength":30,
            "description":"External service point type code as provided by the originating system.",
            "example":"E-RES"
        },
        "faType":{
            "type":"string",
            "maxLength":30,
            "description":"External field activity type code from the requesting system, often used for integration.",
            "example":"SOM-START"
        }
    }
}

Nested Schema : servicePointDetails

Type: object

Show Source

• abolishedDate: string (date)
  The date the service or premise record was removed / deactivated or no longer valid.
• badgedDevice: object badgedDevice
• installationDate: string (date)
  The date the service point connection was established at the premise or service point.

  Example: 2010-01-01
• isMetered: boolean
  Indicates whether the service point usage is metered or not.

  Example: true
• premiseAddress: string
  Maximum Length: 254

  The full mailing and/or physical address associated with the premise.

  Example: 123 Main St, San Francisco, CA 94105
• premiseId: string
  Maximum Length: 30

  Unique identifier of the premise associated with the service point or customer location.

  Example: 7880087160
• servicePointStatusDescription: string
  Maximum Length: 60

  Description
• servicePointTypeDescription: string
  Maximum Length: 60

  Description
• serviceType: string
  Maximum Length: 80

  Service type defines the type of service associated with the service agreement type.

  Example: E
• serviceTypeDescription: string
  Maximum Length: 100

  Text description of the service type that can be displayed for users in their language.

  Example: Electric
• sourceStatusDescription: string
  Maximum Length: 60

  Description
• sp: object sp
• unbadgedDevices: array unbadgedDevices

{
    "type":"object",
    "properties":{
        "sp":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premiseId":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the premise associated with the service point or customer location.",
            "example":"7880087160"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":254,
            "description":"The full mailing and/or physical address associated with the premise.",
            "example":"123 Main St, San Francisco, CA 94105"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "isMetered":{
            "type":"boolean",
            "description":"Indicates whether the service point usage is metered or not.",
            "example":"true"
        },
        "servicePointStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "installationDate":{
            "type":"string",
            "format":"date",
            "description":"The date the service point connection was established at the premise or service point.",
            "example":"2010-01-01"
        },
        "abolishedDate":{
            "type":"string",
            "format":"date",
            "description":"The date the service or premise record was removed / deactivated or no longer valid."
        },
        "sourceStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service type defines the type of service associated with the service agreement type.",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Text description of the service type that can be displayed for users in their language.",
            "example":"Electric"
        },
        "badgedDevice":{
            "type":"object",
            "properties":{
                "deviceTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "deviceInfo":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Composite text containing device properties and status of installation and connection as displayed within the application.",
                    "example":"0G-PRAP - Electric Smart ConGen / Install Date/Time: 09-08-2025 12:00AM / Connected / Commissioned / 0G-PRAP - Electric Service Provider / Active"
                },
                "badgeNumber":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Utility badge tag number assigned to a specific installed device or additional equipment that would normally be presented to a customer.",
                    "example":"EM-784392"
                },
                "deviceInstallationDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time when the device was physically installed.",
                    "example":"2025-09-07T16:00:00-07:00"
                },
                "deviceStatus":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Current on/off status of the device.",
                    "example":"On"
                },
                "device":{
                    "type":"object",
                    "properties":{
                        "deviceId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The device related to the service order field activity (if applicable)."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                }
            }
        },
        "unbadgedDevices":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time"
                    },
                    "unbadgedDevicesInfo":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "deviceTypeDescription":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Description of the type of device",
                                    "example":"10K mercury vapor"
                                },
                                "numberInstalled":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":0,
                                    "description":"Number of unbadged item(s) with an effective installation as of the current date.",
                                    "example":"1"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : parentActivity

Type: object

Show Source

• _link: string
  _link
• parentActivityId: string
  Maximum Length: 14

  Parent orchestration activity id.

{
    "type":"object",
    "properties":{
        "parentActivityId":{
            "type":"string",
            "maxLength":14,
            "description":"Parent orchestration activity id."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : badgedDevice

Type: object

Show Source

• badgeNumber: string
  Maximum Length: 120

  Utility badge tag number assigned to a specific installed device or additional equipment that would normally be presented to a customer.

  Example: EM-784392
• device: object device
• deviceInfo: string
  Maximum Length: 150

  Composite text containing device properties and status of installation and connection as displayed within the application.

  Example: 0G-PRAP - Electric Smart ConGen / Install Date/Time: 09-08-2025 12:00AM / Connected / Commissioned / 0G-PRAP - Electric Service Provider / Active
• deviceInstallationDateTime: string (date-time)
  Date and time when the device was physically installed.

  Example: 2025-09-07T16:00:00-07:00
• deviceStatus: string
  Maximum Length: 60

  Current on/off status of the device.

  Example: On
• deviceTypeDescription: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "deviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "deviceInfo":{
            "type":"string",
            "maxLength":150,
            "description":"Composite text containing device properties and status of installation and connection as displayed within the application.",
            "example":"0G-PRAP - Electric Smart ConGen / Install Date/Time: 09-08-2025 12:00AM / Connected / Commissioned / 0G-PRAP - Electric Service Provider / Active"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Utility badge tag number assigned to a specific installed device or additional equipment that would normally be presented to a customer.",
            "example":"EM-784392"
        },
        "deviceInstallationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the device was physically installed.",
            "example":"2025-09-07T16:00:00-07:00"
        },
        "deviceStatus":{
            "type":"string",
            "maxLength":60,
            "description":"Current on/off status of the device.",
            "example":"On"
        },
        "device":{
            "type":"object",
            "properties":{
                "deviceId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The device related to the service order field activity (if applicable)."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : sp

Type: object

Show Source

• _link: string
  _link
• spId: string
  Maximum Length: 12

  Service Point

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : unbadgedDevices

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time"
            },
            "unbadgedDevicesInfo":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "deviceTypeDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Description of the type of device",
                            "example":"10K mercury vapor"
                        },
                        "numberInstalled":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":0,
                            "description":"Number of unbadged item(s) with an effective installation as of the current date.",
                            "example":"1"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : device

Type: object

Show Source

• _link: string
  _link
• deviceId: string
  Maximum Length: 12

  The device related to the service order field activity (if applicable).

{
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"The device related to the service order field activity (if applicable)."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• startDateTime: string (date-time)
  Start Date/Time
• unbadgedDevicesInfo: array unbadgedDevicesInfo

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "unbadgedDevicesInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description of the type of device",
                        "example":"10K mercury vapor"
                    },
                    "numberInstalled":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Number of unbadged item(s) with an effective installation as of the current date.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : unbadgedDevicesInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description of the type of device",
                "example":"10K mercury vapor"
            },
            "numberInstalled":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Number of unbadged item(s) with an effective installation as of the current date.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deviceTypeDescription: string
  Maximum Length: 60

  Description of the type of device

  Example: 10K mercury vapor
• numberInstalled: number
  Minimum Value: 0

  Maximum Value: 99999

  Number of unbadged item(s) with an effective installation as of the current date.

  Example: 1

{
    "type":"object",
    "properties":{
        "deviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description of the type of device",
            "example":"10K mercury vapor"
        },
        "numberInstalled":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Number of unbadged item(s) with an effective installation as of the current date.",
            "example":"1"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top