Jump to

• Request
• Response

Get Program Unenrollment

get

https://server:port/rest/apis/cross/digitalAssets/programEnrollments/unenroll/{Unenrollment Id}

This REST web service retrieves the status of a customer's unenrollment request for a program from Oracle Utilities Digital Asset Cloud Service.

Request

Path Parameters

• Unenrollment Id(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 : X1-DAUnenrol

Type: object

Show Source

• appointmentSlots: object appointmentSlots
• assetInfo: object assetInfo
• customerInfo: object customerInfo
• deviceSetup: object deviceSetup
• exception: object exception
• locationInfo: object locationInfo
• programInfo: object programInfo
• relatedObjects: object relatedObjects
• status: string
  Maximum Length: 12

  Status of the program unenrollment based on business object lifecycle
• transactionId: string
  Maximum Length: 120

  External transaction identifier created initially by the external source application, such as the Grid Edge Distributed Energy Resource Management System
• unenrollmentId: string
  Maximum Length: 4

  A unique identifer created by the application for each Unenrollment request
• unenrollReason: string
  Allowed Values: [ "LSSL", "CUSTOMEROPTOUT", "INACTIVESERVICE", "INELIGIBLERATE" ]

  Unenroll Reason: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate

{
    "type":"object",
    "properties":{
        "unenrollmentId":{
            "type":"string",
            "maxLength":"4",
            "description":"A unique identifer created by the application for each Unenrollment request"
        },
        "transactionId":{
            "type":"string",
            "maxLength":"120",
            "description":"External transaction identifier created initially by the external source application, such as the Grid Edge Distributed Energy Resource Management System"
        },
        "status":{
            "type":"string",
            "maxLength":"12",
            "description":"Status of the program unenrollment based on business object lifecycle"
        },
        "relatedObjects":{
            "type":"object",
            "properties":{
                "contactId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"A unique identifier associated to the customer contact within Oracle Utilities Digital Asset Cloud Service"
                },
                "subscriptionId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"A unique identifer associated to a Program Subscription within Oracle Utilities Digital Asset Cloud Service"
                },
                "locationId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"A unique identifer associated to a Device Location within Oracle Utilities Digital Asset Cloud Service"
                }
            }
        },
        "unenrollReason":{
            "type":"string",
            "enum":[
                "LSSL",
                "CUSTOMEROPTOUT",
                "INACTIVESERVICE",
                "INELIGIBLERATE"
            ],
            "description":"Unenroll Reason:\n* `LSSL` - Life Support / Sensitive Load,\n* `CUSTOMEROPTOUT` - Customer Initiated Opt-Out,\n* `INACTIVESERVICE` - Inactive Service,\n* `INELIGIBLERATE` - Ineligible Rate"
        },
        "customerInfo":{
            "type":"object",
            "properties":{
                "cisPersonId":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "cisAccountId":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "name":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                },
                "homePhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                },
                "businessPhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                },
                "email":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                }
            }
        },
        "programInfo":{
            "type":"object",
            "properties":{
                "programId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"A unique identifer associated to a Program within Oracle Utilities Digital Asset Cloud Service"
                },
                "endDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The desired application date of unenrollment."
                }
            }
        },
        "locationInfo":{
            "type":"object",
            "properties":{
                "cisPremiseId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "cisServicePointID":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "division":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Division is used to define the jurisdiction in which the customer is located."
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Time Zone"
                },
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
                }
            }
        },
        "assetInfo":{
            "type":"object",
            "properties":{
                "removalMethod":{
                    "type":"string",
                    "enum":[
                        "X1KP",
                        "X1SD",
                        "X1UR"
                    ],
                    "description":"Removal Method:\n* `X1KP` - Keep,\n* `X1SD` - Ship Device,\n* `X1UR` - Utility Removal"
                },
                "assetOwnership":{
                    "type":"string",
                    "enum":[
                        "W1CO",
                        "W1OW"
                    ],
                    "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
                }
            }
        },
        "deviceSetup":{
            "type":"object",
            "properties":{
                "deviceSetupActionsList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"0",
                                "description":"Sequence"
                            },
                            "setupAction":{
                                "type":"string",
                                "enum":[
                                    "X1AC",
                                    "X1DC",
                                    "X1NA",
                                    "X1TD",
                                    "X1WO"
                                ],
                                "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order"
                            },
                            "toDoType":{
                                "type":"string",
                                "maxLength":"8",
                                "description":"To Do Type refer to the categorization of certain events that occur within the system and trigger messages describing work that requires attention"
                            },
                            "toDoRole":{
                                "type":"string",
                                "maxLength":"10",
                                "description":"To Do Roles are assigned to users and are referenced by a To Do Entry created by the system"
                            },
                            "toDoId":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"To Do refers to certain events that occur within the system and trigger messages describing work that requires attention"
                            },
                            "activityType":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
                            },
                            "fieldTaskType":{
                                "type":"string",
                                "enum":[
                                    "X1-InvestigateControllableDevice",
                                    "X1-InstallControllableDevice"
                                ],
                                "description":"Field Task Type:\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `X1-InstallControllableDevice` - Install Controllable Device"
                            },
                            "activityId":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"A system generated unique identifer associated to each Activity that is created"
                            },
                            "templateWorkOrderId":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"A unique identifer of a Work Order created as template for generating work orders"
                            },
                            "workOrderId":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"A system generated unique identifer associated to each Work Order that is created"
                            }
                        }
                    }
                }
            }
        },
        "appointmentSlots":{
            "type":"object",
            "properties":{
                "crewShiftList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "activityType":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
                            },
                            "crewShiftId":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"Crew Shift identifier that identifies a planned period of time in which a crew (one or more workers) is scheduled to perform work"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Appointment Start Date and Time for the scheduled work"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Appointment End Date and Time for the scheduled work"
                            },
                            "crewId":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity"
                            },
                            "workAvailabilityDuration":{
                                "type":"number",
                                "maximum":"99999999999.99",
                                "minimum":"0",
                                "description":"Work Availability expressed in Hours for the particular crew"
                            }
                        }
                    }
                }
            }
        },
        "exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"string",
                    "maxLength":"5",
                    "description":"Message Category"
                },
                "messageNumber":{
                    "type":"string",
                    "maxLength":"5",
                    "description":"Message Number"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Expanded message parameter"
                }
            }
        }
    },
    "xml":{
        "name":"X1-DAUnenrol"
    }
}

