1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. V-Model
  4. Service Agreement

Update Service Agreement

put

/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • account
  • Turn on Allow Estimates if it's OK for the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time
  • Maximum Length: 250
    Enter a Business Activity associated with the customer. This can be used to further define what types of activities are served by this contract.
    Example: business
  • characteristics
  • currency
    Currency Code
  • Allowed Values: [ "N ", "Y " ]
    Use Customer Read to define if the customer reads his or her own meter. Valid values are: Yes, No. * `N ` - No, * `Y ` - Yes
    Example: Y
  • Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.
    Example: 2018-02-25
  • The End Date defines when the financial relationship terminates.
    Example: 2018-02-25
  • Expiration Date contains the date at which the service agreement is set to expire.
  • If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in "legal time". This value defaults from either the start option or the installation record.
  • IsActive flag to show active SAs for account
    Example: false
  • Use Maximum Bill Threshold if you want the system to generate a bill error when a bill segment is produced in batch that exceeds a given value.
    Example: 2000
  • Allowed Values: [ "EXCL", "INCL" ]
    The Scheduled Payment Autopay flag determines if the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only visible if the SA has a special role of Non-billed Budget * `EXCL` - Excluded from Auto Pay, * `INCL` - Included in Auto Pay
    Example: INCL
  • Minimum Value: 0
    Maximum Value: 999
    Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.
    Example: 0
  • Maximum Length: 36
    Old Account ID refers to account id for service agreements that were converted from your legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number
    Example: 123456789
  • order
  • premise
  • Maximum Length: 8
    The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this SA. This field is only visible if the SA has a special role of Non-billed Budget.
  • Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type.
  • CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates this is a CIAC service agreement.
  • Maximum Length: 60
    Description for SA Status
    Example: Canceled
  • Maximum Length: 10
    The Service Agreement ID is a system assigned random number that stays with a service agreement for life.
  • serviceAgreementRelationship
  • serviceAgreementType
  • serviceType
    Service Type defines the type of service associated with the SA type.
  • sicCode
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
  • Allowed Values: [ "BC ", "BD ", "CD ", "IN ", "LO ", "NB ", "PA ", "WO " ]
    Special Role: * `BC ` - Billable Charge, * `BD ` - Bill Determinants Required, * `CD ` - Cash Deposit, * `IN ` - Interval, * `LO ` - Loan, * `NB ` - Non-billed Budget, * `PA ` - Payment Arrangement, * `WO ` - Write Off
  • Allowed Values: [ "PROP" ]
    The Special Usage Flag shows if the SA is a proposal SA . You cannot create a quote unless its account has at least one proposal service agreement (SA). A proposal SA contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal SA as special type of service agreement that is ignored when a bill is produced for an account. * `PROP` - Proposal SA
    Example: PROP
  • The Start Date defines when the financial relationship begins.
  • Maximum Length: 12
    Start options save users time and prevent data entry errors because they default many values on a service agreement (e.g., the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, etc. can all be defaulted onto a service agreement from a start option).
  • Allowed Values: [ "C ", "S " ]
    Use Start Reason to define who requested to start the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Start Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was started (e.g., Customer, Jane Smith ).
  • Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
    SA Status defines the state of the service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled
    Example: 20
  • Allowed Values: [ "C ", "S " ]
    Use Stop Reason to define who requested to stop the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Stop Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was stopped (e.g., Customer, Jane Smith ).
  • If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
    Example: 2
Nested Schema : account
Type: object
Show Source
  • Maximum Length: 10
    Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.
    Example: 1589809012
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Currency Code
Show Source
Nested Schema : order
Type: object
Show Source
  • Maximum Length: 12
    Order ID is the system-assigned unique identifier of the order.
Nested Schema : premise
Type: object
Show Source
  • Maximum Length: 10
    If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.
    Example: 8614900960
Nested Schema : serviceAgreementRelationship
Type: object
Show Source
Nested Schema : serviceAgreementType
Type: object
Show Source
  • Maximum Length: 5
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 1
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 8
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 30
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
Nested Schema : serviceType
Type: object
Service Type defines the type of service associated with the SA type.
Show Source
  • Maximum Length: 80
    Service Type defines the type of service associated with the SA type.
    Example: E
