CoreService

<back to all web services

GetConfigItemHierarchy

Common - Requests

Return the object hierarchy of a configitem

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
GET/api/configitems/{Id}/hierarchyReturns a list with ids of all parent items
GET/configitems/{Id}/hierarchyReturns a list with ids of all parent items
GetConfigItemHierarchy Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYes
ConfigItemTypequeryObjectTypes?Yesobjecttype of searched configitem

Allowable Values

  • None
  • ConfigItem
  • Tenant
  • Collection
  • Resource
  • ComputeNode
  • VirtualMachine
  • PhysicalMachine
  • Disk
  • Subnet
  • IPAddress
  • Job
  • JobEvent
  • FreezePeriod
  • ResourceGroup
  • Deployment
  • ResourceGroupTemplate
  • DeploymentTemplate
  • ResourceProvider
  • GenericResource
  • Role
  • Permission
  • User
  • PatchingWindow
  • Update
  • ReportDefinition
  • TimeSeries
  • DataPoint
  • Action
  • ActionAssignment
  • UserNote
TenantNameheaderstringYes
TxIdquerystringNo
ObjectTypes Enum:
None
ConfigItem
Tenant
Collection
Resource
ComputeNode
VirtualMachine
PhysicalMachine
Disk
Subnet
IPAddress
Job
JobEvent
FreezePeriod
ResourceGroup
Deployment
ResourceGroupTemplate
DeploymentTemplate
ResourceProvider
GenericResource
Role
Permission
User
PatchingWindow
Update
ReportDefinition
TimeSeries
DataPoint
Action
ActionAssignment
UserNote
ItemsResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ItemsformIList<VariableDto>Yes
OffsetformintNo
TotalformintNo
IsGroupedformboolNo
ResponseStatusformResponseStatusNo
MetaformDictionary<string, string>No
VariableDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringYesValue in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
TypeformValueDataTypeNoThe data type of the value property
DescriptionformstringNo
IsInheritedformboolNo
EnvironmentformEnvironments?No
ValueDataType Enum:
String
Number
Boolean
List
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/configitems/{Id}/hierarchy HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}