Nested Schema : appointmentSlots

Type: object

Show Source

• crewShiftList: array crewShiftList

{
    "type":"object",
    "properties":{
        "crewShiftList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "activityType":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
                    },
                    "crewShiftId":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"Crew Shift identifier that identifies a planned period of time in which a crew (one or more workers) is scheduled to perform work"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Appointment Start Date and Time for the scheduled work"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Appointment End Date and Time for the scheduled work"
                    },
                    "crewId":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity"
                    },
                    "workAvailabilityDuration":{
                        "type":"number",
                        "maximum":"99999999999.99",
                        "minimum":"0",
                        "description":"Work Availability expressed in Hours for the particular crew"
                    }
                }
            }
        }
    }
}

Nested Schema : assetInfo

Type: object

Show Source

• assetOwnership: string
  Allowed Values: [ "W1CO", "W1OW" ]

  Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `W1CO` - Customer Owned, * `W1OW` - Utility Owned
• removalMethod: string
  Allowed Values: [ "X1KP", "X1SD", "X1UR" ]

  Removal Method: * `X1KP` - Keep, * `X1SD` - Ship Device, * `X1UR` - Utility Removal

{
    "type":"object",
    "properties":{
        "removalMethod":{
            "type":"string",
            "enum":[
                "X1KP",
                "X1SD",
                "X1UR"
            ],
            "description":"Removal Method:\n* `X1KP` - Keep,\n* `X1SD` - Ship Device,\n* `X1UR` - Utility Removal"
        },
        "assetOwnership":{
            "type":"string",
            "enum":[
                "W1CO",
                "W1OW"
            ],
            "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
        }
    }
}

Nested Schema : customerInfo

Type: object

Show Source

• businessPhone: string
  Maximum Length: 24

  The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
• cisAccountId: string
  Maximum Length: 30

  The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• cisPersonId: string
  Maximum Length: 30

  The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• email: string
  Maximum Length: 254

  The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
• homePhone: string
  Maximum Length: 24

  The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
• name: string
  Maximum Length: 254

  The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.