Nested Schema : sicCode
Type: object
Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
Show Source
  • Maximum Length: 8
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
    Example: 4800 (Transportation)
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
  • (_link)
  • Maximum Length: 254
    Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite. Good examples of such a characteristic type would be ones used to define a user's birth date or their mother's maiden name.
    Example: 77
  • Maximum Length: 50
    Foreign Key Value 2
  • Maximum Length: 50
    Foreign Key Value 3
  • Maximum Length: 50
    Foreign Key Value 4
  • Maximum Length: 50
    Foreign Key Value 5
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • account
  • Turn on Allow Estimates if it's OK for the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time
  • Maximum Length: 250
    Enter a Business Activity associated with the customer. This can be used to further define what types of activities are served by this contract.
    Example: business
  • characteristics
  • currency
    Currency Code
  • Allowed Values: [ "N ", "Y " ]
    Use Customer Read to define if the customer reads his or her own meter. Valid values are: Yes, No. * `N ` - No, * `Y ` - Yes
    Example: Y
  • Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.
    Example: 2018-02-25
  • The End Date defines when the financial relationship terminates.
    Example: 2018-02-25
  • Expiration Date contains the date at which the service agreement is set to expire.
  • If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in "legal time". This value defaults from either the start option or the installation record.
  • IsActive flag to show active SAs for account
    Example: false
  • Use Maximum Bill Threshold if you want the system to generate a bill error when a bill segment is produced in batch that exceeds a given value.
    Example: 2000
  • Allowed Values: [ "EXCL", "INCL" ]
    The Scheduled Payment Autopay flag determines if the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only visible if the SA has a special role of Non-billed Budget * `EXCL` - Excluded from Auto Pay, * `INCL` - Included in Auto Pay
    Example: INCL
  • Minimum Value: 0
    Maximum Value: 999
    Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.
    Example: 0
  • Maximum Length: 36
    Old Account ID refers to account id for service agreements that were converted from your legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number
    Example: 123456789
  • order
  • premise
  • Maximum Length: 8
    The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this SA. This field is only visible if the SA has a special role of Non-billed Budget.
  • Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type.
  • CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates this is a CIAC service agreement.
  • Maximum Length: 60
    Description for SA Status
    Example: Canceled
  • Maximum Length: 10
    The Service Agreement ID is a system assigned random number that stays with a service agreement for life.
  • serviceAgreementRelationship
  • serviceAgreementType
  • serviceType
    Service Type defines the type of service associated with the SA type.
  • sicCode
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
  • Allowed Values: [ "BC ", "BD ", "CD ", "IN ", "LO ", "NB ", "PA ", "WO " ]
    Special Role: * `BC ` - Billable Charge, * `BD ` - Bill Determinants Required, * `CD ` - Cash Deposit, * `IN ` - Interval, * `LO ` - Loan, * `NB ` - Non-billed Budget, * `PA ` - Payment Arrangement, * `WO ` - Write Off
  • Allowed Values: [ "PROP" ]
    The Special Usage Flag shows if the SA is a proposal SA . You cannot create a quote unless its account has at least one proposal service agreement (SA). A proposal SA contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal SA as special type of service agreement that is ignored when a bill is produced for an account. * `PROP` - Proposal SA
    Example: PROP
  • The Start Date defines when the financial relationship begins.
  • Maximum Length: 12
    Start options save users time and prevent data entry errors because they default many values on a service agreement (e.g., the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, etc. can all be defaulted onto a service agreement from a start option).
  • Allowed Values: [ "C ", "S " ]
    Use Start Reason to define who requested to start the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Start Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was started (e.g., Customer, Jane Smith ).
  • Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
    SA Status defines the state of the service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled
    Example: 20
  • Allowed Values: [ "C ", "S " ]
    Use Stop Reason to define who requested to stop the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Stop Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was stopped (e.g., Customer, Jane Smith ).
  • If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
    Example: 2
Nested Schema : account
Type: object
Show Source
  • Maximum Length: 10
    Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.
    Example: 1589809012
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Currency Code
Show Source
Nested Schema : order
Type: object
Show Source
  • Maximum Length: 12
    Order ID is the system-assigned unique identifier of the order.
Nested Schema : premise
Type: object
Show Source
  • Maximum Length: 10
    If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.
    Example: 8614900960
Nested Schema : serviceAgreementRelationship
Type: object
Show Source
Nested Schema : serviceAgreementType
Type: object
Show Source
  • Maximum Length: 5
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 1
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 8
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 30
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
Nested Schema : serviceType
Type: object
Service Type defines the type of service associated with the SA type.
Show Source
  • Maximum Length: 80
    Service Type defines the type of service associated with the SA type.
    Example: E
