Oracle Utilities REST API for Metering and Customer Information

Get Field Activity

get

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

This operation retrieves a field activity.

Request

Path Parameters

activityId(required): string

System-generated unique identifier for the field activity.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : D1-GetFA

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" ]

The reason for cancelling the original activity (for canceled activities only). * `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
creationDateTime: string (date-time)

Create Date/Time
device: object device
emergency: string

Allowed Values: [ "N ", "Y " ]

A flag that indicates if the activity is an emergency or not. * `N ` - No, * `Y ` - Yes
externalActivityDetails: object externalActivityDetails
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
faType: string

Maximum Length: 30

External Field Activity Type
fieldTaskType: string

Allowed Values: [ "D1-DisconnectItemSPAtSource", "ZZ-InstallMeter", "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, * `ZZ-InstallMeter` - ZZ Install Meter, * `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
meterNumber: string

Maximum Length: 14

Meter Number
parentActivity: object parentActivity
pendingChanges: boolean

Pending Changes
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
requester: string

Maximum Length: 30

The requesting system service provider from which the request was received.
requesterTransactionId: string

Maximum Length: 120

Identifier Value
requesterUser: object requesterUser
rescheduleReason: string

Allowed Values: [ "D1-Undetermined" ]

Reschedule Reasons for rescheduling field activities as defined in the (D1-RescheduleReasonLookup) extendable lookup. * `D1-Undetermined` - Undetermined
servicePointExternalId: string

Maximum Length: 60

The Service Point Identifier in the Customer Care and Billing application data model.
sp: object sp
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."
        },
        "sp":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "servicePointExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"The Service Point Identifier in the Customer Care and Billing application data model."
        },
        "fieldTaskType":{
            "type":"string",
            "enum":[
                "D1-DisconnectItemSPAtSource",
                "ZZ-InstallMeter",
                "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* `ZZ-InstallMeter` - ZZ Install Meter,\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"
        },
        "externalActivityDetails":{
            "type":"object",
            "properties":{
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time the activity was initiated."
                },
                "comments":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The comments are free form entries added by a user to provide more information for the activity."
                },
                "instructions":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Optional instructions can be provided for the field worker."
                }
            }
        },
        "rescheduleReason":{
            "type":"string",
            "enum":[
                "D1-Undetermined"
            ],
            "description":"Reschedule Reasons for rescheduling field activities as defined in the (D1-RescheduleReasonLookup) extendable lookup.\n* `D1-Undetermined` - Undetermined"
        },
        "activityType":{
            "type":"object",
            "description":"Activity Type",
            "properties":{
                "activityType":{
                    "type":"string",
                    "maxLength":30,
                    "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."
        },
        "pendingChanges":{
            "type":"boolean",
            "description":"Pending Changes"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "parentActivity":{
            "type":"object",
            "properties":{
                "parentActivityId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Parent orchestration activity id."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "appointmentWindow":{
            "type":"object",
            "properties":{
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Start Date/Time"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"End Date/Time"
                }
            }
        },
        "appointmentInformation":{
            "type":"object",
            "properties":{
                "takenBy":{
                    "type":"string",
                    "maxLength":32,
                    "description":"Taken By"
                },
                "takenDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Taken Date"
                },
                "comments1":{
                    "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."
        },
        "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"
                }
            }
        },
        "requester":{
            "type":"string",
            "maxLength":30,
            "description":"The requesting system service provider from which the request was received."
        },
        "requesterUser":{
            "type":"object",
            "properties":{
                "requesterUserId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "requesterTransactionId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"Represents a unique system-generated id for the activity in the requesting system."
        },
        "cancelReason":{
            "type":"string",
            "enum":[
                "M2-INCOMPLETE",
                "CUT",
                "SEVER",
                "D1-Undetermined",
                "NEARMR",
                "UNDETER",
                "CR",
                "INCMPLTE",
                "C1SR",
                "WFA",
                "D1-AutoDiscarded",
                "STRSTP",
                "DEVTST",
                "CXS"
            ],
            "description":"The reason for cancelling the original activity (for canceled activities only).\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"
        },
        "recommendedDeviceConfigurationType":{
            "type":"object",
            "properties":{
                "recommendedDeviceConfigurationType":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Recommended Device Configuration Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalSPType":{
            "type":"string",
            "maxLength":30,
            "description":"External Service Point Type"
        },
        "faType":{
            "type":"string",
            "maxLength":30,
            "description":"External Field Activity Type"
        },
        "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"
        },
        "meterNumber":{
            "type":"string",
            "maxLength":14,
            "description":"Meter Number"
        }
    },
    "xml":{
        "name":"D1-GetFA"
    }
}

Nested Schema : activityType

Type: object

Activity Type

Show Source

_link: string

_link
activityType: string

Maximum Length: 30

Activity Type

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

Nested Schema : appointmentInformation

Type: object

Show Source

comments1: string

Maximum Length: 254

Comments
takenBy: string

Maximum Length: 32

Taken By
takenDate: string (date)

Taken Date

{
    "type":"object",
    "properties":{
        "takenBy":{
            "type":"string",
            "maxLength":32,
            "description":"Taken By"
        },
        "takenDate":{
            "type":"string",
            "format":"date",
            "description":"Taken Date"
        },
        "comments1":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        }
    }
}

Nested Schema : appointmentWindow

Type: object

Show Source

endDateTime: string (date-time)

End Date/Time
startDateTime: string (date-time)

Start Date/Time

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Date/Time"
        }
    }
}

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 : externalActivityDetails

Type: object

Show Source

comments: string

Maximum Length: 254

The comments are free form entries added by a user to provide more information for the activity.
instructions: string

Maximum Length: 4000

Optional instructions can be provided for the field worker.
startDateTime: string (date-time)

The date and time the activity was initiated.

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the activity was initiated."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"The comments are free form entries added by a user to provide more information for the activity."
        },
        "instructions":{
            "type":"string",
            "maxLength":4000,
            "description":"Optional instructions can be provided for the field worker."
        }
    }
}

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 : recommendedDeviceConfigurationType

Type: object

Show Source

_link: string

_link
recommendedDeviceConfigurationType: string

Maximum Length: 1

Recommended Device Configuration Type

{
    "type":"object",
    "properties":{
        "recommendedDeviceConfigurationType":{
            "type":"string",
            "maxLength":1,
            "description":"Recommended Device Configuration Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : requesterUser

Type: object

Show Source

_link: string

_link
requesterUserId: string

Maximum Length: 8

User

{
    "type":"object",
    "properties":{
        "requesterUserId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        },
        "_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"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}