{
    "type":"object",
    "properties":{
        "cisPersonId":{
            "type":"string",
            "maxLength":"30",
            "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "cisAccountId":{
            "type":"string",
            "maxLength":"30",
            "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "name":{
            "type":"string",
            "maxLength":"254",
            "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        },
        "homePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        },
        "businessPhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        },
        "email":{
            "type":"string",
            "maxLength":"254",
            "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        }
    }
}

Nested Schema : deviceSetup

Type: object

Show Source

• deviceSetupActionsList: array deviceSetupActionsList

{
    "type":"object",
    "properties":{
        "deviceSetupActionsList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"0",
                        "description":"Sequence"
                    },
                    "setupAction":{
                        "type":"string",
                        "enum":[
                            "X1AC",
                            "X1DC",
                            "X1NA",
                            "X1TD",
                            "X1WO"
                        ],
                        "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order"
                    },
                    "toDoType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"To Do Type refer to the categorization of certain events that occur within the system and trigger messages describing work that requires attention"
                    },
                    "toDoRole":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"To Do Roles are assigned to users and are referenced by a To Do Entry created by the system"
                    },
                    "toDoId":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"To Do refers to certain events that occur within the system and trigger messages describing work that requires attention"
                    },
                    "activityType":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
                    },
                    "fieldTaskType":{
                        "type":"string",
                        "enum":[
                            "X1-InvestigateControllableDevice",
                            "X1-InstallControllableDevice"
                        ],
                        "description":"Field Task Type:\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `X1-InstallControllableDevice` - Install Controllable Device"
                    },
                    "activityId":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"A system generated unique identifer associated to each Activity that is created"
                    },
                    "templateWorkOrderId":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"A unique identifer of a Work Order created as template for generating work orders"
                    },
                    "workOrderId":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"A system generated unique identifer associated to each Work Order that is created"
                    }
                }
            }
        }
    }
}

Nested Schema : exception

Type: object

Show Source

• expandedMessage: string
  Maximum Length: 60

  Expanded message parameter
• messageCategory: string
  Maximum Length: 5

  Message Category
• messageNumber: string
  Maximum Length: 5

  Message Number

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"string",
            "maxLength":"5",
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"string",
            "maxLength":"5",
            "description":"Message Number"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":"60",
            "description":"Expanded message parameter"
        }
    }
}

Nested Schema : locationInfo

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line of the address. Used to derive the metered service point associated to the enrollment.
• address2: string
  Maximum Length: 254

  The second line of the address. Used to derive the metered service point associated to the enrollment.
• address3: string
  Maximum Length: 254

  The third line of the address. Used to derive the metered service point associated to the enrollment.
• address4: string
  Maximum Length: 254

  The fourth line of the address. Used to derive the metered service point associated to the enrollment.
• cisPremiseId: string
  Maximum Length: 60

  The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• cisServicePointID: string
  Maximum Length: 60

  The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• city: string
  Maximum Length: 90

  The city of the address. Used to derive the metered service point associated to the enrollment.
• country: string
  Maximum Length: 3

  The country of the address. Used to derive the metered service point associated to the enrollment.
• county: string
  Maximum Length: 90

  The county of the address. Used to derive the metered service point associated to the enrollment.
• division: string
  Maximum Length: 30

  Division is used to define the jurisdiction in which the customer is located.
• postal: string
  Maximum Length: 12

  The postal code of the address. Used to derive the metered service point associated to the enrollment.
• state: string
  Maximum Length: 6

  The state of the address. Used to derive the metered service point associated to the enrollment.
• timeZone: string
  Maximum Length: 10

  Time Zone

{
    "type":"object",
    "properties":{
        "cisPremiseId":{
            "type":"string",
            "maxLength":"60",
            "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "cisServicePointID":{
            "type":"string",
            "maxLength":"60",
            "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "division":{
            "type":"string",
            "maxLength":"30",
            "description":"Division is used to define the jurisdiction in which the customer is located."
        },
        "timeZone":{
            "type":"string",
            "maxLength":"10",
            "description":"Time Zone"
        },
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
        }
    }
}

Nested Schema : programInfo

Type: object

Show Source

• endDate: string (date)
  The desired application date of unenrollment.
• programId: string
  Maximum Length: 12

  A unique identifer associated to a Program within Oracle Utilities Digital Asset Cloud Service

