Jump to

• Request
• Response

Advanced query a lookup code translation

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/commonLookupCodes/{commonLookupCodes_id}/$translations/{commonLookupCodes-_translations_id}/$query

Request

Path Parameters

• commonLookupCodes-_translations_id(required): string
  This path parameter maps to a composite key that consists of the following fields defined in the Common Lookup Codes/Translations REST resource:
  

  1. lookupType: The unique identifier of the Lookup Type.
  2. lookupCategory: The lookup category of the Lookup Code.
  3. lookupCode: The unique identifier of the Lookup Code.
  4. $language

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

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

Type: object

Nested Schema : fields

Type: array

Show Source

• Array of: string

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

Nested Schema : subTypes

Type: object

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : commonLookupCodes-_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" } } }

Links

$self

Parameters:

• commonLookupCodes-_translations_id: $request.path.commonLookupCodes-_translations_id
• commonLookupCodes_id: $request.path.commonLookupCodes_id

Back to Top