Jump to

• Request
• Response

Get To Do Entry Logs

get

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

This operation retrieves the log entries 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 : F1GetTDELog

Type: object

Show Source

• _self: string
  _self
• logs: object logs

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "logs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "logDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The date and time the log was created."
                            },
                            "logType":{
                                "type":"string",
                                "enum":[
                                    "ASND",
                                    "CMPT",
                                    "CRET",
                                    "F1CP",
                                    "F1OP",
                                    "FWDD",
                                    "SBCK",
                                    "UDET"
                                ],
                                "description":"The type of log entry.\n* `ASND` - Assigned,\n* `CMPT` - Completed,\n* `CRET` - Created,\n* `F1CP` - Calculated Priority,\n* `F1OP` - Override Priority,\n* `FWDD` - Forwarded,\n* `SBCK` - Sent Back,\n* `UDET` - User Details"
                            },
                            "user":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "user":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "assignedToUser":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "assignedToUser":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee."
                                    }
                                }
                            },
                            "longDescription":{
                                "type":"string",
                                "maxLength":4000,
                                "description":"Additional details associated with the log entry."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1GetTDELog"
    }
}

Nested Schema : logs

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"
                    },
                    "logDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The date and time the log was created."
                    },
                    "logType":{
                        "type":"string",
                        "enum":[
                            "ASND",
                            "CMPT",
                            "CRET",
                            "F1CP",
                            "F1OP",
                            "FWDD",
                            "SBCK",
                            "UDET"
                        ],
                        "description":"The type of log entry.\n* `ASND` - Assigned,\n* `CMPT` - Completed,\n* `CRET` - Created,\n* `F1CP` - Calculated Priority,\n* `F1OP` - Override Priority,\n* `FWDD` - Forwarded,\n* `SBCK` - Sent Back,\n* `UDET` - User Details"
                    },
                    "user":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "user":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "assignedToUser":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "assignedToUser":{
                                "type":"string",
                                "maxLength":8,
                                "description":"If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee."
                            }
                        }
                    },
                    "longDescription":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Additional details associated with the log entry."
                    },
                    "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"
            },
            "logDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The date and time the log was created."
            },
            "logType":{
                "type":"string",
                "enum":[
                    "ASND",
                    "CMPT",
                    "CRET",
                    "F1CP",
                    "F1OP",
                    "FWDD",
                    "SBCK",
                    "UDET"
                ],
                "description":"The type of log entry.\n* `ASND` - Assigned,\n* `CMPT` - Completed,\n* `CRET` - Created,\n* `F1CP` - Calculated Priority,\n* `F1OP` - Override Priority,\n* `FWDD` - Forwarded,\n* `SBCK` - Sent Back,\n* `UDET` - User Details"
            },
            "user":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "user":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "assignedToUser":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "assignedToUser":{
                        "type":"string",
                        "maxLength":8,
                        "description":"If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee."
                    }
                }
            },
            "longDescription":{
                "type":"string",
                "maxLength":4000,
                "description":"Additional details associated with the log entry."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assignedToUser: object assignedToUser
• logDateTime: string (date-time)
  The date and time the log was created.
• logType: string
  Allowed Values: [ "ASND", "CMPT", "CRET", "F1CP", "F1OP", "FWDD", "SBCK", "UDET" ]

  The type of log entry. * `ASND` - Assigned, * `CMPT` - Completed, * `CRET` - Created, * `F1CP` - Calculated Priority, * `F1OP` - Override Priority, * `FWDD` - Forwarded, * `SBCK` - Sent Back, * `UDET` - User Details
• longDescription: string
  Maximum Length: 4000

  Additional details associated with the log entry.
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "logDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the log was created."
        },
        "logType":{
            "type":"string",
            "enum":[
                "ASND",
                "CMPT",
                "CRET",
                "F1CP",
                "F1OP",
                "FWDD",
                "SBCK",
                "UDET"
            ],
            "description":"The type of log entry.\n* `ASND` - Assigned,\n* `CMPT` - Completed,\n* `CRET` - Created,\n* `F1CP` - Calculated Priority,\n* `F1OP` - Override Priority,\n* `FWDD` - Forwarded,\n* `SBCK` - Sent Back,\n* `UDET` - User Details"
        },
        "user":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "user":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "assignedToUser":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "assignedToUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee."
                }
            }
        },
        "longDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Additional details associated with the log entry."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : assignedToUser

Type: object

Show Source

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

  If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "assignedToUser":{
            "type":"string",
            "maxLength":8,
            "description":"If the log was created at a time when the To Do Entry was assigned to a specific user, this is the User ID of the assignee."
        }
    }
}

Nested Schema : user

Type: object

Show Source

• _link: string
  _link
• user: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "user":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

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