Jump to

• Request
• Response

Advanced query all enabled lookup codes

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/setEnabledLookupCodes/$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"
                }
            }
        }
    ]
}

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "properties":{
                        "filter":{
                            "type":"string"
                        },
                        "limit":{
                            "type":"integer"
                        },
                        "offset":{
                            "type":"integer"
                        },
                        "sortBy":{
                            "type":"array",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string"
                                    },
                                    {
                                        "type":"object"
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string"
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
• fields: array fields
• subTypes: object subTypes

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object"
        },
        "accessors":{
            "type":"object"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• collection: object collection

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "properties":{
                "filter":{
                    "type":"string"
                },
                "limit":{
                    "type":"integer"
                },
                "offset":{
                    "type":"integer"
                },
                "sortBy":{
                    "type":"array",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"object"
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string"
                }
            },
            "additionalProperties":false
        }
    }
}

Nested Schema : type

Type: object

Show Source

• parameters: object parameters

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object"
        }
    }
}

Nested Schema : accessors

Type: object

Nested Schema : fields

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Nested Schema : collection

Type: object

Show Source

• filter: string
• limit: integer
• offset: integer
• privilege: string
• sortBy: array sortBy

{
    "type":"object",
    "properties":{
        "filter":{
            "type":"string"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "sortBy":{
            "type":"array",
            "items":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"object"
                    }
                ]
            }
        },
        "privilege":{
            "type":"string"
        }
    },
    "additionalProperties":false
}

Nested Schema : sortBy

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"object"
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• string
• object type

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : type

Type: object

Nested Schema : parameters

Type: object

Back to Top

Response

Default Response

Successful response of retrieving view lookupLOV for resource Set-Enabled Lookup Codes

Body ()

Root Schema : setEnabledLookupCodes_view-lookupLOV

Match All

Show Source

• object __collection_context
• object setEnabledLookupCodes_view-lookupLOV-allOf[1]
  Gets all of the set-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":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupType"
                                    },
                                    "setId":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/setId"
                                    },
                                    "lookupCode":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupCode"
                                    },
                                    "meaning":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/meaning"
                                    },
                                    "description":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/description"
                                    },
                                    "setIdSet":{
                                        "allOf":[
                                            {
                                                "$ref":"#/components/schemas/__busObj_context"
                                            },
                                            {
                                                "type":"object",
                                                "properties":{
                                                    "setId":{
                                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                                                    },
                                                    "setCode":{
                                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                                                    },
                                                    "setName":{
                                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                                                    }
                                                }
                                            }
                                        ]
                                    }
                                }
                            }
                        ]
                    }
                }
            },
            "description":"Gets all of the set-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 : setEnabledLookupCodes_view-lookupLOV-allOf[1]

Type: object

Gets all of the set-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":{
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupType"
                            },
                            "setId":{
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/setId"
                            },
                            "lookupCode":{
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupCode"
                            },
                            "meaning":{
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/meaning"
                            },
                            "description":{
                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/description"
                            },
                            "setIdSet":{
                                "allOf":[
                                    {
                                        "$ref":"#/components/schemas/__busObj_context"
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "setId":{
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                                            },
                                            "setCode":{
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                                            },
                                            "setName":{
                                                "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    },
    "description":"Gets all of the set-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":{
                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupType"
                    },
                    "setId":{
                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/setId"
                    },
                    "lookupCode":{
                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupCode"
                    },
                    "meaning":{
                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/meaning"
                    },
                    "description":{
                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/description"
                    },
                    "setIdSet":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/__busObj_context"
                            },
                            {
                                "type":"object",
                                "properties":{
                                    "setId":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                                    },
                                    "setCode":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                                    },
                                    "setName":{
                                        "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object __busObj_context
• object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupType"
                },
                "setId":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/setId"
                },
                "lookupCode":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupCode"
                },
                "meaning":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/meaning"
                },
                "description":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/description"
                },
                "setIdSet":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "properties":{
                                "setId":{
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                                },
                                "setCode":{
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                                },
                                "setName":{
                                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

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: string
  Title: Lookup Code Description

  Read Only: true

  The translated description of the Lookup Code.
• lookupCode: string
  Title: Lookup Code ID

  Read Only: true

  The unique identifier of the Lookup Code.
• lookupType: string
  Title: Lookup Type ID

  Read Only: true

  The unique identifier of the Lookup Type.
• meaning: string
  Title: Lookup Code Meaning

  Read Only: true

  The translated meaning of the Lookup Code.
• setId: string (big-integer)
  Title: Set ID

  Read Only: true

  The unique identifier of the set ID set.
• setIdSet: setIdSet

{
    "type":"object",
    "properties":{
        "lookupType":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupType"
        },
        "setId":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/setId"
        },
        "lookupCode":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/lookupCode"
        },
        "meaning":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/meaning"
        },
        "description":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetEnabledLookupCode_item-fields/properties/description"
        },
        "setIdSet":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "properties":{
                        "setId":{
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                        },
                        "setCode":{
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                        },
                        "setName":{
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                        }
                    }
                }
            ]
        }
    }
}

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 : setIdSet

Match All

Show Source

• object __busObj_context
• object setIdSet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "setId":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
                },
                "setCode":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
                },
                "setName":{
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
                }
            }
        }
    ]
}

Nested Schema : setIdSet-allOf[1]

Type: object

Show Source

• setCode: string
  Title: Set Code

  Read Only: true

  The unique code that identifies the set ID set.
• setId: string (big-integer)
  Title: Set ID

  Read Only: true

  The unique identifier of the set ID set.
• setName: string
  Title: Set Name

  Read Only: true

  The descriptive name of the Set ID Set.

{
    "type":"object",
    "properties":{
        "setId":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setId"
        },
        "setCode":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setCode"
        },
        "setName":{
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item-fields/properties/setName"
        }
    }
}

Back to Top