Component Groups
Get Component Group
API Documentation
Components
Component Groups
Incident Updates
Incident Templates
MetricPoint
Component Groups
Get Component Group
GET
/
component-groups
/
{componentGroup}
curl --request GET \
--url http://localhost/api/component-groups/{componentGroup}
{
"data": {
"id": "<string>",
"type": "componentGroups",
"attributes": {
"id": "<string>",
"name": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{
"id": "<string>",
"type": "components",
"attributes": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": "<string>",
"meta": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": "<string>",
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": "<string>",
"visible": "<string>",
"stickied": "<string>",
"notifications": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"occurred": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {
"id": "<string>"
}
}
}
}
}
]
}
}
}
]
}
}
}
}
Path Parameters
The component group ID
Query Parameters
Available includes are components
, componentsCount
, componentsExists
. You can include multiple options by separating them with a comma.
Response
200
application/json
`ComponentGroup`
Available options:
componentGroups
curl --request GET \
--url http://localhost/api/component-groups/{componentGroup}
{
"data": {
"id": "<string>",
"type": "componentGroups",
"attributes": {
"id": "<string>",
"name": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{
"id": "<string>",
"type": "components",
"attributes": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": "<string>",
"meta": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": "<string>",
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": "<string>",
"visible": "<string>",
"stickied": "<string>",
"notifications": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"occurred": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {
"id": "<string>"
}
}
}
}
}
]
}
}
}
]
}
}
}
}