Jump to

• Request
• Response

Service Questions

post

https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceQuestions

This operation uses the Read Questions algorithm on the CS request type BO to retrieve the applicable service questions when starting new service, adding service, stopping service, or transferring service. The SP-based services to start at a premise and/or the SP-based services to stop for an account should be determined, and a pending self-service start/stop/transfer task already exist before this operation can be used.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• premiseId: string
  Maximum Length: 10

  Premise ID
• premises: object premises
• questionPlacementGroup: string
  Allowed Values: [ "C1-SelfServiceStartService", "C1-SelfServiceStopService" ]

  Question Placement Group is used to logically group questions, based on where the questions are shown on the user interface. * `C1-SelfServiceStartService` - Self-Service - Start Service, * `C1-SelfServiceStopService` - Self-Service - Stop Service

  Example: C1-SelfServiceStartService
• servicePoints: object servicePoints
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "questionPlacementGroup":{
            "type":"string",
            "enum":[
                "C1-SelfServiceStartService",
                "C1-SelfServiceStopService"
            ],
            "description":"Question Placement Group is used to logically group questions, based on where the questions are shown on the user interface.\n* `C1-SelfServiceStartService` - Self-Service - Start Service,\n* `C1-SelfServiceStopService` - Self-Service - Stop Service",
            "example":"C1-SelfServiceStartService"
        },
        "premises":{
            "type":"object",
            "properties":{
                "premise":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            }
                        }
                    }
                }
            }
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "servicePoint":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSGetQstns"
    }
}

Nested Schema : premises

Type: object

Show Source

• premise: array premise

{
    "type":"object",
    "properties":{
        "premise":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• servicePoint: array servicePoint

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        }
    }
}

Nested Schema : servicePoint

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• spId: string
  Maximum Length: 10

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• premiseId: string
  Maximum Length: 10

  Premise ID
• premises: object premises
• questionPlacementGroup: string
  Allowed Values: [ "C1-SelfServiceStartService", "C1-SelfServiceStopService" ]

  Question Placement Group is used to logically group questions, based on where the questions are shown on the user interface. * `C1-SelfServiceStartService` - Self-Service - Start Service, * `C1-SelfServiceStopService` - Self-Service - Stop Service

  Example: C1-SelfServiceStartService
• servicePoints: object servicePoints
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "questionPlacementGroup":{
            "type":"string",
            "enum":[
                "C1-SelfServiceStartService",
                "C1-SelfServiceStopService"
            ],
            "description":"Question Placement Group is used to logically group questions, based on where the questions are shown on the user interface.\n* `C1-SelfServiceStartService` - Self-Service - Start Service,\n* `C1-SelfServiceStopService` - Self-Service - Stop Service",
            "example":"C1-SelfServiceStartService"
        },
        "premises":{
            "type":"object",
            "properties":{
                "premise":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            }
                        }
                    }
                }
            }
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "servicePoint":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSGetQstns"
    }
}

Nested Schema : premises

Type: object

Show Source

• premise: array premise

{
    "type":"object",
    "properties":{
        "premise":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• servicePoint: array servicePoint

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        }
    }
}

Nested Schema : servicePoint

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• spId: string
  Maximum Length: 10

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SSGetQstns

Type: object

Show Source

• questions: object questions

