This documentation supports an earlier version of BMC Helix Operations Management.

To view the documentation for the latest version, select 23.2 from the Product version picker.

Dynamic monitor type registration management endpoints in the REST API

The following section provides a list of supported endpoints and an overview about running these endpoints. Before you run an endpoint, you must authenticate yourself. For more information, see  Access and authentication for the REST API Open link


GET /entitytypes
Request URL
https://<tenant-url>/managed-object-service/api/v1.0/entitytypes
Request URL with optional parameters
https://<tenant-url>/managed-object-service/api/v1.0/entitytypes?type=dynamic
Example request URL
 https://HostA.bmc.com/managed-object-service/api/v1.0/entitytypes
Request Header
Content-Type: application/json
Authorization: Bearer <JWT_token>

For instructions on obtaining the JWT token, see Access and authentication for the REST API. Open link .

Parameter details


NameValue TypeLocated InMandatoryDescription

entitytypes

StringPathYes

List of the dynamic entity types.

Successful responses

{
    "entityTypeUniqueNames": ["entity_type1", "entity_type2", "entity_type3", "entity_type4"]
}

Unsuccessful response

Scenario 1: No dynamic monitors are configured on the tenant

{
  "errorCode": 400 - NOT FOUND,
  "message": "No dynamic monitor types are configured on this tenant."
}

Scenario 2: User does not have administrator privileges

{
  "errorCode": 403 - FORBIDDEN,
  "message": "You must have administrator privileges to run this API."
}

Back to top

PUT /entitytypes
Request URL
 https://<tenant-url>/managed-object-service/api/v1.0/entitytypes
Example request URL
 https://HostA.bmc.com/managed-object-service/api/v1.0/entitytypes
Request Header
Content-Type: application/json
Authorization: Bearer <JWT_token>

For instructions on obtaining the JWT token, see Access and authentication for the REST API. Open link .

Parameter details


NameValue TypeLocated InMandatoryDescription

entitytypes

StringbodyYes

List of the dynamic entity types.

operationTypeStringbodyNoOperation to register the monitor types and enable them for metric selection while configuring alarm policies.

Request body

{
"entityTypes": [String, String, String],
"operationtype": String
}

Example request body

{
"entityTypes": ["entity_type1", "entity_type2", "entity_type3", "entity_type4"],
"operationtype":"register"
}


Successful response

{
    "status": "OK",
    "message": "Successfully updated",
    "registrationSuccess": [
        "entity_type1", "entity_type2", "entity_type3", "entity_type4"
    ],
    "registrationFailed": []
}

Unsuccessful responses

Scenario 1: The request body was blank

{
  "errorCode": 400 - BAD REQUEST,
  "message": "You must provide values for entityTypes to run this API."
}

Scenario 2: User does not have administrator privileges

{
  "errorCode": 403 - FORBIDDEN,
  "message": "You must have administrator privileges to run this API."
}

Scenario 3: The request body contained valid and invalid entity types

Error code: 206 - PARTIAL_CONTENT

{
    "status": "PARTIAL_CONTENT",
    "message": "One or more entity types were not updated because they were invalid or there was an internal error. For more information, see the managed-object-service logs.",
    "registrationSuccess": [
        "valideEntityType1"
    ],
    "registrationFailed": [
        "invalidEntityType1"
    ]
}

Scenario 4: The request body contained invalid entity types

Error code: 417 - EXPECTATION_FAILED

{
    "status": "EXPECTATION_FAILED",
    "message": "The entity types were not updated because they were invalid or there was an internal error. For more information, see the managed-object-service logs.",
    "registrationSuccess": [],
    "registrationFailed": [
        "invalidEntityType1", "invalidEntityType2"
    ]
}

Back to top

Was this page helpful? Yes No Submitting... Thank you

Comments