Create Usage Subscription
post
https://server:port/ouaf/rest/apis/meter/v-model/usageSubscriptions/
This Operation handles the Integration Suite API to Create Usage Subscription.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accessGroup: string
Maximum Length:
12
Access Group -
comments: string
Maximum Length:
254
Comments -
creationDateTime: string
(date-time)
Create Date/TimeExample:
2015-12-18T16:08:26-08:00
-
division: string
Maximum Length:
30
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.Example:CA
-
dynamicOptions: object
dynamicOptions
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
externalAccountId: string
Maximum Length:
30
ID used in an external application identify the usage subscription.Example:22132634-15-KMUS
-
externalId: string
Maximum Length:
60
ID used in an external application identify the usage subscription.Example:22132634-01-KMUS
-
factorOverrides: object
factorOverrides
-
fallbackUsageCalculationGroups: object
fallbackUsageCalculationGroups
-
mainContact: object
mainContact
-
masterUsageSubscription: string
Maximum Length:
12
"Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service). -
measuringComponents: object
measuringComponents
-
mostRecentUsageTransactionDateTime: string
(date-time)
Most Recent Transaction Date/Time
-
rateHistory: object
rateHistory
-
servicePoints: object
servicePoints
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
status: string
Maximum Length:
12
The current status of usage subscription.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2015-12-18T16:08:26-08:00
-
timeZone: string
Maximum Length:
10
The time zone in which the usage subscription is active.Example:USPACIFIC
-
usageApprovalRequired: string
Allowed Values:
[ "D1NR", "D1RQ" ]
A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - RequiredExample:D1NR
-
usageCalculationGroups: object
usageCalculationGroups
-
usageRecipient: string
Maximum Length:
30
The service provider is used as the identity of the subscribing system. -
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription ID is a system assigned random number that stays with a usage subscription record.Example:543722442966
-
usageSubscriptionMarketParticipant: string
Maximum Length:
12
Defines the Usage Subscription Market Participant associated with the child Usage Subscription. -
usageSubscriptionType: object
usageSubscriptionType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checksExample:5
Nested Schema : mainContact
Type:
Show Source
object
-
mainContactId: string
Maximum Length:
12
Contact ID
Nested Schema : usageSubscriptionType
Type:
Show Source
object
-
usageSubscriptionType: string
Maximum Length:
30
Usage Subscription Type
Nested Schema : items
Type:
Show Source
object
-
dynamicOption: object
dynamicOption
-
dynamicOptionOverrides: object
dynamicOptionOverrides
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : dynamicOption
Type:
Show Source
object
-
dynamicOptionId: string
Maximum Length:
12
Dynamic Option ID
Nested Schema : items
Type:
Show Source
object
-
dynamicOptionEvent: object
dynamicOptionEvent
-
overrideDateTime: string
(date-time)
Override Date/Time for dynamic option overrides.Example:
2014-01-01T00:00:00-08:00
-
status: string
Allowed Values:
[ "D1AC", "D1IN" ]
Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - InactiveExample:D1AC
Nested Schema : dynamicOptionEvent
Type:
Show Source
object
-
dynamicOptionEventId: string
Maximum Length:
14
Dynamic Option Event ID
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
factor: object
factor
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
value: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.Example:20
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
effectiveDate: string
(date)
Effective Date
Nested Schema : items
Type:
Show Source
object
-
measuringComponent: object
measuringComponent
-
relationshipType: string
Allowed Values:
[ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]
The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal LoadExample:D2CA
Nested Schema : measuringComponent
Type:
Show Source
object
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Effective Date
-
rate: string
Maximum Length:
30
Rate
Nested Schema : items
Type:
Show Source
object
-
overrideStartDateTime: string
(date-time)
An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
-
overrideStopDateTime: string
(date-time)
An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
stopDateTime: string
(date-time)
The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
-
usage: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - SubtractExample:D1AD
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.Example:100
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Root Schema : schema
Type:
Show Source
object
-
accessGroup: string
Maximum Length:
12
Access Group -
comments: string
Maximum Length:
254
Comments -
creationDateTime: string
(date-time)
Create Date/TimeExample:
2015-12-18T16:08:26-08:00
-
division: string
Maximum Length:
30
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.Example:CA
-
dynamicOptions: object
dynamicOptions
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
externalAccountId: string
Maximum Length:
30
ID used in an external application identify the usage subscription.Example:22132634-15-KMUS
-
externalId: string
Maximum Length:
60
ID used in an external application identify the usage subscription.Example:22132634-01-KMUS
-
factorOverrides: object
factorOverrides
-
fallbackUsageCalculationGroups: object
fallbackUsageCalculationGroups
-
mainContact: object
mainContact
-
masterUsageSubscription: string
Maximum Length:
12
"Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service). -
measuringComponents: object
measuringComponents
-
mostRecentUsageTransactionDateTime: string
(date-time)
Most Recent Transaction Date/Time
-
rateHistory: object
rateHistory
-
servicePoints: object
servicePoints
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
status: string
Maximum Length:
12
The current status of usage subscription.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2015-12-18T16:08:26-08:00
-
timeZone: string
Maximum Length:
10
The time zone in which the usage subscription is active.Example:USPACIFIC
-
usageApprovalRequired: string
Allowed Values:
[ "D1NR", "D1RQ" ]
A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - RequiredExample:D1NR
-
usageCalculationGroups: object
usageCalculationGroups
-
usageRecipient: string
Maximum Length:
30
The service provider is used as the identity of the subscribing system. -
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription ID is a system assigned random number that stays with a usage subscription record.Example:543722442966
-
usageSubscriptionMarketParticipant: string
Maximum Length:
12
Defines the Usage Subscription Market Participant associated with the child Usage Subscription. -
usageSubscriptionType: object
usageSubscriptionType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checksExample:5
Nested Schema : mainContact
Type:
Show Source
object
-
mainContactId: string
Maximum Length:
12
Contact ID
Nested Schema : usageSubscriptionType
Type:
Show Source
object
-
usageSubscriptionType: string
Maximum Length:
30
Usage Subscription Type
Nested Schema : items
Type:
Show Source
object
-
dynamicOption: object
dynamicOption
-
dynamicOptionOverrides: object
dynamicOptionOverrides
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : dynamicOption
Type:
Show Source
object
-
dynamicOptionId: string
Maximum Length:
12
Dynamic Option ID
Nested Schema : items
Type:
Show Source
object
-
dynamicOptionEvent: object
dynamicOptionEvent
-
overrideDateTime: string
(date-time)
Override Date/Time for dynamic option overrides.Example:
2014-01-01T00:00:00-08:00
-
status: string
Allowed Values:
[ "D1AC", "D1IN" ]
Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - InactiveExample:D1AC
Nested Schema : dynamicOptionEvent
Type:
Show Source
object
-
dynamicOptionEventId: string
Maximum Length:
14
Dynamic Option Event ID
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
factor: object
factor
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
value: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.Example:20
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
effectiveDate: string
(date)
Effective Date
Nested Schema : items
Type:
Show Source
object
-
measuringComponent: object
measuringComponent
-
relationshipType: string
Allowed Values:
[ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]
The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal LoadExample:D2CA
Nested Schema : measuringComponent
Type:
Show Source
object
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Effective Date
-
rate: string
Maximum Length:
30
Rate
Nested Schema : items
Type:
Show Source
object
-
overrideStartDateTime: string
(date-time)
An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
-
overrideStopDateTime: string
(date-time)
An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
stopDateTime: string
(date-time)
The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
-
usage: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - SubtractExample:D1AD
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.Example:100
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : calculationGroup
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1-UsageSubs
Type:
Show Source
object
-
_self: string
_self
-
accessGroup: string
Maximum Length:
12
Access Group -
comments: string
Maximum Length:
254
Comments -
creationDateTime: string
(date-time)
Create Date/TimeExample:
2015-12-18T16:08:26-08:00
-
division: string
Maximum Length:
30
Divisions are used to delineate between different operating companies within a large conglomerate of utilities.Example:CA
-
dynamicOptions: object
dynamicOptions
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
externalAccountId: string
Maximum Length:
30
ID used in an external application identify the usage subscription.Example:22132634-15-KMUS
-
externalId: string
Maximum Length:
60
ID used in an external application identify the usage subscription.Example:22132634-01-KMUS
-
factorOverrides: object
factorOverrides
-
fallbackUsageCalculationGroups: object
fallbackUsageCalculationGroups
-
mainContact: object
mainContact
-
masterUsageSubscription: string
Maximum Length:
12
"Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service). -
measuringComponents: object
measuringComponents
-
mostRecentUsageTransactionDateTime: string
(date-time)
Most Recent Transaction Date/Time
-
rateHistory: object
rateHistory
-
servicePoints: object
servicePoints
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
status: string
Maximum Length:
12
The current status of usage subscription.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2015-12-18T16:08:26-08:00
-
timeZone: string
Maximum Length:
10
The time zone in which the usage subscription is active.Example:USPACIFIC
-
usageApprovalRequired: string
Allowed Values:
[ "D1NR", "D1RQ" ]
A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - RequiredExample:D1NR
-
usageCalculationGroups: object
usageCalculationGroups
-
usageRecipient: string
Maximum Length:
30
The service provider is used as the identity of the subscribing system. -
usageSubscriptionId: string
Maximum Length:
12
Usage Subscription ID is a system assigned random number that stays with a usage subscription record.Example:543722442966
-
usageSubscriptionMarketParticipant: string
Maximum Length:
12
Defines the Usage Subscription Market Participant associated with the child Usage Subscription. -
usageSubscriptionType: object
usageSubscriptionType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checksExample:5
Nested Schema : mainContact
Type:
Show Source
object
-
_link: string
_link
-
mainContactId: string
Maximum Length:
12
Contact ID
Nested Schema : usageSubscriptionType
Type:
Show Source
object
-
_link: string
_link
-
usageSubscriptionType: string
Maximum Length:
30
Usage Subscription Type
Nested Schema : items
Type:
Show Source
object
-
dynamicOption: object
dynamicOption
-
dynamicOptionOverrides: object
dynamicOptionOverrides
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : dynamicOption
Type:
Show Source
object
-
_link: string
_link
-
dynamicOptionId: string
Maximum Length:
12
Dynamic Option ID
Nested Schema : items
Type:
Show Source
object
-
dynamicOptionEvent: object
dynamicOptionEvent
-
overrideDateTime: string
(date-time)
Override Date/Time for dynamic option overrides.Example:
2014-01-01T00:00:00-08:00
-
status: string
Allowed Values:
[ "D1AC", "D1IN" ]
Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - InactiveExample:D1AC
Nested Schema : dynamicOptionEvent
Type:
Show Source
object
-
_link: string
_link
-
dynamicOptionEventId: string
Maximum Length:
14
Dynamic Option Event ID
Nested Schema : items
Type:
Show Source
object
-
endDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.
-
factor: object
factor
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
value: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.Example:20
Nested Schema : factor
Type:
Show Source
object
-
_link: string
_link
-
factor: string
Maximum Length:
30
Factor
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
effectiveDate: string
(date)
Effective Date
Nested Schema : items
Type:
Show Source
object
-
measuringComponent: object
measuringComponent
-
relationshipType: string
Allowed Values:
[ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]
The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal LoadExample:D2CA
Nested Schema : measuringComponent
Type:
Show Source
object
-
_link: string
_link
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Effective Date
-
rate: string
Maximum Length:
30
Rate
Nested Schema : items
Type:
Show Source
object
-
overrideStartDateTime: string
(date-time)
An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
-
overrideStopDateTime: string
(date-time)
An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
-
servicePoint: object
servicePoint
-
startDateTime: string
(date-time)
The start and end times that define the time period during which the usage subscription is active.Example:
2014-01-01T00:00:00-08:00
-
stopDateTime: string
(date-time)
The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
-
usage: string
Allowed Values:
[ "D1AD", "D1CK", "D1ST" ]
A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - SubtractExample:D1AD
-
usePercent: number
Minimum Value:
-999
Maximum Value:999
The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.Example:100
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
calculationGroup: object
calculationGroup
-
effectiveDateTime: string
(date-time)
Effective Date/Time for calculation groups.Example:
2014-01-01T00:00:00-08:00
-
expirationDateTime: string
(date-time)
Expiration date and time for calculation groups.Example:
2011-02-10T00:00:00-08:00
Nested Schema : calculationGroup
Type:
Show Source
object
-
_link: string
_link
-
calculationGroup: string
Maximum Length:
30
Calculation Group
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.