{
    "type":"object",
    "properties":{
        "questions":{
            "type":"object",
            "properties":{
                "question":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "question":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Customer Question is used to capture specific information related to a request.",
                                "example":"SST-OWNPROP"
                            },
                            "level":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":0,
                                "description":"Level Number indicates where a particular question is in the overall hierarchical structure. For DSS, there is a need to identify the 'top-level' instructions.",
                                "example":"3"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "sortSequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "parentSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Parent Sequence is populated on related questions. 'Top-level' questions would not reference a parent.",
                                "example":"3"
                            },
                            "answerStyle":{
                                "type":"string",
                                "enum":[
                                    "CHBX",
                                    "CHTY",
                                    "DATE",
                                    "DTTM",
                                    "RBTN",
                                    "TEXT"
                                ],
                                "description":"Answer Style defines the response's data type and controls how the valid answer(s) are rendered on the user interface.\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input",
                                "example":"CHTY"
                            },
                            "questionApplicability":{
                                "type":"string",
                                "enum":[
                                    "C1OP",
                                    "C1RQ"
                                ],
                                "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                            },
                            "promptText":{
                                "type":"string",
                                "maxLength":4000,
                                "description":"Detailed Description"
                            },
                            "defaultAnswer":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Default answer to the question. It is either one of the valid answers or freeform text.",
                                "example":"OWN"
                            },
                            "validAnswers":{
                                "type":"object",
                                "properties":{
                                    "validAnswer":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence"
                                                },
                                                "answer":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Answer is the unique identifier across the customer question's valid answers",
                                                    "example":"OWN"
                                                },
                                                "description":{
                                                    "type":"string",
                                                    "maxLength":4000,
                                                    "description":"Detailed Description"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "relatedQuestions":{
                                "type":"object",
                                "properties":{
                                    "relatedQuestion":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "validAnswer":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Answer is the unique identifier across the customer question's valid answers",
                                                    "example":"OWN"
                                                },
                                                "relatedQuestionSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Used to determine the next question based on the Valid Answer.",
                                                    "example":"10"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "relatedObjects":{
                                "type":"object",
                                "properties":{
                                    "relatedObject":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "mo":{
                                                    "type":"string",
                                                    "maxLength":12,
                                                    "description":"Related object MO.",
                                                    "example":"SP"
                                                },
                                                "relatedObjectType":{
                                                    "type":"string",
                                                    "enum":[
                                                        "C1PT",
                                                        "C1SP"
                                                    ],
                                                    "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                                                    "example":"C1SP"
                                                },
                                                "pkValue1":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Related object PK value 1",
                                                    "example":"E-RES"
                                                },
                                                "pkValue2":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Related object PK value 2"
                                                },
                                                "pkValue3":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Related object PK value 3"
                                                },
                                                "pkValue4":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Related object PK value 4"
                                                },
                                                "pkValue5":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Related object PK value 5"
                                                },
                                                "questionApplicability":{
                                                    "type":"string",
                                                    "enum":[
                                                        "C1OP",
                                                        "C1RQ"
                                                    ],
                                                    "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSGetQstns"
    }
}

Nested Schema : questions

Type: object

Show Source

• question: array question

