Jump to

• Request
• Response

Get all taxonomy nodes using advanced query

post

<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/taxonomyNodes/$query

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_query"
        },
        {
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"object",
                    "description":"Values to be applied in a parameterized filter specific to the view."
                }
            }
        }
    ]
}

Nested 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 : type

Type: object

Show Source

• parameters: object parameters
  Values to be applied in a parameterized filter specific to the view.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "description":"Values to be applied in a parameterized filter specific to the view."
        }
    }
}

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.

Nested Schema : parameters

Type: object

Values to be applied in a parameterized filter specific to the view.

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : taxonomyNodes_view-default

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: taxonomyNodes_view-default_item-response

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

Nested Schema : taxonomyNodes_view-default_item-response

Match All

Show Source

• allOf taxonomyNodes_item-response
• object taxonomyNodes_view-default_item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/taxonomyNodes_item-response"
        },
        {
            "type":"object",
            "properties":{
                "moduleId":{
                },
                "moduleName":{
                },
                "userModuleName":{
                },
                "description":{
                },
                "moduleType":{
                },
                "moduleKey":{
                },
                "alternativeId":{
                }
            }
        }
    ]
}

Nested Schema : taxonomyNodes_item-response

Match All

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item
• object __busObj_context
• object taxonomyNodes_item-response-allOf[2]

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

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item

Match All

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

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item-fields
• object Taxonomy Node
  Title: Taxonomy Node

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
        },
        {
            "type":"object",
            "title":"Taxonomy Node",
            "x-hints":{
                "titlePlural":"Taxonomy Nodes"
            },
            "description":"The taxonomy node list of values resource is used to query the taxonomy nodes."
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
• object oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "moduleId":{
                    "title":"Module ID",
                    "description":"The unique identifier of the taxonomy node.",
                    "type":"string"
                },
                "moduleName":{
                    "title":"Module Name",
                    "description":"The descriptive name of the taxonomy node.",
                    "type":"string"
                },
                "moduleType":{
                    "title":"Module Type",
                    "description":"The type of the taxonomy node.",
                    "type":"string"
                },
                "moduleKey":{
                    "title":"Module Key",
                    "description":"The unique identifier of the module.",
                    "type":"string"
                },
                "alternativeId":{
                    "title":"Alternative ID",
                    "description":"The alternative identifier of the taxonomy node.",
                    "type":"integer"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "userModuleName":{
                    "title":"User Module Name",
                    "description":"The translated visible name of the taxonomy node.",
                    "type":"string"
                },
                "description":{
                    "title":"Module Description",
                    "description":"The translated description of the taxonomy node.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• alternativeId: integer (int32)
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• moduleId: string
  Read Only: true
• moduleKey: string
  Read Only: true
• moduleName: string
  Read Only: true
• moduleType: moduleType
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true
• userModuleName: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "moduleId":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "moduleName":{
            "type":"string",
            "readOnly":true
        },
        "moduleType":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.ModuleType_enum"
                }
            ]
        },
        "moduleKey":{
            "type":"string",
            "readOnly":true
        },
        "alternativeId":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "userModuleName":{
            "type":"string",
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "moduleId"
    ]
}

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

Type: object

Show Source

• alternativeId: integer
  Title: Alternative ID

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

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

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

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

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

  The descriptive name of the taxonomy node.
• moduleType: string
  Title: Module Type

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

  The translated visible name of the taxonomy node.

{
    "type":"object",
    "properties":{
        "moduleId":{
            "title":"Module ID",
            "description":"The unique identifier of the taxonomy node.",
            "type":"string"
        },
        "moduleName":{
            "title":"Module Name",
            "description":"The descriptive name of the taxonomy node.",
            "type":"string"
        },
        "moduleType":{
            "title":"Module Type",
            "description":"The type of the taxonomy node.",
            "type":"string"
        },
        "moduleKey":{
            "title":"Module Key",
            "description":"The unique identifier of the module.",
            "type":"string"
        },
        "alternativeId":{
            "title":"Alternative ID",
            "description":"The alternative identifier of the taxonomy node.",
            "type":"integer"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "userModuleName":{
            "title":"User Module Name",
            "description":"The translated visible name of the taxonomy node.",
            "type":"string"
        },
        "description":{
            "title":"Module Description",
            "description":"The translated description of the taxonomy node.",
            "type":"string"
        }
    }
}

Nested Schema : Taxonomy Node

Type: object

Title: Taxonomy Node

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

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

Type: object

Show Source

• $translations: taxonomyNodes-_translations

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

Nested Schema : taxonomyNodes_view-default_item-response-allOf[1]

Type: object

Show Source

• alternativeId:
• description:
• moduleId:
• moduleKey:
• moduleName:
• moduleType:
• userModuleName:

{
    "type":"object",
    "properties":{
        "moduleId":{
        },
        "moduleName":{
        },
        "userModuleName":{
        },
        "description":{
        },
        "moduleType":{
        },
        "moduleKey":{
        },
        "alternativeId":{
        }
    }
}

Nested Schema : moduleType

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]

{
    "allOf":[
        {
            "type":"string",
            "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"
        }
    }
}

Nested Schema : taxonomyNodes-_translations

Match All

Show Source

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

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

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

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

Nested Schema : taxonomyNodes-_translations-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: taxonomyNodes-_translations_item-response

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

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

Match All

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item
• object __busObj_context

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

Back to Top