Get Realized Entity
Get realized entity uniquely identified by realized path, specified by query parameter
Request
URLURL
Query Parameters
Query Parameters
Response
Response BodyResponse Body
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"alarms": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"error_details": {
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
},
"id": "string",
"message": "string",
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"source_reference": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"description": "string",
"display_name": "string",
"entity_type": "string",
"extended_attributes": [
{
"data_type": "string",
"key": "string",
"multivalue": false,
"values": [
"string"
]
}
],
"id": "string",
"intent_paths": [
"string"
],
"intent_reference": [
"string"
],
"parent_path": "string",
"path": "string",
"realization_api": "string",
"realization_specific_identifier": "string",
"relative_path": "string",
"resource_type": "string",
"runtime_error": "string",
"runtime_status": "string",
"state": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
Timestamp of resource creation
ID of the user who created this resource
Timestamp of last modification
ID of the user who last modified this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
Schema for this resource
Indicates system owned resource
Description of this resource
Defaults to ID if not set
Type of realized entity
Unique identifier of this resource
Collection of intent paths
Desire state paths of this object
Path of its parent
Absolute path of this object
Realization API of this object on enforcement point
Realization id of this object
Path relative from its parent
The type of this resource.
It define the root cause for runtime error.
Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
Realization state of this object
Possible values are: UNAVAILABLE, UNREALIZED, REALIZED, ERROR