{
    "type":"object",
    "properties":{
        "question":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "question":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Customer Question is used to capture specific information related to a request.",
                        "example":"SST-OWNPROP"
                    },
                    "level":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Level Number indicates where a particular question is in the overall hierarchical structure. For DSS, there is a need to identify the 'top-level' instructions.",
                        "example":"3"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "sortSequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "parentSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Parent Sequence is populated on related questions. 'Top-level' questions would not reference a parent.",
                        "example":"3"
                    },
                    "answerStyle":{
                        "type":"string",
                        "enum":[
                            "CHBX",
                            "CHTY",
                            "DATE",
                            "DTTM",
                            "RBTN",
                            "TEXT"
                        ],
                        "description":"Answer Style defines the response's data type and controls how the valid answer(s) are rendered on the user interface.\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input",
                        "example":"CHTY"
                    },
                    "questionApplicability":{
                        "type":"string",
                        "enum":[
                            "C1OP",
                            "C1RQ"
                        ],
                        "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                    },
                    "promptText":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Detailed Description"
                    },
                    "defaultAnswer":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Default answer to the question. It is either one of the valid answers or freeform text.",
                        "example":"OWN"
                    },
                    "validAnswers":{
                        "type":"object",
                        "properties":{
                            "validAnswer":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence"
                                        },
                                        "answer":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Answer is the unique identifier across the customer question's valid answers",
                                            "example":"OWN"
                                        },
                                        "description":{
                                            "type":"string",
                                            "maxLength":4000,
                                            "description":"Detailed Description"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "relatedQuestions":{
                        "type":"object",
                        "properties":{
                            "relatedQuestion":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "validAnswer":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Answer is the unique identifier across the customer question's valid answers",
                                            "example":"OWN"
                                        },
                                        "relatedQuestionSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Used to determine the next question based on the Valid Answer.",
                                            "example":"10"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "relatedObjects":{
                        "type":"object",
                        "properties":{
                            "relatedObject":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "mo":{
                                            "type":"string",
                                            "maxLength":12,
                                            "description":"Related object MO.",
                                            "example":"SP"
                                        },
                                        "relatedObjectType":{
                                            "type":"string",
                                            "enum":[
                                                "C1PT",
                                                "C1SP"
                                            ],
                                            "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                                            "example":"C1SP"
                                        },
                                        "pkValue1":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Related object PK value 1",
                                            "example":"E-RES"
                                        },
                                        "pkValue2":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Related object PK value 2"
                                        },
                                        "pkValue3":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Related object PK value 3"
                                        },
                                        "pkValue4":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Related object PK value 4"
                                        },
                                        "pkValue5":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Related object PK value 5"
                                        },
                                        "questionApplicability":{
                                            "type":"string",
                                            "enum":[
                                                "C1OP",
                                                "C1RQ"
                                            ],
                                            "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : question

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "question":{
                "type":"string",
                "maxLength":30,
                "description":"Customer Question is used to capture specific information related to a request.",
                "example":"SST-OWNPROP"
            },
            "level":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Level Number indicates where a particular question is in the overall hierarchical structure. For DSS, there is a need to identify the 'top-level' instructions.",
                "example":"3"
            },
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "sortSequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "parentSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Parent Sequence is populated on related questions. 'Top-level' questions would not reference a parent.",
                "example":"3"
            },
            "answerStyle":{
                "type":"string",
                "enum":[
                    "CHBX",
                    "CHTY",
                    "DATE",
                    "DTTM",
                    "RBTN",
                    "TEXT"
                ],
                "description":"Answer Style defines the response's data type and controls how the valid answer(s) are rendered on the user interface.\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input",
                "example":"CHTY"
            },
            "questionApplicability":{
                "type":"string",
                "enum":[
                    "C1OP",
                    "C1RQ"
                ],
                "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
            },
            "promptText":{
                "type":"string",
                "maxLength":4000,
                "description":"Detailed Description"
            },
            "defaultAnswer":{
                "type":"string",
                "maxLength":254,
                "description":"Default answer to the question. It is either one of the valid answers or freeform text.",
                "example":"OWN"
            },
            "validAnswers":{
                "type":"object",
                "properties":{
                    "validAnswer":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence"
                                },
                                "answer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Answer is the unique identifier across the customer question's valid answers",
                                    "example":"OWN"
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":4000,
                                    "description":"Detailed Description"
                                }
                            }
                        }
                    }
                }
            },
            "relatedQuestions":{
                "type":"object",
                "properties":{
                    "relatedQuestion":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "validAnswer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Answer is the unique identifier across the customer question's valid answers",
                                    "example":"OWN"
                                },
                                "relatedQuestionSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Used to determine the next question based on the Valid Answer.",
                                    "example":"10"
                                }
                            }
                        }
                    }
                }
            },
            "relatedObjects":{
                "type":"object",
                "properties":{
                    "relatedObject":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "mo":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Related object MO.",
                                    "example":"SP"
                                },
                                "relatedObjectType":{
                                    "type":"string",
                                    "enum":[
                                        "C1PT",
                                        "C1SP"
                                    ],
                                    "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                                    "example":"C1SP"
                                },
                                "pkValue1":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Related object PK value 1",
                                    "example":"E-RES"
                                },
                                "pkValue2":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Related object PK value 2"
                                },
                                "pkValue3":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Related object PK value 3"
                                },
                                "pkValue4":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Related object PK value 4"
                                },
                                "pkValue5":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Related object PK value 5"
                                },
                                "questionApplicability":{
                                    "type":"string",
                                    "enum":[
                                        "C1OP",
                                        "C1RQ"
                                    ],
                                    "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• answerStyle: string
  Allowed Values: [ "CHBX", "CHTY", "DATE", "DTTM", "RBTN", "TEXT" ]

  Answer Style defines the response's data type and controls how the valid answer(s) are rendered on the user interface. * `CHBX` - Checkbox, * `CHTY` - Predefined Characteristic Type, * `DATE` - Date, * `DTTM` - Date/Time, * `RBTN` - Radio Button, * `TEXT` - Text Input

  Example: CHTY
• defaultAnswer: string
  Maximum Length: 254

  Default answer to the question. It is either one of the valid answers or freeform text.

  Example: OWN
• level: number
  Minimum Value: 0

  Maximum Value: 99999

  Level Number indicates where a particular question is in the overall hierarchical structure. For DSS, there is a need to identify the 'top-level' instructions.

  Example: 3
• parentSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Parent Sequence is populated on related questions. 'Top-level' questions would not reference a parent.

  Example: 3
• promptText: string
  Maximum Length: 4000

  Detailed Description
• question: string
  Maximum Length: 30

  Customer Question is used to capture specific information related to a request.

  Example: SST-OWNPROP
• questionApplicability: string
  Allowed Values: [ "C1OP", "C1RQ" ]

  Question Applicability: * `C1OP` - Optional, * `C1RQ` - Required
• relatedObjects: object relatedObjects
• relatedQuestions: object relatedQuestions
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• sortSequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• validAnswers: object validAnswers

{
    "type":"object",
    "properties":{
        "question":{
            "type":"string",
            "maxLength":30,
            "description":"Customer Question is used to capture specific information related to a request.",
            "example":"SST-OWNPROP"
        },
        "level":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Level Number indicates where a particular question is in the overall hierarchical structure. For DSS, there is a need to identify the 'top-level' instructions.",
            "example":"3"
        },
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "sortSequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "parentSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Parent Sequence is populated on related questions. 'Top-level' questions would not reference a parent.",
            "example":"3"
        },
        "answerStyle":{
            "type":"string",
            "enum":[
                "CHBX",
                "CHTY",
                "DATE",
                "DTTM",
                "RBTN",
                "TEXT"
            ],
            "description":"Answer Style defines the response's data type and controls how the valid answer(s) are rendered on the user interface.\n* `CHBX` - Checkbox,\n* `CHTY` - Predefined Characteristic Type,\n* `DATE` - Date,\n* `DTTM` - Date/Time,\n* `RBTN` - Radio Button,\n* `TEXT` - Text Input",
            "example":"CHTY"
        },
        "questionApplicability":{
            "type":"string",
            "enum":[
                "C1OP",
                "C1RQ"
            ],
            "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
        },
        "promptText":{
            "type":"string",
            "maxLength":4000,
            "description":"Detailed Description"
        },
        "defaultAnswer":{
            "type":"string",
            "maxLength":254,
            "description":"Default answer to the question. It is either one of the valid answers or freeform text.",
            "example":"OWN"
        },
        "validAnswers":{
            "type":"object",
            "properties":{
                "validAnswer":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "answer":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Answer is the unique identifier across the customer question's valid answers",
                                "example":"OWN"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":4000,
                                "description":"Detailed Description"
                            }
                        }
                    }
                }
            }
        },
        "relatedQuestions":{
            "type":"object",
            "properties":{
                "relatedQuestion":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "validAnswer":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Answer is the unique identifier across the customer question's valid answers",
                                "example":"OWN"
                            },
                            "relatedQuestionSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Used to determine the next question based on the Valid Answer.",
                                "example":"10"
                            }
                        }
                    }
                }
            }
        },
        "relatedObjects":{
            "type":"object",
            "properties":{
                "relatedObject":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "mo":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Related object MO.",
                                "example":"SP"
                            },
                            "relatedObjectType":{
                                "type":"string",
                                "enum":[
                                    "C1PT",
                                    "C1SP"
                                ],
                                "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                                "example":"C1SP"
                            },
                            "pkValue1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Related object PK value 1",
                                "example":"E-RES"
                            },
                            "pkValue2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Related object PK value 2"
                            },
                            "pkValue3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Related object PK value 3"
                            },
                            "pkValue4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Related object PK value 4"
                            },
                            "pkValue5":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Related object PK value 5"
                            },
                            "questionApplicability":{
                                "type":"string",
                                "enum":[
                                    "C1OP",
                                    "C1RQ"
                                ],
                                "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : relatedObjects

Type: object

Show Source

• relatedObject: array relatedObject

{
    "type":"object",
    "properties":{
        "relatedObject":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "mo":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Related object MO.",
                        "example":"SP"
                    },
                    "relatedObjectType":{
                        "type":"string",
                        "enum":[
                            "C1PT",
                            "C1SP"
                        ],
                        "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                        "example":"C1SP"
                    },
                    "pkValue1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Related object PK value 1",
                        "example":"E-RES"
                    },
                    "pkValue2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Related object PK value 2"
                    },
                    "pkValue3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Related object PK value 3"
                    },
                    "pkValue4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Related object PK value 4"
                    },
                    "pkValue5":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Related object PK value 5"
                    },
                    "questionApplicability":{
                        "type":"string",
                        "enum":[
                            "C1OP",
                            "C1RQ"
                        ],
                        "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
                    }
                }
            }
        }
    }
}

