Jump to

• Request
• Response

Advanced query a taxonomy node translation

post

<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/taxonomyNodes/{taxonomyNodes_id}/$translations/{taxonomyNodes-_translations_id}/$query

Request

Path Parameters

• taxonomyNodes-_translations_id(required): string
• taxonomyNodes_id(required): 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 : taxonomyNodes-_translations_item-response

Match All

Show Source

• object oraCommonAppsInfraObjects.TaxonomyNodeTranslation_item
  The translation of the taxonomy node list of values resource.
• object __busObj_context

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

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNodeTranslation_item

Type: object

The translation of the taxonomy node list of values resource.

Show Source

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

  The unique identifier of the taxonomy node.
• taxonomyNode: taxonomyNode

{ "type":"object", "properties":{ "moduleId":{ "type":"string", "description":"The unique identifier of the taxonomy node.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$language":{ "type":"string", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "taxonomyNode":{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] } }, "description":"The translation of the taxonomy node list of values resource.", "x-primaryKey":[ "moduleId", "$language" ] }

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

Match All

Show Source

• object Taxonomy Node
  Title: Taxonomy Node

  The taxonomy node list of values resource is used to query the taxonomy nodes.
• object __busObj_context

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

Nested Schema : Taxonomy Node

Type: object

Title: Taxonomy Node

The taxonomy node list of values resource is used to query the taxonomy nodes.

Show Source

• $sourceLang: string
  Read Only: true
• alternativeId: integer (int32)
  Title: Alternative ID

  Read Only: true

  The alternative identifier of the taxonomy node.
• createdBy: string
  Title: Created By

  Read Only: true

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

  Read Only: true

  The translated description of the taxonomy node.
• moduleId: string
  Title: Module ID

  Read Only: true

  The unique identifier of the taxonomy node.
• moduleKey: string
  Title: Module Key

  Read Only: true

  The unique identifier of the module.
• moduleName: string
  Title: Module Name

  Read Only: true

  The descriptive name of the taxonomy node.
• moduleType: moduleType
• 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.
• userModuleName: string
  Title: User Module Name

  Read Only: true

  The translated visible name of the taxonomy node.

{ "type":"object", "properties":{ "moduleId":{ "title":"Module ID", "type":"string", "description":"The unique identifier of the taxonomy node.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "moduleName":{ "title":"Module Name", "type":"string", "description":"The descriptive name of the taxonomy node.", "readOnly":true }, "moduleType":{ "allOf":[ { "title":"Module Type", "type":"string", "description":"The type of the taxonomy node.", "x-searchable":true, "x-sortable":true, "readOnly":true }, { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.ModuleType_enum" } ] }, "moduleKey":{ "title":"Module Key", "type":"string", "description":"The unique identifier of the module.", "readOnly":true }, "alternativeId":{ "title":"Alternative ID", "type":"integer", "format":"int32", "description":"The alternative identifier of the taxonomy node.", "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 }, "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 }, "userModuleName":{ "title":"User Module Name", "type":"string", "description":"The translated visible name of the taxonomy node.", "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "description":{ "title":"Module Description", "type":"string", "description":"The translated description of the taxonomy node.", "readOnly":true } }, "title":"Taxonomy Node", "x-hints":{ "titlePlural":"Taxonomy Nodes" }, "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.", "x-primaryKey":[ "moduleId" ] }

Nested Schema : moduleType

Match All

The type of the taxonomy node.

Show Source

• string
  Title: Module Type

  Read Only: true

  The type of the taxonomy node.
• string
  Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]

{ "allOf":[ { "title":"Module Type", "type":"string", "description":"The type of the taxonomy node.", "x-searchable":true, "x-sortable":true, "readOnly":true }, { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.ModuleType_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" } } }

Links

$self

Parameters:

• taxonomyNodes-_translations_id: $request.path.taxonomyNodes-_translations_id
• taxonomyNodes_id: $request.path.taxonomyNodes_id

taxonomyNode

Parameters:

• taxonomyNodes_id: $response.body#/taxonomyNode/$id

Back to Top