Jump to

• Request
• Response

Get all lookup code translations using advanced query

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/standardLookupCodes/{standardLookupCodes_id}/$translations/$query

Request

Path Parameters

• standardLookupCodes_id(required): string
  This path parameter maps to a composite key that consists of the following fields defined in the Standard Lookup Codes REST resource:
  

  1. lookupType: The unique identifier of the Lookup Type.
  2. lookupCode: The unique identifier of the Lookup Code.

  To generate the path parameter value, first encode the field values, then concatenate them using a comma and encode the resulting string.

Supported Media Types

• application/json

Request Body - application/json ()

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

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : standardLookupCodes-_translations

Match All

Show Source

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

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

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

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

Nested Schema : standardLookupCodes-_translations-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: standardLookupCodes-_translations_item-response

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

Nested Schema : standardLookupCodes-_translations_item-response

Match All

Show Source

• allOf oraCommonAppsInfraObjects.LookupCodeTranslation_item
• object __busObj_context

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

Nested Schema : oraCommonAppsInfraObjects.LookupCodeTranslation_item

Match All

The lookup code translations list of values resource is used to query the list of lookup code translations.

Show Source

• object oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields
• object oraCommonAppsInfraObjects.LookupCodeTranslation_item-allOf[1]
  The lookup code translations list of values resource is used to query the list of lookup code translations.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields"
        },
        {
            "type":"object",
            "description":"The lookup code translations list of values resource is used to query the list of lookup code translations."
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields

Type: object

Show Source

• $language: string
  Read Only: true
• $sourceLang: string
  Read Only: true
• createdBy: string
  Read Only: true

  The user who created the record.
• description: string
  Read Only: true

  The translated description of the Lookup Code.
• lookupCategory: string (big-integer)
  Read Only: true

  The lookup category of the Lookup Code.
• lookupCode: string
  Read Only: true

  The unique identifier of the Lookup Code.
• lookupCodeTranslationBase: lookupCodeTranslationBase
• lookupType: string
  Read Only: true

  The unique identifier of the Lookup Type.
• meaning: string
  Read Only: true

  The translated meaning of the Lookup Code.
• timeCreated: string (date-time)
  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "description":"The unique identifier of the Lookup Type."
        },
        "lookupCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "description":"The unique identifier of the Lookup Code."
        },
        "lookupCategory":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "description":"The lookup category of the Lookup Code."
        },
        "$language":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "description":"The translated meaning of the Lookup Code."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "description":"The translated description of the Lookup Code."
        },
        "$sourceLang":{
            "type":"string",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The user who created the record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "description":"The date and time when the record was created."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The user who last updated the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "description":"The date and time when the record was last updated."
        },
        "lookupCodeTranslationBase":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCategory",
        "lookupCode",
        "$language"
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCodeTranslation_item-allOf[1]

Type: object

The lookup code translations list of values resource is used to query the list of lookup code translations.

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

Match All

Show Source

• allOf oraCommonAppsInfraObjects.LookupCode_item
• object __busObj_context

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

Nested Schema : oraCommonAppsInfraObjects.LookupCode_item

Match All

The lookup codes list of values resource is used to query the list of lookup codes.

Show Source

• allOf oraCommonAppsInfraObjects.LookupCode_item-fields
• object Lookup Code
  Title: Lookup Code

  The lookup codes list of values resource is used to query the list of lookup codes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields"
        },
        {
            "type":"object",
            "title":"Lookup Code",
            "x-hints":{
                "titlePlural":"Lookup Codes"
            },
            "description":"The lookup codes list of values resource is used to query the list of lookup codes."
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCode_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.LookupCode_abstract-item
• object oraCommonAppsInfraObjects.LookupCode_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "title":"Lookup Type ID",
                    "description":"The unique identifier of the Lookup Type.",
                    "type":"string"
                },
                "lookupCode":{
                    "title":"Lookup Code ID",
                    "description":"The unique identifier of the Lookup Code.",
                    "type":"string"
                },
                "meaning":{
                    "title":"Lookup Code Meaning",
                    "description":"The translated meaning of the Lookup Code.",
                    "type":"string"
                },
                "description":{
                    "title":"Lookup Code Description",
                    "description":"The translated description of the Lookup Code.",
                    "type":"string"
                },
                "enabledFlag":{
                    "title":"Lookup Code Enabled",
                    "description":"The enabled flag of the Lookup Code.",
                    "type":"boolean"
                },
                "startDateActive":{
                    "title":"Start Date Active",
                    "description":"The active start date of the Lookup Code.",
                    "type":"string"
                },
                "endDateActive":{
                    "title":"End Date Active",
                    "description":"The active end date of the Lookup Code.",
                    "type":"string"
                },
                "displaySequence":{
                    "title":"Display Sequence",
                    "description":"The display sequence of the Lookup Code.",
                    "type":"string"
                },
                "tag":{
                    "title":"Lookup Tag",
                    "description":"The tag value of the Lookup Code.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• displaySequence: string (big-integer)
  Read Only: true
• enabledFlag: boolean
  Read Only: true
• endDateActive: string (date)
  Read Only: true
• lookupCode: string
  Read Only: true
• lookupType: string
  Read Only: true
• meaning: string
  Read Only: true
• startDateActive: string (date)
  Read Only: true
• tag: string
  Read Only: true
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "enabledFlag":{
            "type":"boolean",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "startDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "endDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "displaySequence":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "tag":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCode"
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCode_item-fields-allOf[1]

Type: object

Show Source

• createdBy: string
  Title: Created By

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

  The translated description of the Lookup Code.
• displaySequence: string
  Title: Display Sequence

  The display sequence of the Lookup Code.
• enabledFlag: boolean
  Title: Lookup Code Enabled

  The enabled flag of the Lookup Code.
• endDateActive: string
  Title: End Date Active

  The active end date of the Lookup Code.
• lookupCode: string
  Title: Lookup Code ID

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

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

  The translated meaning of the Lookup Code.
• startDateActive: string
  Title: Start Date Active

  The active start date of the Lookup Code.
• tag: string
  Title: Lookup Tag

  The tag value of the Lookup Code.
• timeCreated: string
  Title: Created On

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

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

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "title":"Lookup Type ID",
            "description":"The unique identifier of the Lookup Type.",
            "type":"string"
        },
        "lookupCode":{
            "title":"Lookup Code ID",
            "description":"The unique identifier of the Lookup Code.",
            "type":"string"
        },
        "meaning":{
            "title":"Lookup Code Meaning",
            "description":"The translated meaning of the Lookup Code.",
            "type":"string"
        },
        "description":{
            "title":"Lookup Code Description",
            "description":"The translated description of the Lookup Code.",
            "type":"string"
        },
        "enabledFlag":{
            "title":"Lookup Code Enabled",
            "description":"The enabled flag of the Lookup Code.",
            "type":"boolean"
        },
        "startDateActive":{
            "title":"Start Date Active",
            "description":"The active start date of the Lookup Code.",
            "type":"string"
        },
        "endDateActive":{
            "title":"End Date Active",
            "description":"The active end date of the Lookup Code.",
            "type":"string"
        },
        "displaySequence":{
            "title":"Display Sequence",
            "description":"The display sequence of the Lookup Code.",
            "type":"string"
        },
        "tag":{
            "title":"Lookup Tag",
            "description":"The tag value of the Lookup Code.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        }
    }
}

Nested Schema : Lookup Code

Type: object

Title: Lookup Code

The lookup codes list of values resource is used to query the list of lookup codes.

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"
        }
    }
}

Back to Top