Jump to

• Request
• Response
• Examples

Get company hierarchy tree

get

/api/v4/search/companies/hierarchy/{id}

This accepts a company ID and returns a tree representation of the company's hierarchy. Each company in the tree is represented as a node.

Versions Supported:

v4

Request

Path Parameters

• id: string
  Id of the company record whose hierarchy needs to be retrieved.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• attributes(optional): object attributes
  Additional Properties Allowed: additionalProperties
• nodes(optional): array nodes

{
    "properties":{
        "attributes":{
            "additionalProperties":{
                "type":"string"
            },
            "additionalPropertiesSchema":{
                "type":"string"
            },
            "type":"object"
        },
        "nodes":{
            "items":{
                "$ref":"#/components/schemas/HierarchyNode"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "additionalPropertiesSchema":{
        "type":"string"
    },
    "type":"object"
}

Nested Schema : nodes

Type: array

Show Source

• Array of: object HierarchyNode
  Cyclic reference to oracle.daas.api.alldata.HierarchyNode

{
    "items":{
        "$ref":"#/components/schemas/HierarchyNode"
    },
    "type":"array"
}

Nested Schema : HierarchyNode

Type: object

Cyclic reference to oracle.daas.api.alldata.HierarchyNode

404 Response

Requested resource could not be found.

Body ()

Root Schema : schema

Type: object

500 Response

An unexpected error occurred during the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

Example Request:

/api/v4/search/companies/hierarchy/123456

Full List of Company Attributes: Company Attributes

Example Response:

 {"nodes":[
 	{"attributes":
 		{"info_organization_name":"Some Company Inc.",
 		"id":"AAXXYYDD",
 		"company_hier_indicator":"C",
 		"company_hier_aggr_ees_total":"0",
 		"company_hier_aggr_sales_volume":"0"}}, ...(MORE)}

Back to Top