Jump to

• Request
• Response

Get To Do Entry

get

https://server:port/spl/rest/apis/common/toDos/toDoEntries/{toDoEntryId}

This operation retrieves the details for the To Do Entry ID provided.

Request

Path Parameters

• toDoEntryId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : F1GetToDoEn

Type: object

Show Source

• _self: string
  _self
• assignedByUser: object assignedByUser
  The user that assigned the To Do entry.
• assignedDateTime: string (date-time)
  The date and time of the most recent assignment.
• assignedToUser: object assignedToUser
  The ID of the user currently assigned to the To Do Entry.
• characteristics: object characteristics
• comments: string
  Maximum Length: 254

  The comments are free form entries added by a user to provide more information for the To Do entry.
• completedByUser: object completedByUser
  The user that completed the To Do entry.
• completedDateTime: string (date-time)
  The completion date and time.
• creationDateTime: string (date-time)
  The creation date and time.
• drillKeys: object drillKeys
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  The message category for the message that describes the problem. This is provided for informational purposes.
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  The message number for the message that describes the problem. This is provided for informational purposes.
• messageText: string
  Maximum Length: 254

  The expanded message, which combines the message text taken from the message category and message number, with all parameter values substituted, if applicable.
• priority: string
  Allowed Values: [ "010 ", "020 ", "030 ", "040 ", "050 ", "060 ", "070 ", "080 ", "090 " ]

  The Priority allows you to assign a relative priority of this To Do with respect to other To Do entries of the same To Do Type. * `010 ` - Priority 10 -- Highest, * `020 ` - Priority 20, * `030 ` - Priority 30, * `040 ` - Priority 40, * `050 ` - Priority 50, * `060 ` - Priority 60, * `070 ` - Priority 70, * `080 ` - Priority 80, * `090 ` - Priority 90 -- Lowest
• sortKeys: object sortKeys
• status: string
  Allowed Values: [ "C ", "O ", "W " ]

  The Status indicates the current state of the To Do Entry. * `C ` - Completed, * `O ` - Open, * `W ` - Being Worked On
• toDoEntryId: string
  Maximum Length: 14

  The To Do Entry ID uniquely defines the To Do Entry record.
• toDoRole: object toDoRole
  The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry.
• toDoType: object toDoType
  The To Do Type controls configuration related to the To Do Entry.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "toDoEntryId":{
            "type":"string",
            "maxLength":14,
            "description":"The To Do Entry ID uniquely defines the To Do Entry record."
        },
        "toDoType":{
            "type":"object",
            "description":"The To Do Type controls configuration related to the To Do Entry.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "toDoType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The To Do Type controls configuration related to the To Do Entry."
                }
            }
        },
        "toDoRole":{
            "type":"object",
            "description":"The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "toDoRole":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry."
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "C   ",
                "O   ",
                "W   "
            ],
            "description":"The Status indicates the current state of the To Do Entry.\n* `C   ` - Completed,\n* `O   ` - Open,\n* `W   ` - Being Worked On"
        },
        "priority":{
            "type":"string",
            "enum":[
                "010 ",
                "020 ",
                "030 ",
                "040 ",
                "050 ",
                "060 ",
                "070 ",
                "080 ",
                "090 "
            ],
            "description":"The Priority allows you to assign a relative priority of this To Do with respect to other To Do entries of the same To Do Type.\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
        },
        "assignedToUser":{
            "type":"object",
            "description":"The ID of the user currently assigned to the To Do Entry.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "assignedToUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The ID of the user currently assigned to the To Do Entry.",
                    "example":"JDOE"
                }
            }
        },
        "assignedByUser":{
            "type":"object",
            "description":"The user that assigned the To Do entry.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "assignedByUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The user that assigned the To Do entry.",
                    "example":"JSMITH"
                }
            }
        },
        "completedByUser":{
            "type":"object",
            "description":"The user that completed the To Do entry.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "completedByUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The user that completed the To Do entry."
                }
            }
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The message category for the message that describes the problem.  This is provided for informational purposes."
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The message number for the message that describes the problem.  This is provided for informational purposes."
        },
        "messageText":{
            "type":"string",
            "maxLength":254,
            "description":"The expanded message, which combines the message text taken from the message category and message number, with all parameter values substituted, if applicable."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"The comments are free form entries added by a user to provide more information for the To Do entry."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The creation date and time."
        },
        "assignedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the most recent assignment."
        },
        "completedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The completion date and time."
        },
        "sortKeys":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "keyValue":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Key Value"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "drillKeys":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "keyValue":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Key Value"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Char Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1GetToDoEn"
    }
}

Nested Schema : assignedByUser

Type: object

The user that assigned the To Do entry.

Show Source

• _link: string
  _link
• assignedByUser: string
  Maximum Length: 8

  The user that assigned the To Do entry.

  Example: JSMITH

{
    "type":"object",
    "description":"The user that assigned the To Do entry.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "assignedByUser":{
            "type":"string",
            "maxLength":8,
            "description":"The user that assigned the To Do entry.",
            "example":"JSMITH"
        }
    }
}

Nested Schema : assignedToUser

Type: object

The ID of the user currently assigned to the To Do Entry.

Show Source

• _link: string
  _link
• assignedToUser: string
  Maximum Length: 8

  The ID of the user currently assigned to the To Do Entry.

  Example: JDOE

{
    "type":"object",
    "description":"The ID of the user currently assigned to the To Do Entry.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "assignedToUser":{
            "type":"string",
            "maxLength":8,
            "description":"The ID of the user currently assigned to the To Do Entry.",
            "example":"JDOE"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Char Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : completedByUser

Type: object

The user that completed the To Do entry.

Show Source

• _link: string
  _link
• completedByUser: string
  Maximum Length: 8

  The user that completed the To Do entry.

{
    "type":"object",
    "description":"The user that completed the To Do entry.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "completedByUser":{
            "type":"string",
            "maxLength":8,
            "description":"The user that completed the To Do entry."
        }
    }
}

Nested Schema : drillKeys

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "keyValue":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Key Value"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : sortKeys

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "keyValue":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Key Value"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : toDoRole

Type: object

The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry.

Show Source

• _link: string
  _link
• toDoRole: string
  Maximum Length: 10

  The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry.

{
    "type":"object",
    "description":"The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "toDoRole":{
            "type":"string",
            "maxLength":10,
            "description":"The To Do Role identifies the group of users that is able to take certain actions on the To Do Entry."
        }
    }
}

Nested Schema : toDoType

Type: object

The To Do Type controls configuration related to the To Do Entry.

Show Source

• _link: string
  _link
• toDoType: string
  Maximum Length: 8

  The To Do Type controls configuration related to the To Do Entry.

{
    "type":"object",
    "description":"The To Do Type controls configuration related to the To Do Entry.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "toDoType":{
            "type":"string",
            "maxLength":8,
            "description":"The To Do Type controls configuration related to the To Do Entry."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Char Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Char Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Char Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "keyValue":{
                "type":"string",
                "maxLength":50,
                "description":"Key Value"
            },
            "description":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Maximum Length: 60

  Description
• keyValue: string
  Maximum Length: 50

  Key Value
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "keyValue":{
            "type":"string",
            "maxLength":50,
            "description":"Key Value"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "keyValue":{
                "type":"string",
                "maxLength":50,
                "description":"Key Value"
            },
            "description":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Maximum Length: 60

  Description
• keyValue: string
  Maximum Length: 50

  Key Value
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "keyValue":{
            "type":"string",
            "maxLength":50,
            "description":"Key Value"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

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