Jump to

• Request
• Response

Action Budget

patch

https://server:port/spl/rest/apis/customer/financials/budgets/{accountId}/lifecycle

This operation perform actions like recommend, cancel, and save on budget.

Request

Path Parameters

• accountId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID identifies the account of the customer for which the budget exists.

  Example: 1112345900
• action: string
  Allowed Values: [ "C1CN", "C1RC", "C1SV" ]

  Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save
• budgetPlan: object budgetPlan
  Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
• currency: string
  Maximum Length: 3

  Currency Code
• newBudgetDate: string (date)
  Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.

  Example: 2021-12-14
• serviceAgreementsList: object serviceAgreementsList
• totalBudgetAmount: number
  Total Budget Amount displays the sum of the service agreements' current budget amounts.

  Example: 252$
• totalNewBudgetAmount: number
  For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.

  Example: 0.00$

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the account of the customer for which the budget exists.",
            "example":"1112345900"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1RC",
                "C1SV"
            ],
            "description":"Available action for the budget.\n* `C1CN` - Cancel,\n* `C1RC` - Recommend Budget,\n* `C1SV` - Save"
        },
        "budgetPlan":{
            "type":"object",
            "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
            "properties":{
                "budgetPlan":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Budget Plan"
                }
            }
        },
        "newBudgetDate":{
            "type":"string",
            "format":"date",
            "description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.",
            "example":"2021-12-14"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "serviceAgreementsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "lastChangedDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                                "example":"2021-12-15"
                            },
                            "budgetAmount":{
                                "type":"number",
                                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                                "example":"232.00"
                            },
                            "newBudgetAmount":{
                                "type":"number",
                                "description":"New Budget"
                            }
                        }
                    }
                }
            }
        },
        "totalBudgetAmount":{
            "type":"number",
            "description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.",
            "example":"252$"
        },
        "totalNewBudgetAmount":{
            "type":"number",
            "description":"For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.",
            "example":"0.00$"
        }
    },
    "xml":{
        "name":"C1BudgetDeta"
    }
}

Nested Schema : budgetPlan

Type: object

Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.

Show Source

• budgetPlan: string
  Maximum Length: 8

  Budget Plan

{
    "type":"object",
    "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
    "properties":{
        "budgetPlan":{
            "type":"string",
            "maxLength":8,
            "description":"Budget Plan"
        }
    }
}

Nested Schema : serviceAgreementsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "lastChangedDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                        "example":"2021-12-15"
                    },
                    "budgetAmount":{
                        "type":"number",
                        "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                        "example":"232.00"
                    },
                    "newBudgetAmount":{
                        "type":"number",
                        "description":"New Budget"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "lastChangedDate":{
                "type":"string",
                "format":"date",
                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                "example":"2021-12-15"
            },
            "budgetAmount":{
                "type":"number",
                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                "example":"232.00"
            },
            "newBudgetAmount":{
                "type":"number",
                "description":"New Budget"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• budgetAmount: number
  Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.

  Example: 232.00
• lastChangedDate: string (date)
  Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.

  Example: 2021-12-15
• newBudgetAmount: number
  New Budget
• serviceAgreement: object serviceAgreement

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "lastChangedDate":{
            "type":"string",
            "format":"date",
            "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
            "example":"2021-12-15"
        },
        "budgetAmount":{
            "type":"number",
            "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
            "example":"232.00"
        },
        "newBudgetAmount":{
            "type":"number",
            "description":"New Budget"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID identifies the account of the customer for which the budget exists.

  Example: 1112345900
• action: string
  Allowed Values: [ "C1CN", "C1RC", "C1SV" ]

  Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save
• budgetPlan: object budgetPlan
  Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
• currency: string
  Maximum Length: 3

  Currency Code
• newBudgetDate: string (date)
  Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.

  Example: 2021-12-14
• serviceAgreementsList: object serviceAgreementsList
• totalBudgetAmount: number
  Total Budget Amount displays the sum of the service agreements' current budget amounts.

  Example: 252$
• totalNewBudgetAmount: number
  For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.

  Example: 0.00$

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the account of the customer for which the budget exists.",
            "example":"1112345900"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1RC",
                "C1SV"
            ],
            "description":"Available action for the budget.\n* `C1CN` - Cancel,\n* `C1RC` - Recommend Budget,\n* `C1SV` - Save"
        },
        "budgetPlan":{
            "type":"object",
            "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
            "properties":{
                "budgetPlan":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Budget Plan"
                }
            }
        },
        "newBudgetDate":{
            "type":"string",
            "format":"date",
            "description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.",
            "example":"2021-12-14"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "serviceAgreementsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "lastChangedDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                                "example":"2021-12-15"
                            },
                            "budgetAmount":{
                                "type":"number",
                                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                                "example":"232.00"
                            },
                            "newBudgetAmount":{
                                "type":"number",
                                "description":"New Budget"
                            }
                        }
                    }
                }
            }
        },
        "totalBudgetAmount":{
            "type":"number",
            "description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.",
            "example":"252$"
        },
        "totalNewBudgetAmount":{
            "type":"number",
            "description":"For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.",
            "example":"0.00$"
        }
    },
    "xml":{
        "name":"C1BudgetDeta"
    }
}

