Jump to

• Request
• Response

Cancel Field Activity

patch

/rest/apis/meter/service/fieldActivities/{activityId}/cancel

Request

Path Parameters

• activityId(required): string
  System-generated unique identifier for the field activity.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• cancelReasonCode: string
  Allowed Values: [ "M2-INCOMPLETE", "D1-AutoDiscarded", "ZZTEST3", "ZZTEST2", "D1-Undetermined", "ZZTEST" ]

  The reason for cancelling the original activity (for canceled activities only). * `M2-INCOMPLETE` - INCOMPLETE, * `D1-AutoDiscarded` - Auto Discarded, * `ZZTEST3` - TEST 3, * `ZZTEST2` - TEST 2 EDIT, * `D1-Undetermined` - Undetermined, * `ZZTEST` - TEST OVRD DESC
• sourceSystem: string
  Maximum Length: 30

  External source system

{
    "type":"object",
    "properties":{
        "cancelReasonCode":{
            "type":"string",
            "enum":[
                "M2-INCOMPLETE",
                "D1-AutoDiscarded",
                "ZZTEST3",
                "ZZTEST2",
                "D1-Undetermined",
                "ZZTEST"
            ],
            "description":"The reason for cancelling the original activity (for canceled activities only).\n* `M2-INCOMPLETE` - INCOMPLETE,\n* `D1-AutoDiscarded` - Auto Discarded,\n* `ZZTEST3` - TEST 3,\n* `ZZTEST2` - TEST 2 EDIT,\n* `D1-Undetermined` - Undetermined,\n* `ZZTEST` - TEST OVRD DESC"
        },
        "sourceSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External source system"
        }
    },
    "xml":{
        "name":"D1-CancelFA"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cancelReasonCode: string
  Allowed Values: [ "M2-INCOMPLETE", "D1-AutoDiscarded", "ZZTEST3", "ZZTEST2", "D1-Undetermined", "ZZTEST" ]

  The reason for cancelling the original activity (for canceled activities only). * `M2-INCOMPLETE` - INCOMPLETE, * `D1-AutoDiscarded` - Auto Discarded, * `ZZTEST3` - TEST 3, * `ZZTEST2` - TEST 2 EDIT, * `D1-Undetermined` - Undetermined, * `ZZTEST` - TEST OVRD DESC
• sourceSystem: string
  Maximum Length: 30

  External source system

{
    "type":"object",
    "properties":{
        "cancelReasonCode":{
            "type":"string",
            "enum":[
                "M2-INCOMPLETE",
                "D1-AutoDiscarded",
                "ZZTEST3",
                "ZZTEST2",
                "D1-Undetermined",
                "ZZTEST"
            ],
            "description":"The reason for cancelling the original activity (for canceled activities only).\n* `M2-INCOMPLETE` - INCOMPLETE,\n* `D1-AutoDiscarded` - Auto Discarded,\n* `ZZTEST3` - TEST 3,\n* `ZZTEST2` - TEST 2 EDIT,\n* `D1-Undetermined` - Undetermined,\n* `ZZTEST` - TEST OVRD DESC"
        },
        "sourceSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External source system"
        }
    },
    "xml":{
        "name":"D1-CancelFA"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1-CancelFA

Type: object

Show Source

• activity: object activity
• bo: string
  Maximum Length: 30

  The business object (BO) of the Service Order Management Activity.
• boStatus: string
  Maximum Length: 12

  The current status code of the service order field activity.
• boStatusDescription: string
  Maximum Length: 254

  The current status description of the service order field activity.
• exceptionInformationList: array exceptionInformationList
• pendingChanges: boolean
  Pending Changes

{
    "type":"object",
    "properties":{
        "activity":{
            "type":"object",
            "properties":{
                "activityId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"System-generated unique identifier for the field activity."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "bo":{
            "type":"string",
            "maxLength":30,
            "description":"The business object (BO) of the Service Order Management Activity."
        },
        "boStatus":{
            "type":"string",
            "maxLength":12,
            "description":"The current status code of the service order field activity."
        },
        "boStatusDescription":{
            "type":"string",
            "maxLength":254,
            "description":"The current status description of the service order field activity."
        },
        "pendingChanges":{
            "type":"boolean",
            "description":"Pending Changes"
        },
        "exceptionInformationList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"A unique Sequence number is given to each entry after the information is saved."
                    },
                    "expandedMessage":{
                        "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."
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message category within Oracle Utilities Application Framework."
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Number within Oracle Utilities Application Framework."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-CancelFA"
    }
}

Nested Schema : activity

Type: object

Show Source

• _link: string
  _link
• activityId: string
  Maximum Length: 14

  System-generated unique identifier for the field activity.

{
    "type":"object",
    "properties":{
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"System-generated unique identifier for the field activity."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : exceptionInformationList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"A unique Sequence number is given to each entry after the information is saved."
            },
            "expandedMessage":{
                "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."
            },
            "messageCategory":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message category within Oracle Utilities Application Framework."
            },
            "messageNumber":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Number within Oracle Utilities Application Framework."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• expandedMessage: 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.
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category within Oracle Utilities Application Framework.
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  A unique Sequence number is given to each entry after the information is saved.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"A unique Sequence number is given to each entry after the information is saved."
        },
        "expandedMessage":{
            "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."
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category within Oracle Utilities Application Framework."
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        }
    }
}

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