{
    "type":"object",
    "properties":{
        "programId":{
            "type":"string",
            "maxLength":"12",
            "description":"A unique identifer associated to a Program within Oracle Utilities Digital Asset Cloud Service"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The desired application date of unenrollment."
        }
    }
}

Nested Schema : relatedObjects

Type: object

Show Source

• contactId: string
  Maximum Length: 12

  A unique identifier associated to the customer contact within Oracle Utilities Digital Asset Cloud Service
• locationId: string
  Maximum Length: 12

  A unique identifer associated to a Device Location within Oracle Utilities Digital Asset Cloud Service
• subscriptionId: string
  Maximum Length: 12

  A unique identifer associated to a Program Subscription within Oracle Utilities Digital Asset Cloud Service

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":"12",
            "description":"A unique identifier associated to the customer contact within Oracle Utilities Digital Asset Cloud Service"
        },
        "subscriptionId":{
            "type":"string",
            "maxLength":"12",
            "description":"A unique identifer associated to a Program Subscription within Oracle Utilities Digital Asset Cloud Service"
        },
        "locationId":{
            "type":"string",
            "maxLength":"12",
            "description":"A unique identifer associated to a Device Location within Oracle Utilities Digital Asset Cloud Service"
        }
    }
}

Nested Schema : crewShiftList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "activityType":{
                "type":"string",
                "maxLength":"30",
                "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
            },
            "crewShiftId":{
                "type":"string",
                "maxLength":"14",
                "description":"Crew Shift identifier that identifies a planned period of time in which a crew (one or more workers) is scheduled to perform work"
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Appointment Start Date and Time for the scheduled work"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Appointment End Date and Time for the scheduled work"
            },
            "crewId":{
                "type":"string",
                "maxLength":"12",
                "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity"
            },
            "workAvailabilityDuration":{
                "type":"number",
                "maximum":"99999999999.99",
                "minimum":"0",
                "description":"Work Availability expressed in Hours for the particular crew"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• activityType: string
  Maximum Length: 30

  Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records
• crewId: string
  Maximum Length: 12

  Crew identifier for primary and secondary crew members that are assigned a particular work activity
• crewShiftId: string
  Maximum Length: 14

  Crew Shift identifier that identifies a planned period of time in which a crew (one or more workers) is scheduled to perform work
• endDateTime: string (date-time)
  Appointment End Date and Time for the scheduled work
• startDateTime: string (date-time)
  Appointment Start Date and Time for the scheduled work
• workAvailabilityDuration: number
  Minimum Value: 0

  Maximum Value: 99999999999.99

  Work Availability expressed in Hours for the particular crew

{
    "type":"object",
    "properties":{
        "activityType":{
            "type":"string",
            "maxLength":"30",
            "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
        },
        "crewShiftId":{
            "type":"string",
            "maxLength":"14",
            "description":"Crew Shift identifier that identifies a planned period of time in which a crew (one or more workers) is scheduled to perform work"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Appointment Start Date and Time for the scheduled work"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Appointment End Date and Time for the scheduled work"
        },
        "crewId":{
            "type":"string",
            "maxLength":"12",
            "description":"Crew identifier for primary and secondary crew members that are assigned a particular work activity"
        },
        "workAvailabilityDuration":{
            "type":"number",
            "maximum":"99999999999.99",
            "minimum":"0",
            "description":"Work Availability expressed in Hours for the particular crew"
        }
    }
}

Nested Schema : deviceSetupActionsList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"0",
                "description":"Sequence"
            },
            "setupAction":{
                "type":"string",
                "enum":[
                    "X1AC",
                    "X1DC",
                    "X1NA",
                    "X1TD",
                    "X1WO"
                ],
                "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order"
            },
            "toDoType":{
                "type":"string",
                "maxLength":"8",
                "description":"To Do Type refer to the categorization of certain events that occur within the system and trigger messages describing work that requires attention"
            },
            "toDoRole":{
                "type":"string",
                "maxLength":"10",
                "description":"To Do Roles are assigned to users and are referenced by a To Do Entry created by the system"
            },
            "toDoId":{
                "type":"string",
                "maxLength":"14",
                "description":"To Do refers to certain events that occur within the system and trigger messages describing work that requires attention"
            },
            "activityType":{
                "type":"string",
                "maxLength":"30",
                "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
            },
            "fieldTaskType":{
                "type":"string",
                "enum":[
                    "X1-InvestigateControllableDevice",
                    "X1-InstallControllableDevice"
                ],
                "description":"Field Task Type:\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `X1-InstallControllableDevice` - Install Controllable Device"
            },
            "activityId":{
                "type":"string",
                "maxLength":"14",
                "description":"A system generated unique identifer associated to each Activity that is created"
            },
            "templateWorkOrderId":{
                "type":"string",
                "maxLength":"12",
                "description":"A unique identifer of a Work Order created as template for generating work orders"
            },
            "workOrderId":{
                "type":"string",
                "maxLength":"14",
                "description":"A system generated unique identifer associated to each Work Order that is created"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• activityId: string
  Maximum Length: 14

  A system generated unique identifer associated to each Activity that is created
• activityType: string
  Maximum Length: 30

  Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records
• fieldTaskType: string
  Allowed Values: [ "X1-InvestigateControllableDevice", "X1-InstallControllableDevice" ]

  Field Task Type: * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `X1-InstallControllableDevice` - Install Controllable Device
• sequence: number
  Minimum Value: 0

  Maximum Value: 999

  Sequence
• setupAction: string
  Allowed Values: [ "X1AC", "X1DC", "X1NA", "X1TD", "X1WO" ]

  Setup Action: * `X1AC` - Create Activity, * `X1DC` - Initiate Controllable Device Command, * `X1NA` - No Action Needed, * `X1TD` - Create To Do, * `X1WO` - Create Work Order
• templateWorkOrderId: string
  Maximum Length: 12

  A unique identifer of a Work Order created as template for generating work orders
• toDoId: string
  Maximum Length: 14

  To Do refers to certain events that occur within the system and trigger messages describing work that requires attention
• toDoRole: string
  Maximum Length: 10

  To Do Roles are assigned to users and are referenced by a To Do Entry created by the system
• toDoType: string
  Maximum Length: 8

  To Do Type refer to the categorization of certain events that occur within the system and trigger messages describing work that requires attention
• workOrderId: string
  Maximum Length: 14

  A system generated unique identifer associated to each Work Order that is created

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"0",
            "description":"Sequence"
        },
        "setupAction":{
            "type":"string",
            "enum":[
                "X1AC",
                "X1DC",
                "X1NA",
                "X1TD",
                "X1WO"
            ],
            "description":"Setup Action:\n* `X1AC` - Create Activity,\n* `X1DC` - Initiate Controllable Device Command,\n* `X1NA` - No Action Needed,\n* `X1TD` - Create To Do,\n* `X1WO` - Create Work Order"
        },
        "toDoType":{
            "type":"string",
            "maxLength":"8",
            "description":"To Do Type refer to the categorization of certain events that occur within the system and trigger messages describing work that requires attention"
        },
        "toDoRole":{
            "type":"string",
            "maxLength":"10",
            "description":"To Do Roles are assigned to users and are referenced by a To Do Entry created by the system"
        },
        "toDoId":{
            "type":"string",
            "maxLength":"14",
            "description":"To Do refers to certain events that occur within the system and trigger messages describing work that requires attention"
        },
        "activityType":{
            "type":"string",
            "maxLength":"30",
            "description":"Activity Type define the main attributes for activities of a certain type and act as a model and template for Activity records"
        },
        "fieldTaskType":{
            "type":"string",
            "enum":[
                "X1-InvestigateControllableDevice",
                "X1-InstallControllableDevice"
            ],
            "description":"Field Task Type:\n* `X1-InvestigateControllableDevice` - Investigate Controllable Device,\n* `X1-InstallControllableDevice` - Install Controllable Device"
        },
        "activityId":{
            "type":"string",
            "maxLength":"14",
            "description":"A system generated unique identifer associated to each Activity that is created"
        },
        "templateWorkOrderId":{
            "type":"string",
            "maxLength":"12",
            "description":"A unique identifer of a Work Order created as template for generating work orders"
        },
        "workOrderId":{
            "type":"string",
            "maxLength":"14",
            "description":"A system generated unique identifer associated to each Work Order that is created"
        }
    }
}

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