Nested Schema : relatedQuestions

Type: object

Show Source

• relatedQuestion: array relatedQuestion

{
    "type":"object",
    "properties":{
        "relatedQuestion":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "validAnswer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Answer is the unique identifier across the customer question's valid answers",
                        "example":"OWN"
                    },
                    "relatedQuestionSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Used to determine the next question based on the Valid Answer.",
                        "example":"10"
                    }
                }
            }
        }
    }
}

Nested Schema : validAnswers

Type: object

Show Source

• validAnswer: array validAnswer

{
    "type":"object",
    "properties":{
        "validAnswer":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "answer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Answer is the unique identifier across the customer question's valid answers",
                        "example":"OWN"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Detailed Description"
                    }
                }
            }
        }
    }
}

Nested Schema : relatedObject

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mo":{
                "type":"string",
                "maxLength":12,
                "description":"Related object MO.",
                "example":"SP"
            },
            "relatedObjectType":{
                "type":"string",
                "enum":[
                    "C1PT",
                    "C1SP"
                ],
                "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
                "example":"C1SP"
            },
            "pkValue1":{
                "type":"string",
                "maxLength":254,
                "description":"Related object PK value 1",
                "example":"E-RES"
            },
            "pkValue2":{
                "type":"string",
                "maxLength":254,
                "description":"Related object PK value 2"
            },
            "pkValue3":{
                "type":"string",
                "maxLength":254,
                "description":"Related object PK value 3"
            },
            "pkValue4":{
                "type":"string",
                "maxLength":254,
                "description":"Related object PK value 4"
            },
            "pkValue5":{
                "type":"string",
                "maxLength":254,
                "description":"Related object PK value 5"
            },
            "questionApplicability":{
                "type":"string",
                "enum":[
                    "C1OP",
                    "C1RQ"
                ],
                "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• mo: string
  Maximum Length: 12

  Related object MO.

  Example: SP
• pkValue1: string
  Maximum Length: 254

  Related object PK value 1

  Example: E-RES
• pkValue2: string
  Maximum Length: 254

  Related object PK value 2
• pkValue3: string
  Maximum Length: 254

  Related object PK value 3
• pkValue4: string
  Maximum Length: 254

  Related object PK value 4
• pkValue5: string
  Maximum Length: 254

  Related object PK value 5
• questionApplicability: string
  Allowed Values: [ "C1OP", "C1RQ" ]

  Question Applicability: * `C1OP` - Optional, * `C1RQ` - Required
• relatedObjectType: string
  Allowed Values: [ "C1PT", "C1SP" ]

  Question Related Object Applicability control the applicability of question to certain entities. * `C1PT` - Premise Type, * `C1SP` - SP Type.

  Example: C1SP

{
    "type":"object",
    "properties":{
        "mo":{
            "type":"string",
            "maxLength":12,
            "description":"Related object MO.",
            "example":"SP"
        },
        "relatedObjectType":{
            "type":"string",
            "enum":[
                "C1PT",
                "C1SP"
            ],
            "description":"Question Related Object Applicability control the applicability of question to certain entities.\n* `C1PT` - Premise Type,\n* `C1SP` - SP Type.",
            "example":"C1SP"
        },
        "pkValue1":{
            "type":"string",
            "maxLength":254,
            "description":"Related object PK value 1",
            "example":"E-RES"
        },
        "pkValue2":{
            "type":"string",
            "maxLength":254,
            "description":"Related object PK value 2"
        },
        "pkValue3":{
            "type":"string",
            "maxLength":254,
            "description":"Related object PK value 3"
        },
        "pkValue4":{
            "type":"string",
            "maxLength":254,
            "description":"Related object PK value 4"
        },
        "pkValue5":{
            "type":"string",
            "maxLength":254,
            "description":"Related object PK value 5"
        },
        "questionApplicability":{
            "type":"string",
            "enum":[
                "C1OP",
                "C1RQ"
            ],
            "description":"Question Applicability:\n* `C1OP` - Optional,\n* `C1RQ` - Required"
        }
    }
}

Nested Schema : relatedQuestion

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "validAnswer":{
                "type":"string",
                "maxLength":30,
                "description":"Answer is the unique identifier across the customer question's valid answers",
                "example":"OWN"
            },
            "relatedQuestionSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Used to determine the next question based on the Valid Answer.",
                "example":"10"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• relatedQuestionSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Used to determine the next question based on the Valid Answer.

  Example: 10
• validAnswer: string
  Maximum Length: 30

  Answer is the unique identifier across the customer question's valid answers

  Example: OWN

{
    "type":"object",
    "properties":{
        "validAnswer":{
            "type":"string",
            "maxLength":30,
            "description":"Answer is the unique identifier across the customer question's valid answers",
            "example":"OWN"
        },
        "relatedQuestionSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Used to determine the next question based on the Valid Answer.",
            "example":"10"
        }
    }
}

Nested Schema : validAnswer

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "answer":{
                "type":"string",
                "maxLength":30,
                "description":"Answer is the unique identifier across the customer question's valid answers",
                "example":"OWN"
            },
            "description":{
                "type":"string",
                "maxLength":4000,
                "description":"Detailed Description"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• answer: string
  Maximum Length: 30

  Answer is the unique identifier across the customer question's valid answers

  Example: OWN
• description: string
  Maximum Length: 4000

  Detailed Description
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "answer":{
            "type":"string",
            "maxLength":30,
            "description":"Answer is the unique identifier across the customer question's valid answers",
            "example":"OWN"
        },
        "description":{
            "type":"string",
            "maxLength":4000,
            "description":"Detailed Description"
        }
    }
}

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