Nested Schema : budgetPlan

Type: object

Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.

Show Source

• budgetPlan: string
  Maximum Length: 8

  Budget Plan

{
    "type":"object",
    "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
    "properties":{
        "budgetPlan":{
            "type":"string",
            "maxLength":8,
            "description":"Budget Plan"
        }
    }
}

Nested Schema : serviceAgreementsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "lastChangedDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                        "example":"2021-12-15"
                    },
                    "budgetAmount":{
                        "type":"number",
                        "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                        "example":"232.00"
                    },
                    "newBudgetAmount":{
                        "type":"number",
                        "description":"New Budget"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "lastChangedDate":{
                "type":"string",
                "format":"date",
                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                "example":"2021-12-15"
            },
            "budgetAmount":{
                "type":"number",
                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                "example":"232.00"
            },
            "newBudgetAmount":{
                "type":"number",
                "description":"New Budget"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• budgetAmount: number
  Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.

  Example: 232.00
• lastChangedDate: string (date)
  Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.

  Example: 2021-12-15
• newBudgetAmount: number
  New Budget
• serviceAgreement: object serviceAgreement

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "lastChangedDate":{
            "type":"string",
            "format":"date",
            "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
            "example":"2021-12-15"
        },
        "budgetAmount":{
            "type":"number",
            "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
            "example":"232.00"
        },
        "newBudgetAmount":{
            "type":"number",
            "description":"New Budget"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1BudgetDeta

Type: object

Show Source

• _self: string
  _self
• accountId: string
  Maximum Length: 10

  Account ID identifies the account of the customer for which the budget exists.

  Example: 1112345900
• action: string
  Allowed Values: [ "C1CN", "C1RC", "C1SV" ]

  Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save
• budgetPlan: object budgetPlan
  Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
• currency: string
  Maximum Length: 3

  Currency Code
• newBudgetDate: string (date)
  Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.

  Example: 2021-12-14
• serviceAgreementsList: object serviceAgreementsList
• totalBudgetAmount: number
  Total Budget Amount displays the sum of the service agreements' current budget amounts.

  Example: 252$
• totalNewBudgetAmount: number
  For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.

  Example: 0.00$

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the account of the customer for which the budget exists.",
            "example":"1112345900"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1RC",
                "C1SV"
            ],
            "description":"Available action for the budget.\n* `C1CN` - Cancel,\n* `C1RC` - Recommend Budget,\n* `C1SV` - Save"
        },
        "budgetPlan":{
            "type":"object",
            "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "budgetPlan":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Budget Plan"
                }
            }
        },
        "newBudgetDate":{
            "type":"string",
            "format":"date",
            "description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.",
            "example":"2021-12-14"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "serviceAgreementsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "lastChangedDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                                "example":"2021-12-15"
                            },
                            "budgetAmount":{
                                "type":"number",
                                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                                "example":"232.00"
                            },
                            "newBudgetAmount":{
                                "type":"number",
                                "description":"New Budget"
                            }
                        }
                    }
                }
            }
        },
        "totalBudgetAmount":{
            "type":"number",
            "description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.",
            "example":"252$"
        },
        "totalNewBudgetAmount":{
            "type":"number",
            "description":"For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.",
            "example":"0.00$"
        }
    },
    "xml":{
        "name":"C1BudgetDeta"
    }
}

Nested Schema : budgetPlan

Type: object

Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.

Show Source

• _link: string
  _link
• budgetPlan: string
  Maximum Length: 8

  Budget Plan

{
    "type":"object",
    "description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "budgetPlan":{
            "type":"string",
            "maxLength":8,
            "description":"Budget Plan"
        }
    }
}

Nested Schema : serviceAgreementsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "lastChangedDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                        "example":"2021-12-15"
                    },
                    "budgetAmount":{
                        "type":"number",
                        "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                        "example":"232.00"
                    },
                    "newBudgetAmount":{
                        "type":"number",
                        "description":"New Budget"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "lastChangedDate":{
                "type":"string",
                "format":"date",
                "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
                "example":"2021-12-15"
            },
            "budgetAmount":{
                "type":"number",
                "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
                "example":"232.00"
            },
            "newBudgetAmount":{
                "type":"number",
                "description":"New Budget"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• budgetAmount: number
  Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.

  Example: 232.00
• lastChangedDate: string (date)
  Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.

  Example: 2021-12-15
• newBudgetAmount: number
  New Budget
• serviceAgreement: object serviceAgreement

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "lastChangedDate":{
            "type":"string",
            "format":"date",
            "description":"Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.",
            "example":"2021-12-15"
        },
        "budgetAmount":{
            "type":"number",
            "description":"Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.",
            "example":"232.00"
        },
        "newBudgetAmount":{
            "type":"number",
            "description":"New Budget"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

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

  Maximum Value: 9999

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

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

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

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

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

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

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

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

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

  Maximum Value: 0

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

  Maximum Value: 99999

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

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

  Name of the program that encountered the error.

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

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

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

  Maximum Value: 9999

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

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

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

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

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

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

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

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

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

  Maximum Value: 0

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

  Maximum Value: 99999

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

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

  Name of the program that encountered the error.

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

Back to Top