Nested Schema : sicCode
Type: object
Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
Show Source
  • Maximum Length: 8
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
    Example: 4800 (Transportation)
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
  • (_link)
  • Maximum Length: 254
    Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite. Good examples of such a characteristic type would be ones used to define a user's birth date or their mother's maiden name.
    Example: 77
  • Maximum Length: 50
    Foreign Key Value 2
  • Maximum Length: 50
    Foreign Key Value 3
  • Maximum Length: 50
    Foreign Key Value 4
  • Maximum Length: 50
    Foreign Key Value 5
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1SAUpdate
Type: object
Show Source
  • _self
  • account
  • Turn on Allow Estimates if it's OK for the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time
  • Maximum Length: 250
    Enter a Business Activity associated with the customer. This can be used to further define what types of activities are served by this contract.
    Example: business
  • characteristics
  • currency
    Currency Code
  • Allowed Values: [ "N ", "Y " ]
    Use Customer Read to define if the customer reads his or her own meter. Valid values are: Yes, No. * `N ` - No, * `Y ` - Yes
    Example: Y
  • Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.
    Example: 2018-02-25
  • The End Date defines when the financial relationship terminates.
    Example: 2018-02-25
  • Expiration Date contains the date at which the service agreement is set to expire.
  • If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in "legal time". This value defaults from either the start option or the installation record.
  • IsActive flag to show active SAs for account
    Example: false
  • Use Maximum Bill Threshold if you want the system to generate a bill error when a bill segment is produced in batch that exceeds a given value.
    Example: 2000
  • Allowed Values: [ "EXCL", "INCL" ]
    The Scheduled Payment Autopay flag determines if the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only visible if the SA has a special role of Non-billed Budget * `EXCL` - Excluded from Auto Pay, * `INCL` - Included in Auto Pay
    Example: INCL
  • Minimum Value: 0
    Maximum Value: 999
    Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.
    Example: 0
  • Maximum Length: 36
    Old Account ID refers to account id for service agreements that were converted from your legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number
    Example: 123456789
  • order
  • premise
  • Maximum Length: 8
    The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this SA. This field is only visible if the SA has a special role of Non-billed Budget.
  • Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type.
  • CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates this is a CIAC service agreement.
  • Maximum Length: 60
    Description for SA Status
    Example: Canceled
  • Maximum Length: 10
    The Service Agreement ID is a system assigned random number that stays with a service agreement for life.
  • serviceAgreementRelationship
  • serviceAgreementType
  • serviceType
    Service Type defines the type of service associated with the SA type.
  • sicCode
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
  • Allowed Values: [ "BC ", "BD ", "CD ", "IN ", "LO ", "NB ", "PA ", "WO " ]
    Special Role: * `BC ` - Billable Charge, * `BD ` - Bill Determinants Required, * `CD ` - Cash Deposit, * `IN ` - Interval, * `LO ` - Loan, * `NB ` - Non-billed Budget, * `PA ` - Payment Arrangement, * `WO ` - Write Off
  • Allowed Values: [ "PROP" ]
    The Special Usage Flag shows if the SA is a proposal SA . You cannot create a quote unless its account has at least one proposal service agreement (SA). A proposal SA contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal SA as special type of service agreement that is ignored when a bill is produced for an account. * `PROP` - Proposal SA
    Example: PROP
  • The Start Date defines when the financial relationship begins.
  • Maximum Length: 12
    Start options save users time and prevent data entry errors because they default many values on a service agreement (e.g., the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, etc. can all be defaulted onto a service agreement from a start option).
  • Allowed Values: [ "C ", "S " ]
    Use Start Reason to define who requested to start the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Start Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was started (e.g., Customer, Jane Smith ).
  • Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
    SA Status defines the state of the service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled
    Example: 20
  • Allowed Values: [ "C ", "S " ]
    Use Stop Reason to define who requested to stop the SA on the Start Stop page. * `C ` - Customer Request, * `S ` - System Generated
    Example: C
  • Maximum Length: 50
    Stop Requested By displays the information entered in the Requested By field on the Start Stop page when this SA was stopped (e.g., Customer, Jane Smith ).
  • If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
    Example: 2
Nested Schema : account
Type: object
Show Source
  • _link
  • Maximum Length: 10
    Account ID is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement (and its debt) to the new account.
    Example: 1589809012
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : currency
Type: object
Currency Code
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : premise
Type: object
Show Source
  • _link
  • Maximum Length: 10
    If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.
    Example: 8614900960
Nested Schema : serviceAgreementRelationship
Type: object
Show Source
Nested Schema : serviceAgreementType
Type: object
Show Source
  • _link
  • Maximum Length: 5
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 1
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 8
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
  • Maximum Length: 30
    The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.
    Example: Ohio
Nested Schema : serviceType
Type: object
Service Type defines the type of service associated with the SA type.
Show Source
Nested Schema : sicCode
Type: object
Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
Show Source
  • _link
  • Maximum Length: 8
    Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
    Example: 4800 (Transportation)
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
  • (_link)
  • Maximum Length: 254
    Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite. Good examples of such a characteristic type would be ones used to define a user's birth date or their mother's maiden name.
    Example: 77
  • Maximum Length: 50
    Foreign Key Value 2
  • Maximum Length: 50
    Foreign Key Value 3
  • Maximum Length: 50
    Foreign Key Value 4
  • Maximum Length: 50
    Foreign Key Value 5

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top