Jump to

• Request
• Response

Get all enabled lookup codes using advanced query

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/commonLookupCodes/$views/lookupLOV/$query

Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_query"
        },
        {
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"object",
                    "description":"Values to be applied in a parameterized filter specific to the view."
                }
            }
        }
    ]
}

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "description":"Defines query criteria that can be applied on a resource collection.",
                    "properties":{
                        "filter":{
                            "type":"string",
                            "description":"The resource collection will be queried using the specified filter condition."
                        },
                        "limit":{
                            "type":"integer",
                            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                        },
                        "offset":{
                            "type":"integer",
                            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                        },
                        "sortBy":{
                            "type":"array",
                            "description":"Orders a resource collection based on the specified fields.",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string",
                                        "description":"Name of field based on which sorting will happen. Order is ascending."
                                    },
                                    {
                                        "type":"object",
                                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string",
                            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
  Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
• fields: array fields
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• subTypes: object subTypes
  Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• collection: object collection
  Defines query criteria that can be applied on a resource collection.

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "description":"Defines query criteria that can be applied on a resource collection.",
            "properties":{
                "filter":{
                    "type":"string",
                    "description":"The resource collection will be queried using the specified filter condition."
                },
                "limit":{
                    "type":"integer",
                    "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                },
                "offset":{
                    "type":"integer",
                    "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                },
                "sortBy":{
                    "type":"array",
                    "description":"Orders a resource collection based on the specified fields.",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string",
                                "description":"Name of field based on which sorting will happen. Order is ascending."
                            },
                            {
                                "type":"object",
                                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string",
                    "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                }
            },
            "additionalProperties":false
        }
    }
}

Nested Schema : type

Type: object

Show Source

• parameters: object parameters
  Values to be applied in a parameterized filter specific to the view.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "description":"Values to be applied in a parameterized filter specific to the view."
        }
    }
}

Nested Schema : accessors

Type: object

Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.

Nested Schema : fields

Type: array

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

Nested Schema : collection

Type: object

Defines query criteria that can be applied on a resource collection.

Show Source

• filter: string
  The resource collection will be queried using the specified filter condition.
• limit: integer
  Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
• offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
• privilege: string
  Represents the privilege or action required to check for while serving a request to access a resource.
• sortBy: array sortBy
  Orders a resource collection based on the specified fields.

{
    "type":"object",
    "description":"Defines query criteria that can be applied on a resource collection.",
    "properties":{
        "filter":{
            "type":"string",
            "description":"The resource collection will be queried using the specified filter condition."
        },
        "limit":{
            "type":"integer",
            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
        },
        "offset":{
            "type":"integer",
            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
        },
        "sortBy":{
            "type":"array",
            "description":"Orders a resource collection based on the specified fields.",
            "items":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"Name of field based on which sorting will happen. Order is ascending."
                    },
                    {
                        "type":"object",
                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                    }
                ]
            }
        },
        "privilege":{
            "type":"string",
            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
        }
    },
    "additionalProperties":false
}

Nested Schema : sortBy

Type: array

Orders a resource collection based on the specified fields.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Orders a resource collection based on the specified fields.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"Name of field based on which sorting will happen. Order is ascending."
            },
            {
                "type":"object",
                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• string
  Name of field based on which sorting will happen. Order is ascending.
• object type
  Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

{
    "oneOf":[
        {
            "type":"string",
            "description":"Name of field based on which sorting will happen. Order is ascending."
        },
        {
            "type":"object",
            "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
        }
    ]
}

Nested Schema : type

Type: object

Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

Nested Schema : parameters

Type: object

Values to be applied in a parameterized filter specific to the view.

Back to Top

Response

Default Response

Successful response of retrieving view lookupLOV for resource Common Lookup Codes

Body ()

Root Schema : commonLookupCodes_view-lookupLOV

Match All

Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value.

Show Source

• object __collection_context
• object commonLookupCodes_view-lookupLOV-allOf[1]
  Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/__busObj_context"
                            },
                            {
                                "type":"object",
                                "properties":{
                                    "lookupType":{
                                        "allOf":[
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                                            },
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                                            }
                                        ]
                                    },
                                    "lookupCode":{
                                        "allOf":[
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                                            },
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                                            }
                                        ]
                                    },
                                    "meaning":{
                                        "allOf":[
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
                                            },
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
                                            }
                                        ]
                                    },
                                    "description":{
                                        "allOf":[
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
                                            },
                                            {
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
                                            }
                                        ]
                                    }
                                }
                            }
                        ]
                    }
                }
            },
            "description":"Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value."
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : commonLookupCodes_view-lookupLOV-allOf[1]

Type: object

Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value.

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/__busObj_context"
                    },
                    {
                        "type":"object",
                        "properties":{
                            "lookupType":{
                                "allOf":[
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                                    },
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                                    }
                                ]
                            },
                            "lookupCode":{
                                "allOf":[
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                                    },
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                                    }
                                ]
                            },
                            "meaning":{
                                "allOf":[
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
                                    },
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
                                    }
                                ]
                            },
                            "description":{
                                "allOf":[
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
                                    },
                                    {
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    },
    "description":"Gets all of the enabled lookup codes for the given lookup type, filtering on the optional active date and always including the optional current value."
}

Nested Schema : items

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/__busObj_context"
            },
            {
                "type":"object",
                "properties":{
                    "lookupType":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                            },
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                            }
                        ]
                    },
                    "lookupCode":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                            },
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                            }
                        ]
                    },
                    "meaning":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
                            },
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
                            }
                        ]
                    },
                    "description":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
                            },
                            {
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object __busObj_context
• object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                        }
                    ]
                },
                "lookupCode":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                        }
                    ]
                },
                "meaning":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
                        }
                    ]
                },
                "description":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
                        },
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : items-allOf[1]

Type: object

Show Source

• description: description
• lookupCode: lookupCode
• lookupType: lookupType
• meaning: meaning

{
    "type":"object",
    "properties":{
        "lookupType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
                }
            ]
        },
        "lookupCode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
                }
            ]
        },
        "meaning":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
                }
            ]
        },
        "description":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
                }
            ]
        }
    }
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : description

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Code Description

  The translated description of the Lookup Code.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/description"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/description"
        }
    ]
}

Nested Schema : lookupCode

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Code ID

  The unique identifier of the Lookup Code.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupCode"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupCode"
        }
    ]
}

Nested Schema : lookupType

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Type ID

  The unique identifier of the Lookup Type.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/lookupType"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/lookupType"
        }
    ]
}

Nested Schema : meaning

Match All

Show Source

• string
  Read Only: true
• string
  Title: Lookup Code Meaning

  The translated meaning of the Lookup Code.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item/properties/meaning"
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields/allOf/1/properties/meaning"
        }
    ]
}

Back to Top