Managing dynamic monitor type registration with REST APIs

https://<tenant-url>/managed-object-service/api/v1.0/entitytypes

https://<tenant-url>/managed-object-service/api/v1.0/entitytypes?type=dynamic

 https://HostA.bmc.com/managed-object-service/api/v1.0/entitytypes

Content-Type: application/json
Authorization: Bearer <JWT_token>

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

Parameter details

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

 https://<tenant-url>/managed-object-service/api/v1.0/entitytypes

 https://HostA.bmc.com/managed-object-service/api/v1.0/entitytypes

Content-Type: application/json
Authorization: Bearer <JWT_token>

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

Parameter details

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