Jump to

• Request
• Response

Return list metadata

get

/api/v1/ui/applications

This API returns the metadata associated with the application list as per the configured list formats. Quick filters and column details are returned. The dataPath attribute in FieldInfo indicates the json path where the data is returned in the data API.

Request

Query Parameters

• contextId(optional): integer
  The field indicates the context ID for the application list.
• formatId(optional): integer
  The field indicates the list format ID for the application list.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The application list metadata as per the configuration.

Body ()

Root Schema : ListContextMetadata

Type: object

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object ListContextMetadata-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "contextId":{
                    "description":"The context identifier for the list.",
                    "type":"integer"
                },
                "listFormats":{
                    "description":"Details of list formats configured.",
                    "items":{
                        "$ref":"#/definitions/ListFormat"
                    },
                    "type":"array"
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstanceLink"
            }
        }
    }
}

Nested Schema : ListContextMetadata-allOf[1]

Type: object

Show Source

• contextId(optional): integer
  The context identifier for the list.
• listFormats(optional): array listFormats
  Details of list formats configured.

{
    "properties":{
        "contextId":{
            "description":"The context identifier for the list.",
            "type":"integer"
        },
        "listFormats":{
            "description":"Details of list formats configured.",
            "items":{
                "$ref":"#/definitions/ListFormat"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object InstanceLink
  Metadata describing link description objects that may appear in the json instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstanceLink"
    }
}

Nested Schema : InstanceLink

Type: object

Metadata describing link description objects that may appear in the json instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the template property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  Boolean flag indicating that the \href\ property is a URI or URI Template. If the property is a URI template, set this value to true. The default value is False.

{
    "type":"object",
    "description":"Metadata describing link description objects that may appear in the json instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the template property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag indicating that the \\href\\ property is a URI or URI Template. If the property is a URI template, set this value to true. The default value is False.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : listFormats

Type: array

Details of list formats configured.

Show Source

• [0]: ListFormat

{
    "description":"Details of list formats configured.",
    "items":{
        "$ref":"#/definitions/ListFormat"
    },
    "type":"array"
}

Nested Schema : ListFormat

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object ListFormat-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "type":"object",
            "properties":{
                "formatId":{
                    "description":"The list format identifier.",
                    "type":"integer"
                },
                "name":{
                    "description":"The list format name.",
                    "type":"string"
                },
                "listFormatColumnInfo":{
                    "description":"The set of column information in the list.",
                    "$ref":"#/definitions/ColumnInfo"
                },
                "quickFilterInfo":{
                    "items":{
                        "description":"Details of quick filters configured.",
                        "$ref":"#/definitions/FilterInformation"
                    },
                    "type":"array"
                },
                "advanceFilterInfo":{
                    "items":{
                        "description":"Details of available advanced filters.",
                        "$ref":"#/definitions/FilterInformation"
                    },
                    "type":"array"
                }
            }
        }
    ]
}

Nested Schema : ListFormat-allOf[1]

Type: object

Show Source

• advanceFilterInfo(optional): array advanceFilterInfo
• formatId(optional): integer
  The list format identifier.
• listFormatColumnInfo(optional): object ColumnInfo
• name(optional): string
  The list format name.
• quickFilterInfo(optional): array quickFilterInfo

{
    "type":"object",
    "properties":{
        "formatId":{
            "description":"The list format identifier.",
            "type":"integer"
        },
        "name":{
            "description":"The list format name.",
            "type":"string"
        },
        "listFormatColumnInfo":{
            "description":"The set of column information in the list.",
            "$ref":"#/definitions/ColumnInfo"
        },
        "quickFilterInfo":{
            "items":{
                "description":"Details of quick filters configured.",
                "$ref":"#/definitions/FilterInformation"
            },
            "type":"array"
        },
        "advanceFilterInfo":{
            "items":{
                "description":"Details of available advanced filters.",
                "$ref":"#/definitions/FilterInformation"
            },
            "type":"array"
        }
    }
}

Nested Schema : advanceFilterInfo

Type: array

Show Source

• [0]: object FilterInformation

{
    "items":{
        "description":"Details of available advanced filters.",
        "$ref":"#/definitions/FilterInformation"
    },
    "type":"array"
}

Nested Schema : ColumnInfo

Type: object

Show Source

• ascendingSort(optional): boolean
  The field indicates if the column is sorted in ascending order.
• columnName(optional): string
  The name of the column.
• columnNo(optional): integer
  The column number which uniquely represents the column.
