Jump to

• Request
• Response

Retrieve Dropdown Lists

post

/rest/apis/common/admin/dropdownLists/

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

• dropdowns: array dropdowns
  Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

{
    "type":"object",
    "properties":{
        "dropdowns":{
            "type":"array",
            "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
            "items":{
                "type":"object",
                "properties":{
                    "dropdownType":{
                        "type":"string",
                        "enum":[
                            "BS  ",
                            "EXLK",
                            "LKUP",
                            "MO  ",
                            "SS  "
                        ],
                        "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
                    },
                    "lookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
                    },
                    "extLookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
                    },
                    "adminMo":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
                    },
                    "bs":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "ss":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "serviceInput":{
                        "type":"array",
                        "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
                        "items":{
                            "type":"object",
                            "properties":{
                                "fieldXpath":{
                                    "type":"string",
                                    "maxLength":200,
                                    "description":"XPath"
                                },
                                "fieldValue":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Field Value"
                                }
                            }
                        }
                    },
                    "serviceResultsInfo":{
                        "type":"object",
                        "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
                        "properties":{
                            "resultsListXpath":{
                                "type":"string",
                                "maxLength":200,
                                "description":"XPath"
                            },
                            "codeElementName":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Element Name"
                            },
                            "descrElementName":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Element Name"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Dropdwns"
    }
}

Nested Schema : dropdowns

Type: array

Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
    "items":{
        "type":"object",
        "properties":{
            "dropdownType":{
                "type":"string",
                "enum":[
                    "BS  ",
                    "EXLK",
                    "LKUP",
                    "MO  ",
                    "SS  "
                ],
                "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
            },
            "lookup":{
                "type":"string",
                "maxLength":30,
                "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
            },
            "extLookup":{
                "type":"string",
                "maxLength":30,
                "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
            },
            "adminMo":{
                "type":"string",
                "maxLength":12,
                "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
            },
            "bs":{
                "type":"string",
                "maxLength":30,
                "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "ss":{
                "type":"string",
                "maxLength":12,
                "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "serviceInput":{
                "type":"array",
                "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
                "items":{
                    "type":"object",
                    "properties":{
                        "fieldXpath":{
                            "type":"string",
                            "maxLength":200,
                            "description":"XPath"
                        },
                        "fieldValue":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Field Value"
                        }
                    }
                }
            },
            "serviceResultsInfo":{
                "type":"object",
                "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
                "properties":{
                    "resultsListXpath":{
                        "type":"string",
                        "maxLength":200,
                        "description":"XPath"
                    },
                    "codeElementName":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Element Name"
                    },
                    "descrElementName":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Element Name"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adminMo: string
  Maximum Length: 12

  The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. Only entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported.
• bs: string
  Maximum Length: 30

  The name of a business service that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.
• dropdownType: string
  Allowed Values: [ "BS ", "EXLK", "LKUP", "MO ", "SS " ]

  To retrieve the code and description values for a lookup, provide the lookup's field name in the "lookup" element. To retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the "extendable lookup (extLookup)" element. To retrieve a set of code and description values using a service, use either the "business service (bs)" or "service script (ss)" options. To retrieve all code and description records in an administrative maintenance object, provide the name of the object in the "admin maintenance object (adminMo)" element. * `BS ` - Business Service, * `EXLK` - Extendable Lookup, * `LKUP` - Lookup, * `MO ` - Admin Maintenance Object, * `SS ` - Service Script
• extLookup: string
  Maximum Length: 30

  The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values.
• lookup: string
  Maximum Length: 30

  The field name of the lookup is the identifying object that groups together a set of lookup values.
• serviceInput: array serviceInput
  Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. For each parameter, provide its Xpath within the service schema in the "fieldXpath" element along with a corresponding value in the "fieldValue" element.
• serviceResultsInfo: object serviceResultsInfo
  By default, the API assumes that the service's schema includes a top-level list called "results" which contains "code" and "description" element names. If the service's list has a different name or Xpath use the "resultsListXpath" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the "codeElementName" and "descrElementName" respectively to provide the alternative names.
• ss: string
  Maximum Length: 12

  The name of a service script that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.

{
    "type":"object",
    "properties":{
        "dropdownType":{
            "type":"string",
            "enum":[
                "BS  ",
                "EXLK",
                "LKUP",
                "MO  ",
                "SS  "
            ],
            "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
        },
        "lookup":{
            "type":"string",
            "maxLength":30,
            "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
        },
        "extLookup":{
            "type":"string",
            "maxLength":30,
            "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
        },
        "adminMo":{
            "type":"string",
            "maxLength":12,
            "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
        },
        "bs":{
            "type":"string",
            "maxLength":30,
            "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "ss":{
            "type":"string",
            "maxLength":12,
            "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "serviceInput":{
            "type":"array",
            "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldXpath":{
                        "type":"string",
                        "maxLength":200,
                        "description":"XPath"
                    },
                    "fieldValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Field Value"
                    }
                }
            }
        },
        "serviceResultsInfo":{
            "type":"object",
            "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
            "properties":{
                "resultsListXpath":{
                    "type":"string",
                    "maxLength":200,
                    "description":"XPath"
                },
                "codeElementName":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Element Name"
                },
                "descrElementName":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Element Name"
                }
            }
        }
    }
}

