Jump to

• Request
• Response

Get all taxonomy nodes

get

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

Request

Query Parameters

• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• $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.

  Default Value: 25
• $offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.

  Default Value: 0
• $sortBy: string
  Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

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

• object Taxonomy Node
  Title: Taxonomy Node

  The taxonomy node list of values resource is used to query the taxonomy nodes.
• 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 : 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 : __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
  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"
        }
    }
}

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

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

Back to Top