• cricolumn(optional): boolean
  The field indicates if this is a cricolumn.
• dateColumn(optional): boolean
  The field indicates if this is a dateColumn.
• displayerNo(optional): integer
  The display number for the column.
• displaySequence(optional): integer
  The display sequence of a column.
• fieldsInfo(optional): object FieldInfo
• mostAdvancedProgressionStatusColumn(optional): boolean
  The field indicates if the column is a mostAdvancedProgressionStatusColumn.
• nextExpectedActionColumn(optional): boolean
  The field indicates if the column is a next expected action.
• shortColumnName(optional): string
  The short name for the column.
• sortable(optional): boolean
  The field indicates if the column is a sortable column.
• sortingSequence(optional): integer
  The sorting sequence for the column.
• type(optional): integer
  The column type.

{
    "properties":{
        "ascendingSort":{
            "description":"The field indicates if the column is sorted in ascending order.",
            "type":"boolean"
        },
        "columnName":{
            "description":"The name of the column.",
            "type":"string"
        },
        "columnNo":{
            "description":"The column number which uniquely represents the column.",
            "type":"integer"
        },
        "cricolumn":{
            "description":"The field indicates if this is a cricolumn.",
            "type":"boolean"
        },
        "dateColumn":{
            "description":" The field indicates if this is a dateColumn.",
            "type":"boolean"
        },
        "fieldsInfo":{
            "description":"The details of fields in the column.",
            "$ref":"#/definitions/FieldInfo"
        },
        "displaySequence":{
            "description":"The display sequence of a column.",
            "type":"integer"
        },
        "displayerNo":{
            "description":"The display number for the column.",
            "type":"integer"
        },
        "mostAdvancedProgressionStatusColumn":{
            "description":" The field indicates if the column is a mostAdvancedProgressionStatusColumn.",
            "type":"boolean"
        },
        "nextExpectedActionColumn":{
            "description":" The field indicates if the column is a next expected action.",
            "type":"boolean"
        },
        "shortColumnName":{
            "description":"The short name for the column.",
            "type":"string"
        },
        "sortable":{
            "description":" The field indicates if the column is a sortable column.",
            "type":"boolean"
        },
        "sortingSequence":{
            "description":"The sorting sequence for the column.",
            "type":"integer"
        },
        "type":{
            "description":"The column type.",
            "type":"integer"
        }
    }
}

Nested Schema : quickFilterInfo

Type: array

Show Source

• [0]: object FilterInformation

{
    "items":{
        "description":"Details of quick filters configured.",
        "$ref":"#/definitions/FilterInformation"
    },
    "type":"array"
}

Nested Schema : FilterInformation

Type: object

Show Source

• advancedFilter(optional): boolean
  The field indicates if the filter is an advanced filter.
• defaultEntityValueKey(optional): integer
  The default entity value key.
• defaultValues(optional): array defaultValues
• fieldAlias(optional): string
  The alias name of the field on which the filter applies.
• fieldNo(optional): integer
  The field number on which the filter applies.
• fieldPath(optional): string
  The field path on which the filter applies.
• fieldType(optional): string
  The type of field on which the filter applies.
• filterName(optional): string
  The name of the filter.
• filterNo(optional): integer
  The filter number which uniquely identifies the filter.
• filterOperators(optional): array filterOperators
• filterPath(optional): string
  The filter path.
• filterType(optional): integer
  The filter type.
• measurementUnit(optional): string
  The measurement unit for the filter.
• possibleValues(optional): array possibleValues
• sectionName(optional): string
  The section name.
• sectionNo(optional): integer
  The section number.
• selectedByDefault(optional): boolean
  An explanation about the purpose of the instance.
• values(optional): array values

