Oracle Utilities REST API for Metering and Customer Information

Get Work Queue

get

https://server:port/spl/rest/apis/customer/service/workQueue/

This operation handles the Integration Suite API to Get Work Queue

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1WorkQueue

Type: object

Show Source

items: array items
rowCount: number

Minimum Value: 0

Maximum Value: 99999

Row Count

Example: 8

{
    "type":"object",
    "properties":{
        "rowCount":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Row Count",
            "example":"8"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "maxLength":12,
                        "description":"ID is the system-assigned unique identifier of the entry.",
                        "example":"32234000828888"
                    },
                    "title":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Title contains a description of the To Do entry.",
                        "example":"$3,000.00 KC - Approval Test adjustment for Black,Jack requires approval."
                    },
                    "severity":{
                        "type":"string",
                        "maxLength":6,
                        "description":"A To Do entry is associated with a priority level representing its relative processing order compared to other entries.",
                        "example":"010"
                    },
                    "severityLabel":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Priority level description for ToDo entry.",
                        "example":"Priority 10 -- Highest"
                    },
                    "status":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Status"
                    },
                    "statusLabel":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Status"
                    },
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Item Type displays a code of the To Do type for the To Do entry.",
                        "example":"C1-ADAPP"
                    },
                    "itemTypeLabel":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Item Description contains a description of the To Do type for the To Do entry.",
                        "example":"Adjustments Requiring Approval"
                    },
                    "updateDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Create Date/Time contains the date and time the To Do entry was created by the system.",
                        "example":"2013-08-28-01.20.46"
                    },
                    "displayIconOracle":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                        "example":"ico-financials.svg"
                    },
                    "navigationInfo":{
                        "type":"object",
                        "properties":{
                            "navigationType":{
                                "type":"string",
                                "description":"(navigationType)"
                            },
                            "navigationContext":{
                                "type":"string",
                                "description":"(navigationContext)"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1WorkQueue"
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "maxLength":12,
                "description":"ID is the system-assigned unique identifier of the entry.",
                "example":"32234000828888"
            },
            "title":{
                "type":"string",
                "maxLength":60,
                "description":"Title contains a description of the To Do entry.",
                "example":"$3,000.00 KC - Approval Test adjustment for Black,Jack requires approval."
            },
            "severity":{
                "type":"string",
                "maxLength":6,
                "description":"A To Do entry is associated with a priority level representing its relative processing order compared to other entries.",
                "example":"010"
            },
            "severityLabel":{
                "type":"string",
                "maxLength":60,
                "description":"Priority level description for ToDo entry.",
                "example":"Priority 10 -- Highest"
            },
            "status":{
                "type":"string",
                "maxLength":12,
                "description":"Status"
            },
            "statusLabel":{
                "type":"string",
                "maxLength":12,
                "description":"Status"
            },
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Item Type displays a code of the To Do type for the To Do entry.",
                "example":"C1-ADAPP"
            },
            "itemTypeLabel":{
                "type":"string",
                "maxLength":60,
                "description":"Item Description contains a description of the To Do type for the To Do entry.",
                "example":"Adjustments Requiring Approval"
            },
            "updateDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Create Date/Time contains the date and time the To Do entry was created by the system.",
                "example":"2013-08-28-01.20.46"
            },
            "displayIconOracle":{
                "type":"string",
                "maxLength":12,
                "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
                "example":"ico-financials.svg"
            },
            "navigationInfo":{
                "type":"object",
                "properties":{
                    "navigationType":{
                        "type":"string",
                        "description":"(navigationType)"
                    },
                    "navigationContext":{
                        "type":"string",
                        "description":"(navigationContext)"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayIconOracle: string

Maximum Length: 12

Icon Name from Redwood library for example "ico-contacts.svg", "ico-check.svg". This is the URL value from the display icon reference code definition.

Example: ico-financials.svg
id: string

Maximum Length: 12

ID is the system-assigned unique identifier of the entry.

Example: 32234000828888
itemType: string

Maximum Length: 30

Item Type displays a code of the To Do type for the To Do entry.

Example: C1-ADAPP
itemTypeLabel: string

Maximum Length: 60

Item Description contains a description of the To Do type for the To Do entry.

Example: Adjustments Requiring Approval
navigationInfo: object navigationInfo
severity: string

Maximum Length: 6

A To Do entry is associated with a priority level representing its relative processing order compared to other entries.

Example: 010
severityLabel: string

Maximum Length: 60

Priority level description for ToDo entry.

Example: Priority 10 -- Highest
status: string

Maximum Length: 12

Status
statusLabel: string

Maximum Length: 12

Status
title: string

Maximum Length: 60

Title contains a description of the To Do entry.

Example: $3,000.00 KC - Approval Test adjustment for Black,Jack requires approval.
updateDateTime: string (date-time)

Create Date/Time contains the date and time the To Do entry was created by the system.

Example: 2013-08-28-01.20.46

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":12,
            "description":"ID is the system-assigned unique identifier of the entry.",
            "example":"32234000828888"
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Title contains a description of the To Do entry.",
            "example":"$3,000.00 KC - Approval Test adjustment for Black,Jack requires approval."
        },
        "severity":{
            "type":"string",
            "maxLength":6,
            "description":"A To Do entry is associated with a priority level representing its relative processing order compared to other entries.",
            "example":"010"
        },
        "severityLabel":{
            "type":"string",
            "maxLength":60,
            "description":"Priority level description for ToDo entry.",
            "example":"Priority 10 -- Highest"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "statusLabel":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Item Type displays a code of the To Do type for the To Do entry.",
            "example":"C1-ADAPP"
        },
        "itemTypeLabel":{
            "type":"string",
            "maxLength":60,
            "description":"Item Description contains a description of the To Do type for the To Do entry.",
            "example":"Adjustments Requiring Approval"
        },
        "updateDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time contains the date and time the To Do entry was created by the system.",
            "example":"2013-08-28-01.20.46"
        },
        "displayIconOracle":{
            "type":"string",
            "maxLength":12,
            "description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.",
            "example":"ico-financials.svg"
        },
        "navigationInfo":{
            "type":"object",
            "properties":{
                "navigationType":{
                    "type":"string",
                    "description":"(navigationType)"
                },
                "navigationContext":{
                    "type":"string",
                    "description":"(navigationContext)"
                }
            }
        }
    }
}

Nested Schema : navigationInfo

Type: object

Show Source

navigationContext: string

(navigationContext)
navigationType: string

(navigationType)

{
    "type":"object",
    "properties":{
        "navigationType":{
            "type":"string",
            "description":"(navigationType)"
        },
        "navigationContext":{
            "type":"string",
            "description":"(navigationContext)"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}