Nested Schema : serviceInput

Type: array

Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. For each parameter, provide its Xpath within the service schema in the "fieldXpath" element along with a corresponding value in the "fieldValue" element.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
    "items":{
        "type":"object",
        "properties":{
            "fieldXpath":{
                "type":"string",
                "maxLength":200,
                "description":"XPath"
            },
            "fieldValue":{
                "type":"string",
                "maxLength":4,
                "description":"Field Value"
            }
        }
    }
}

Nested Schema : serviceResultsInfo

Type: object

By default, the API assumes that the service's schema includes a top-level list called "results" which contains "code" and "description" element names. If the service's list has a different name or Xpath use the "resultsListXpath" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the "codeElementName" and "descrElementName" respectively to provide the alternative names.

Show Source

• codeElementName: string
  Maximum Length: 30

  Element Name
• descrElementName: string
  Maximum Length: 30

  Element Name
• resultsListXpath: string
  Maximum Length: 200

  XPath

{
    "type":"object",
    "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
    "properties":{
        "resultsListXpath":{
            "type":"string",
            "maxLength":200,
            "description":"XPath"
        },
        "codeElementName":{
            "type":"string",
            "maxLength":30,
            "description":"Element Name"
        },
        "descrElementName":{
            "type":"string",
            "maxLength":30,
            "description":"Element Name"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldValue: string
  Maximum Length: 4

  Field Value
• fieldXpath: string
  Maximum Length: 200

  XPath

{
    "type":"object",
    "properties":{
        "fieldXpath":{
            "type":"string",
            "maxLength":200,
            "description":"XPath"
        },
        "fieldValue":{
            "type":"string",
            "maxLength":4,
            "description":"Field Value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dropdowns: array dropdowns
  Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

{
    "type":"object",
    "properties":{
        "dropdowns":{
            "type":"array",
            "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
            "items":{
                "type":"object",
                "properties":{
                    "dropdownType":{
                        "type":"string",
                        "enum":[
                            "BS  ",
                            "EXLK",
                            "LKUP",
                            "MO  ",
                            "SS  "
                        ],
                        "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
                    },
                    "lookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
                    },
                    "extLookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
                    },
                    "adminMo":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
                    },
                    "bs":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "ss":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "serviceInput":{
                        "type":"array",
                        "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
                        "items":{
                            "type":"object",
                            "properties":{
                                "fieldXpath":{
                                    "type":"string",
                                    "maxLength":200,
                                    "description":"XPath"
                                },
                                "fieldValue":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Field Value"
                                }
                            }
                        }
                    },
                    "serviceResultsInfo":{
                        "type":"object",
                        "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
                        "properties":{
                            "resultsListXpath":{
                                "type":"string",
                                "maxLength":200,
                                "description":"XPath"
                            },
                            "codeElementName":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Element Name"
                            },
                            "descrElementName":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Element Name"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Dropdwns"
    }
}

Nested Schema : dropdowns

Type: array

Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
    "items":{
        "type":"object",
        "properties":{
            "dropdownType":{
                "type":"string",
                "enum":[
                    "BS  ",
                    "EXLK",
                    "LKUP",
                    "MO  ",
                    "SS  "
                ],
                "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
            },
            "lookup":{
                "type":"string",
                "maxLength":30,
                "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
            },
            "extLookup":{
                "type":"string",
                "maxLength":30,
                "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
            },
            "adminMo":{
                "type":"string",
                "maxLength":12,
                "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
            },
            "bs":{
                "type":"string",
                "maxLength":30,
                "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "ss":{
                "type":"string",
                "maxLength":12,
                "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "serviceInput":{
                "type":"array",
                "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
                "items":{
                    "type":"object",
                    "properties":{
                        "fieldXpath":{
                            "type":"string",
                            "maxLength":200,
                            "description":"XPath"
                        },
                        "fieldValue":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Field Value"
                        }
                    }
                }
            },
            "serviceResultsInfo":{
                "type":"object",
                "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
                "properties":{
                    "resultsListXpath":{
                        "type":"string",
                        "maxLength":200,
                        "description":"XPath"
                    },
                    "codeElementName":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Element Name"
                    },
                    "descrElementName":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Element Name"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adminMo: string
  Maximum Length: 12

  The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. Only entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported.
• bs: string
  Maximum Length: 30

  The name of a business service that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.
• dropdownType: string
  Allowed Values: [ "BS ", "EXLK", "LKUP", "MO ", "SS " ]

  To retrieve the code and description values for a lookup, provide the lookup's field name in the "lookup" element. To retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the "extendable lookup (extLookup)" element. To retrieve a set of code and description values using a service, use either the "business service (bs)" or "service script (ss)" options. To retrieve all code and description records in an administrative maintenance object, provide the name of the object in the "admin maintenance object (adminMo)" element. * `BS ` - Business Service, * `EXLK` - Extendable Lookup, * `LKUP` - Lookup, * `MO ` - Admin Maintenance Object, * `SS ` - Service Script
• extLookup: string
  Maximum Length: 30

  The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values.
• lookup: string
  Maximum Length: 30

  The field name of the lookup is the identifying object that groups together a set of lookup values.
• serviceInput: array serviceInput
  Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. For each parameter, provide its Xpath within the service schema in the "fieldXpath" element along with a corresponding value in the "fieldValue" element.
• serviceResultsInfo: object serviceResultsInfo
  By default, the API assumes that the service's schema includes a top-level list called "results" which contains "code" and "description" element names. If the service's list has a different name or Xpath use the "resultsListXpath" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the "codeElementName" and "descrElementName" respectively to provide the alternative names.
• ss: string
  Maximum Length: 12

  The name of a service script that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.

{
    "type":"object",
    "properties":{
        "dropdownType":{
            "type":"string",
            "enum":[
                "BS  ",
                "EXLK",
                "LKUP",
                "MO  ",
                "SS  "
            ],
            "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
        },
        "lookup":{
            "type":"string",
            "maxLength":30,
            "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
        },
        "extLookup":{
            "type":"string",
            "maxLength":30,
            "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
        },
        "adminMo":{
            "type":"string",
            "maxLength":12,
            "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
        },
        "bs":{
            "type":"string",
            "maxLength":30,
            "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "ss":{
            "type":"string",
            "maxLength":12,
            "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "serviceInput":{
            "type":"array",
            "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldXpath":{
                        "type":"string",
                        "maxLength":200,
                        "description":"XPath"
                    },
                    "fieldValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Field Value"
                    }
                }
            }
        },
        "serviceResultsInfo":{
            "type":"object",
            "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
            "properties":{
                "resultsListXpath":{
                    "type":"string",
                    "maxLength":200,
                    "description":"XPath"
                },
                "codeElementName":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Element Name"
                },
                "descrElementName":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Element Name"
                }
            }
        }
    }
}

Nested Schema : serviceInput

Type: array

Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. For each parameter, provide its Xpath within the service schema in the "fieldXpath" element along with a corresponding value in the "fieldValue" element.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Lists input parameters to be provided to either a business service or a service script that builds a list of code and description values. \n\nFor each parameter, provide its Xpath within the service schema in the \"fieldXpath\" element along with a corresponding value in the \"fieldValue\" element.",
    "items":{
        "type":"object",
        "properties":{
            "fieldXpath":{
                "type":"string",
                "maxLength":200,
                "description":"XPath"
            },
            "fieldValue":{
                "type":"string",
                "maxLength":4,
                "description":"Field Value"
            }
        }
    }
}

Nested Schema : serviceResultsInfo

Type: object

By default, the API assumes that the service's schema includes a top-level list called "results" which contains "code" and "description" element names. If the service's list has a different name or Xpath use the "resultsListXpath" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the "codeElementName" and "descrElementName" respectively to provide the alternative names.

Show Source

• codeElementName: string
  Maximum Length: 30

  Element Name
• descrElementName: string
  Maximum Length: 30

  Element Name
• resultsListXpath: string
  Maximum Length: 200

  XPath

{
    "type":"object",
    "description":"By default, the API assumes that the service's schema includes a top-level list called \"results\" which contains \"code\" and \"description\" element names. \n\nIf the service's list has a different name or Xpath use the \"resultsListXpath\" element to provide the alternative reference. In the same way, if the code and description attributes have different names use the \"codeElementName\" and \"descrElementName\" respectively to provide the alternative names.",
    "properties":{
        "resultsListXpath":{
            "type":"string",
            "maxLength":200,
            "description":"XPath"
        },
        "codeElementName":{
            "type":"string",
            "maxLength":30,
            "description":"Element Name"
        },
        "descrElementName":{
            "type":"string",
            "maxLength":30,
            "description":"Element Name"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldValue: string
  Maximum Length: 4

  Field Value
• fieldXpath: string
  Maximum Length: 200

  XPath

{
    "type":"object",
    "properties":{
        "fieldXpath":{
            "type":"string",
            "maxLength":200,
            "description":"XPath"
        },
        "fieldValue":{
            "type":"string",
            "maxLength":4,
            "description":"Field Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : F1Dropdwns

Type: object

Show Source

• dropdowns: array dropdowns
  Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

{
    "type":"object",
    "properties":{
        "dropdowns":{
            "type":"array",
            "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
            "items":{
                "type":"object",
                "properties":{
                    "dropdownType":{
                        "type":"string",
                        "enum":[
                            "BS  ",
                            "EXLK",
                            "LKUP",
                            "MO  ",
                            "SS  "
                        ],
                        "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
                    },
                    "lookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
                    },
                    "extLookup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
                    },
                    "adminMo":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
                    },
                    "bs":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "ss":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
                    },
                    "values":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "code":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Value"
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Description"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Dropdwns"
    }
}

Nested Schema : dropdowns

Type: array

Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Lists one or more dropdown sets of code and description values. Each dropdown may be retrieved from a different source indicated by the dropdown type element.",
    "items":{
        "type":"object",
        "properties":{
            "dropdownType":{
                "type":"string",
                "enum":[
                    "BS  ",
                    "EXLK",
                    "LKUP",
                    "MO  ",
                    "SS  "
                ],
                "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
            },
            "lookup":{
                "type":"string",
                "maxLength":30,
                "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
            },
            "extLookup":{
                "type":"string",
                "maxLength":30,
                "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
            },
            "adminMo":{
                "type":"string",
                "maxLength":12,
                "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
            },
            "bs":{
                "type":"string",
                "maxLength":30,
                "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "ss":{
                "type":"string",
                "maxLength":12,
                "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
            },
            "values":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "code":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Value"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Description"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adminMo: string
  Maximum Length: 12

  The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. Only entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported.
• bs: string
  Maximum Length: 30

  The name of a business service that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.
• dropdownType: string
  Allowed Values: [ "BS ", "EXLK", "LKUP", "MO ", "SS " ]

  To retrieve the code and description values for a lookup, provide the lookup's field name in the "lookup" element. To retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the "extendable lookup (extLookup)" element. To retrieve a set of code and description values using a service, use either the "business service (bs)" or "service script (ss)" options. To retrieve all code and description records in an administrative maintenance object, provide the name of the object in the "admin maintenance object (adminMo)" element. * `BS ` - Business Service, * `EXLK` - Extendable Lookup, * `LKUP` - Lookup, * `MO ` - Admin Maintenance Object, * `SS ` - Service Script
• extLookup: string
  Maximum Length: 30

  The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values.
• lookup: string
  Maximum Length: 30

  The field name of the lookup is the identifying object that groups together a set of lookup values.
• ss: string
  Maximum Length: 12

  The name of a service script that retrieves a set of code and description values. The service may optionally receive input parameters. Refer to the "serviceInput" attribute for more information. By default, the API assumes a specific structure for the results list but supports alternative options. Refer to the "serviceResultsInfo" attribute for more information.
• values: array values

{
    "type":"object",
    "properties":{
        "dropdownType":{
            "type":"string",
            "enum":[
                "BS  ",
                "EXLK",
                "LKUP",
                "MO  ",
                "SS  "
            ],
            "description":"To retrieve the code and description values for a lookup, provide the lookup's field name in the \"lookup\" element. \n\nTo retrieve the code and description values for an extendable lookup, provide the extendable lookup's business object name in the \"extendable lookup (extLookup)\" element. \n\nTo retrieve a set of code and description values using a service, use either the \"business service (bs)\" or \"service script (ss)\" options. \n\nTo retrieve all code and description records in an administrative maintenance object, provide the name of the object in the \"admin maintenance object (adminMo)\" element.\n* `BS  ` - Business Service,\n* `EXLK` - Extendable Lookup,\n* `LKUP` - Lookup,\n* `MO  ` - Admin Maintenance Object,\n* `SS  ` - Service Script"
        },
        "lookup":{
            "type":"string",
            "maxLength":30,
            "description":"The field name of the lookup is the identifying object that groups together a set of lookup values."
        },
        "extLookup":{
            "type":"string",
            "maxLength":30,
            "description":"The business object (BO) of the extendable lookup is the identifying object that groups together a set of lookup values."
        },
        "adminMo":{
            "type":"string",
            "maxLength":12,
            "description":"The name of the maintenance object to use for building the dropdown. The set of values includes all records in the maintenance object. \n\nOnly entities classified as administrative (as opposed to master and transaction objects) that have a single field prime key are supported."
        },
        "bs":{
            "type":"string",
            "maxLength":30,
            "description":"The name of a business service that retrieves a set of code and description values.  \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "ss":{
            "type":"string",
            "maxLength":12,
            "description":"The name of a service script that retrieves a set of code and description values. \n\nThe service may optionally receive input parameters. Refer to the \"serviceInput\" attribute for more information. \n\nBy default, the API assumes a specific structure for the results list but supports alternative options. Refer to the \"serviceResultsInfo\" attribute for more information."
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Value"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "type":"string",
                "maxLength":254,
                "description":"Value"
            },
            "description":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
  Maximum Length: 254

  Value
• description: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "maxLength":254,
            "description":"Value"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"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