{
    "properties":{
        "advancedFilter":{
            "description":" The field indicates if the filter is an advanced filter.",
            "type":"boolean"
        },
        "defaultEntityValueKey":{
            "description":"The default entity value key.",
            "type":"integer"
        },
        "defaultValues":{
            "items":{
                "description":"The default values to be applied for the filter.",
                "type":"integer"
            },
            "type":"array"
        },
        "fieldAlias":{
            "description":"The alias name of the field on which the filter applies.",
            "type":"string"
        },
        "fieldNo":{
            "description":"The field number on which the filter applies.",
            "type":"integer"
        },
        "fieldPath":{
            "description":"The field path on which the filter applies.",
            "type":"string"
        },
        "fieldType":{
            "description":"The type of field on which the filter applies.",
            "type":"string"
        },
        "filterName":{
            "description":"The name of the filter.",
            "type":"string"
        },
        "filterNo":{
            "description":"The filter number which uniquely identifies the filter.",
            "type":"integer"
        },
        "filterOperators":{
            "items":{
                "description":"The operators used for the filter.",
                "type":"integer"
            },
            "type":"array"
        },
        "filterPath":{
            "description":"The filter path.",
            "type":"string"
        },
        "filterType":{
            "description":"The filter type.",
            "type":"integer"
        },
        "measurementUnit":{
            "description":"The measurement unit for the filter.",
            "type":"string"
        },
        "possibleValues":{
            "items":{
                "description":"A list of possible values for the filter.",
                "type":"string"
            },
            "type":"array"
        },
        "values":{
            "items":{
                "description":"A list of selected values for the filter.",
                "type":"string"
            },
            "type":"array"
        },
        "sectionName":{
            "description":"The section name.",
            "type":"string"
        },
        "sectionNo":{
            "description":"The section number.",
            "type":"integer"
        },
        "selectedByDefault":{
            "description":"An explanation about the purpose of the instance.",
            "type":"boolean"
        }
    }
}

Nested Schema : defaultValues

Type: array

Show Source

• [0]: integer
  The default values to be applied for the filter.

{
    "items":{
        "description":"The default values to be applied for the filter.",
        "type":"integer"
    },
    "type":"array"
}

Nested Schema : filterOperators

Type: array

Show Source

• [0]: integer
  The operators used for the filter.

{
    "items":{
        "description":"The operators used for the filter.",
        "type":"integer"
    },
    "type":"array"
}

Nested Schema : possibleValues

Type: array

Show Source

• [0]: string
  A list of possible values for the filter.

{
    "items":{
        "description":"A list of possible values for the filter.",
        "type":"string"
    },
    "type":"array"
}

Nested Schema : values

Type: array

Show Source

• [0]: string
  A list of selected values for the filter.

{
    "items":{
        "description":"A list of selected values for the filter.",
        "type":"string"
    },
    "type":"array"
}

Nested Schema : FieldInfo

Type: object

Show Source

• alias(optional): string
  An alias of a field.
• dataPath(optional): string
  The json path in which the field data will appear in the data response.
• displayerNo(optional): integer
  The display number configured for the field.
• displaySequence(optional): integer
  The display sequence of the field.
• fieldName(optional): string
  The name of the field.
• fieldNo(optional): integer
  The field number which uniquely identifies the field.
• fieldType(optional): string
  The type of the field.
• sortingSequence(optional): integer
  The sorting sequence of the field.

{
    "type":"object",
    "properties":{
        "alias":{
            "description":"An alias of a field.",
            "type":"string"
        },
        "displaySequence":{
            "description":"The display sequence of the field.",
            "type":"integer"
        },
        "displayerNo":{
            "description":"The display number configured for the field.",
            "type":"integer"
        },
        "dataPath":{
            "description":"The json path in which the field data will appear in the data response.",
            "type":"string"
        },
        "fieldName":{
            "description":"The name of the field.",
            "type":"string"
        },
        "fieldNo":{
            "description":"The field number which uniquely identifies the field.",
            "type":"integer"
        },
        "fieldType":{
            "description":"The type of the field.",
            "type":"string"
        },
        "sortingSequence":{
            "description":"The sorting sequence of the field.",
            "type":"integer"
        }
    }
}

400 Response

The specified context ID or format ID is invalid.

Body ()

Root Schema : Represents an error response.

Type: object

Title: Represents an error response.

Represents an error response.

Show Source

• additionalProperties(optional): object additionalProperties
  Any additional properties apart from code, message or description.
• errors(optional): array errors

{
    "title":"Represents an error response.",
    "description":"Represents an error response.",
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "additionalProperties":{
            "description":"Any additional properties apart from code, message or description.",
            "type":"object"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Any additional properties apart from code, message or description.

Nested Schema : errors

Type: array

Show Source

• [0]: object Represents a generic error.
  Title: Represents a generic error.

  Represents a generic error.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : Represents a generic error.

Type: object

Title: Represents a generic error.

Represents a generic error.

Show Source

• code(optional): integer
  Represents the error code.
• description(optional): string
  The error description text.
• message(optional): string
  The actual error message.

{
    "title":"Represents a generic error.",
    "description":"Represents a generic error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"Represents the error code."
        },
        "message":{
            "type":"string",
            "description":"The actual error message."
        },
        "description":{
            "type":"string",
            "description":"The error description text."
        }
    }
}

Default Response

Unexpected error.

Back to Top