Jump to

• Request
• Response

Get a language using advanced query

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/languages/{languages_id}/$query

Request

Path Parameters

• languages_id(required): string

Supported Media Types

• application/json

Request Body - application/json ()

Root 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 : 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.

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : languages_item-response

Match All

Show Source

• object Language
  Title: Language

  The languages list of values resource is used to query the list of languages.
• object __busObj_context
• object languages_item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Language_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "$translations":{
                    "$ref":"#/components/schemas/languages-_translations"
                }
            }
        }
    ]
}

Nested Schema : Language

Type: object

Title: Language

The languages list of values resource is used to query the list of languages.

Show Source

• $language: string
  Read Only: true
• $sourceLang: string
  Read Only: true
• activationStatus: activationStatus
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Language Description

  Read Only: true

  The description of the language.
• installed: installed
• languageCode: string
  Title: Language Code

  Read Only: true

  The unique code of the language.
• languageTag: string
  Title: Language Tag

  Read Only: true

  A unique tag to identify the language.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "installed":{
            "allOf":[
                {
                    "title":"Language Installed",
                    "type":"string",
                    "description":"Indicates if the language is installed.",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LanguageInstalled_enum"
                }
            ]
        },
        "activationStatus":{
            "allOf":[
                {
                    "title":"Language Activation Status",
                    "type":"string",
                    "description":"The activation status of the language.",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LanguageActivationStatus_enum"
                }
            ]
        },
        "languageCode":{
            "title":"Language Code",
            "type":"string",
            "description":"The unique code of the language.",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "languageTag":{
            "title":"Language Tag",
            "type":"string",
            "description":"A unique tag to identify the language.",
            "readOnly":true
        },
        "timeCreated":{
            "title":"Created On",
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the record was created.",
            "readOnly":true
        },
        "createdBy":{
            "title":"Created By",
            "type":"string",
            "description":"The user who created the record.",
            "readOnly":true
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the record was last updated.",
            "readOnly":true
        },
        "updatedBy":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the record.",
            "readOnly":true
        },
        "$language":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "title":"Language Description",
            "type":"string",
            "description":"The description of the language.",
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "readOnly":true
        }
    },
    "title":"Language",
    "x-hints":{
        "titlePlural":"Languages"
    },
    "description":"The languages list of values resource is used to query the list of languages.",
    "x-primaryKey":[
        "languageCode"
    ]
}

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 : languages_item-response-allOf[2]

Type: object

Show Source

• $translations: languages-_translations

{
    "type":"object",
    "properties":{
        "$translations":{
            "$ref":"#/components/schemas/languages-_translations"
        }
    }
}

Nested Schema : activationStatus

Match All

The activation status of the language.

Show Source

• string
  Title: Language Activation Status

  Read Only: true

  The activation status of the language.
• string
  Allowed Values: [ "ACTIVE", "NONE", "PENDING" ]

{
    "allOf":[
        {
            "title":"Language Activation Status",
            "type":"string",
            "description":"The activation status of the language.",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LanguageActivationStatus_enum"
        }
    ]
}

Nested Schema : installed

Match All

Indicates if the language is installed.

Show Source

• string
  Title: Language Installed

  Read Only: true

  Indicates if the language is installed.
• string
  Allowed Values: [ "I", "B", "D" ]

{
    "allOf":[
        {
            "title":"Language Installed",
            "type":"string",
            "description":"Indicates if the language is installed.",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LanguageInstalled_enum"
        }
    ]
}

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 : languages-_translations

Match All

Show Source

• object __collection_context
• object languages-_translations-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/languages-_translations_item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

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

Nested Schema : languages-_translations-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/languages-_translations_item-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: languages-_translations_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/languages-_translations_item-response"
    }
}

Nested Schema : languages-_translations_item-response

Match All

Show Source

• object oraCommonAppsInfraObjects.LanguageTranslation_item
  The translation of the language list of values resource.
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LanguageTranslation_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LanguageTranslation_item

Type: object

The translation of the language list of values resource.

Show Source

• $language: string
  Read Only: true
• languageCode: string
  Read Only: true

  The unique code of the language.

{
    "type":"object",
    "properties":{
        "languageCode":{
            "type":"string",
            "description":"The unique code of the language.",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "$language":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        }
    },
    "description":"The translation of the language list of values resource.",
    "x-primaryKey":[
        "languageCode",
        "$language"
    ]
}

Links

$self

Parameters:

• languages_id: $request.path.languages_id

Back to Top