Jump to

• Request
• Response

Get a lookup code translation

get

/api/boss/data/objects/ora/cxServiceCore/case/v1:1072/$en/cases/{cases_id}/contributingFactors/{cases-contributingFactors_id}/$translations/{cases-contributingFactors-_translations_id}

Request

Path Parameters

• cases-contributingFactors-_translations_id(required): string
  This path parameter maps to a composite key that consists of the following fields defined in the Cases/Contributing Factors/Translations REST resource:
  

  1. lookupType: The unique identifier of the Lookup Type.
  2. lookupCode: The unique identifier of the Lookup Code.
  3. $language: Indicates the code of the language identifier of the record.

  To generate the path parameter value, first encode the field values, then concatenate them using a comma and encode the resulting string.
• cases-contributingFactors_id(required): string
  This path parameter maps to a composite key that consists of the following fields defined in the Cases/Contributing Factors 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.
• cases_id(required): string
  This path parameter maps to the following field defined in the Cases REST resource:
  

  1. caseNumber: The unique number that's used to identify a case. You can edit the case number to a format that's best suitable to your requirements.

Query Parameters

• $effectiveDate: string(date)
  Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

There's no request body for this operation.

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : oraCommonAppsInfraObjects.LookupCodeTranslation_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

Contains the translated choice data in the supported languages.

Show Source

• object oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields
• object Lookup Code Translation
  Title: Lookup Code Translation

  Contains the translated choice data in the supported languages.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields"
        },
        {
            "type":"object",
            "title":"Lookup Code Translation",
            "x-hints":{
                "titlePlural":"Lookup Code Translations",
                "qualifiedTitle":"Lookup Code Translation",
                "qualifiedTitlePlural":"Lookup Code Translations"
            },
            "description":"Contains the translated choice data in the supported languages."
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupCodeTranslation_item-fields

Type: object

Show Source

• $language: string
  Title: Language

  Indicates the code of the language identifier of the record.
• $sourceLang: string
  Title: Source Language

  Read Only: true

  The language in which the values of the translatable columns were created, updated, or copied from.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• 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.
• lookupCodeTranslationBase: lookupCodeTranslationBase
• 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.
• 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":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Lookup Type ID",
            "description":"The unique identifier of the Lookup Type."
        },
        "lookupCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Lookup Code ID",
            "description":"The unique identifier of the Lookup Code."
        },
        "$language":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Language",
            "description":"Indicates the code of the language identifier of the record."
        },
        "meaning":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Lookup Code Meaning",
            "description":"The translated meaning of the Lookup Code."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Lookup Code Description",
            "description":"The translated description of the Lookup Code."
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "lookupCodeTranslationBase":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Lookup Code",
                    "description":"The lookup codes list of values resource is used to query the list of lookup codes.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCode",
        "$language"
    ]
}

Nested Schema : Lookup Code Translation

Type: object

Title: Lookup Code Translation

Contains the translated choice data in the supported languages.

Nested Schema : __busObj_context

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string",
            "x-searchable":true
        },
        "$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

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

Show Source

• allOf oraCommonAppsInfraObjects.LookupCode_item-fields
• object __busObj_context
• 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"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Lookup Code",
            "description":"The lookup codes list of values resource is used to query the list of lookup codes.",
            "x-searchable":true
        }
    ]
}

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"
                },
                "lookupCategoryId":{
                    "title":"Lookup Category",
                    "description":"The lookup category of the Lookup Code.",
                    "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"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "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
• lookupCategoryId: string (big-integer)
  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
        },
        "lookupCategoryId":{
            "type":"string",
            "format":"big-integer",
            "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",
            "x-searchable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCode"
    ]
}

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

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• 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.
• lookupCategoryId: string
  Title: Lookup Category

  The lookup category 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"
        },
        "lookupCategoryId":{
            "title":"Lookup Category",
            "description":"The lookup category of the Lookup Code.",
            "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"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "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"
        }
    }
}

Links

$self

Parameters:

• cases-contributingFactors-_translations_id: $request.path.cases-contributingFactors-_translations_id
• cases-contributingFactors_id: $request.path.cases-contributingFactors_id
• cases_id: $request.path.cases_id

Back to Top