Jump to

• Request
• Response

Action Payment

patch

https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/action

This operation handles the Integration Suite API to Action Payment

Request

Path Parameters

• paymentId(required): string

Query Parameters

• name: string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• cancelReason: string
  Maximum Length: 30

  If the payment is canceled , the Cancel Reason is displayed.

  Example: Data entry error
• isPayTransfer: boolean
  When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.

  Example: true
• name: string
  (name)
• nextActions: object nextActions
• paymentId: string
  Maximum Length: 12

  Payment ID is the system-assigned unique identifier of the payment.

  Example: 317896608844
• paymentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]

  Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

  Example: 30
• transferAccountId: string
  Maximum Length: 10

  Account ID is the account to which the payment event should be transferred.
• transferCancelReason: string
  Maximum Length: 4

  Cancel Reason defines why you are performing the payment event transfer.

  Example: NSF (Non sufficient funds)
• transferMatchType: string
  Maximum Length: 8

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: BILL-ID (Bill ID / Sequential Bill Number)
• transferMatchValue: string
  Maximum Length: 30

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: 995516242555
• transferNonCISComment: string
  Maximum Length: 254

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisName: string
  Maximum Length: 50

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisReferenceNumber: string
  Maximum Length: 30

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "name":{
            "type":"string",
            "description":"(name)"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":30,
            "description":"If the payment is canceled , the Cancel Reason is displayed.",
            "example":"Data entry error"
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "isPayTransfer":{
            "type":"boolean",
            "description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.",
            "example":"true"
        },
        "transferAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the account to which the payment event should be transferred."
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCisReferenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why you are performing the payment event transfer.",
            "example":"NSF\n\n(Non sufficient funds)"
        },
        "transferMatchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "transferMatchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"995516242555"
        },
        "nextActions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "actionName":{
                                "type":"string",
                                "description":"(actionName)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActionPyt"
    }
}

Nested Schema : nextActions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "actionName":{
                        "type":"string",
                        "description":"(actionName)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "actionName":{
                "type":"string",
                "description":"(actionName)"
            },
            "_link":{
                "type":"string",
                "description":"(_link)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _link: string
  (_link)
• actionName: string
  (actionName)

{
    "type":"object",
    "properties":{
        "actionName":{
            "type":"string",
            "description":"(actionName)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cancelReason: string
  Maximum Length: 30

  If the payment is canceled , the Cancel Reason is displayed.

  Example: Data entry error
• isPayTransfer: boolean
  When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.

  Example: true
• name: string
  (name)
• nextActions: object nextActions
• paymentId: string
  Maximum Length: 12

  Payment ID is the system-assigned unique identifier of the payment.

  Example: 317896608844
• paymentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]

  Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

  Example: 30
• transferAccountId: string
  Maximum Length: 10

  Account ID is the account to which the payment event should be transferred.
• transferCancelReason: string
  Maximum Length: 4

  Cancel Reason defines why you are performing the payment event transfer.

  Example: NSF (Non sufficient funds)
• transferMatchType: string
  Maximum Length: 8

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: BILL-ID (Bill ID / Sequential Bill Number)
• transferMatchValue: string
  Maximum Length: 30

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: 995516242555
• transferNonCISComment: string
  Maximum Length: 254

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisName: string
  Maximum Length: 50

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisReferenceNumber: string
  Maximum Length: 30

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "name":{
            "type":"string",
            "description":"(name)"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":30,
            "description":"If the payment is canceled , the Cancel Reason is displayed.",
            "example":"Data entry error"
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "isPayTransfer":{
            "type":"boolean",
            "description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.",
            "example":"true"
        },
        "transferAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the account to which the payment event should be transferred."
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCisReferenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why you are performing the payment event transfer.",
            "example":"NSF\n\n(Non sufficient funds)"
        },
        "transferMatchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "transferMatchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"995516242555"
        },
        "nextActions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "actionName":{
                                "type":"string",
                                "description":"(actionName)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActionPyt"
    }
}

Nested Schema : nextActions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "actionName":{
                        "type":"string",
                        "description":"(actionName)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "actionName":{
                "type":"string",
                "description":"(actionName)"
            },
            "_link":{
                "type":"string",
                "description":"(_link)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _link: string
  (_link)
• actionName: string
  (actionName)

{
    "type":"object",
    "properties":{
        "actionName":{
            "type":"string",
            "description":"(actionName)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ActionPyt

Type: object

Show Source

• cancelReason: string
  Maximum Length: 30

  If the payment is canceled , the Cancel Reason is displayed.

  Example: Data entry error
• isPayTransfer: boolean
  When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.

  Example: true
• name: string
  (name)
• nextActions: object nextActions
• paymentId: string
  Maximum Length: 12

  Payment ID is the system-assigned unique identifier of the payment.

  Example: 317896608844
• paymentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]

  Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

  Example: 30
• transferAccountId: string
  Maximum Length: 10

  Account ID is the account to which the payment event should be transferred.
• transferCancelReason: string
  Maximum Length: 4

  Cancel Reason defines why you are performing the payment event transfer.

  Example: NSF (Non sufficient funds)
• transferMatchType: string
  Maximum Length: 8

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: BILL-ID (Bill ID / Sequential Bill Number)
• transferMatchValue: string
  Maximum Length: 30

  Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

  Example: 995516242555
• transferNonCISComment: string
  Maximum Length: 254

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisName: string
  Maximum Length: 50

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisReferenceNumber: string
  Maximum Length: 30

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "name":{
            "type":"string",
            "description":"(name)"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":30,
            "description":"If the payment is canceled , the Cancel Reason is displayed.",
            "example":"Data entry error"
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "isPayTransfer":{
            "type":"boolean",
            "description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.",
            "example":"true"
        },
        "transferAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the account to which the payment event should be transferred."
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCisReferenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why you are performing the payment event transfer.",
            "example":"NSF\n\n(Non sufficient funds)"
        },
        "transferMatchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "transferMatchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"995516242555"
        },
        "nextActions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "actionName":{
                                "type":"string",
                                "description":"(actionName)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActionPyt"
    }
}

Nested Schema : nextActions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "actionName":{
                        "type":"string",
                        "description":"(actionName)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "actionName":{
                "type":"string",
                "description":"(actionName)"
            },
            "_link":{
                "type":"string",
                "description":"(_link)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _link: string
  (_link)
• actionName: string
  (actionName)

{
    "type":"object",
    "properties":{
        "actionName":{
            "type":"string",
            "description":"(actionName)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

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