Oracle Utilities REST API for Metering and Customer Information

Action Adjustment

patch

https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}/lifecycle

This operation updates Adjustment status for given Adjustment Id.

Request

Path Parameters

adjustmentId(required): string
Adjustment ID is the system-assigned, unique identifier of the adjustment.
Example:
```
011163134133
```

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

action: string

Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]

Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
cancelReason: string

Maximum Length: 4

The Cancel Reason describes the reason for the cancelation.
httpMethod: string

Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

Example: GET
onBehalfSAId: string

Maximum Length: 10

On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer.

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1SA"
            ],
            "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
        },
        "onBehalfSAId":{
            "type":"string",
            "maxLength":10,
            "description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"The Cancel Reason describes the reason for the cancelation."
        }
    },
    "xml":{
        "name":"C1ActAdjust"
    }
}

Root Schema : schema

Type: object

Show Source

action: string

Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]

Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
cancelReason: string

Maximum Length: 4

The Cancel Reason describes the reason for the cancelation.
httpMethod: string

Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

Example: GET
onBehalfSAId: string

Maximum Length: 10

On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer.

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1SA"
            ],
            "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
        },
        "onBehalfSAId":{
            "type":"string",
            "maxLength":10,
            "description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"The Cancel Reason describes the reason for the cancelation."
        }
    },
    "xml":{
        "name":"C1ActAdjust"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1ActAdjust

Type: object

Show Source

action: string

Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]

Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
adjustment: object adjustment
adjustmentStatus: string

Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "50 ", "60 " ]

Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links. * `05 ` - New, * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

Example: 30
httpMethod: string

Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

Example: GET
nextActions: array nextActions

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1SA"
            ],
            "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
        },
        "adjustment":{
            "type":"object",
            "properties":{
                "adjustmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "adjustmentStatus":{
            "type":"string",
            "enum":[
                "05  ",
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links.\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CN",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1SA"
                        ],
                        "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActAdjust"
    }
}

Nested Schema : adjustment

Type: object

Show Source

_link: string

_link
adjustmentId: string

Maximum Length: 12

Adjustment ID is the system-assigned, unique identifier of the adjustment.

{
    "type":"object",
    "properties":{
        "adjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CN",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1SA"
                ],
                "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

action: string

Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]

Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1SA"
            ],
            "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
        }
    }
}

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