Examples of using the REST API to manage events

You can use the REST API to manage events for the following integrations with TrueSight Infrastructure Management:

Remedy Change Management
TrueSight Capacity Optimization

Integration of Remedy Change Management with TrueSight Infrastructure Management

Remedy Change Management communicates change requests (both change and task requests) to TrueSight Infrastructure Management through the REST API. Using the REST API, you can create or modify events. TrueSight Infrastructure Management receives these events as notification of change requests.

Example URL to create an event for Remedy Change Management integration

An example URL to create an event for Remedy Change Management integration is as follows:

http://bppmwsserver:80/bppmws/api/CI/bppmwsserver.calbro.com/event?idtype=Name

Example input parameters in the JSON format to create an event for Remedy Change Management integration

Input parameters in the JSON format to create an event lists the input parameters that you can provide to create an event. The list of attributes varies as per the application type you select. The following table lists the attributes that are specific to integration of Remedy Change Management with TrueSight Infrastructure Management.

List of attributes for the REST API to create an event for Remedy Change Management integration with TrueSight Infrastructure Management

Attributes	Description
Change event
changeCategory	Type of change request. The supported categories are as follows: Emergency Expedited Latent Normal No Impact
CIAssociationDateEpoch	Date and time at which the CI is associated with the change request. The value must be in the epoch format.
changeID	Unique identifier for the change request
changeLocationServer	Location of the server on which Remedy Change Management application is installed
changeModifiedDateEpoch	Date and time at which the change request was last modified. The value must be in the epoch format.
changeOwner	Owner of the change request
changeCoordinator	Coordinator of the change request
changeCustomerName	Name of the customer for the change request
changeSummary	A brief summary about the change request
scheduledStartDateEpoch	Date and time for the scheduled change request to start. The value must be in the epoch format.
scheduledEndDateEpoch	Date and time for the scheduled change request to end. The value must be in the epoch format.
actualStartDateEpoch	Actual date and time at which the change request started. The value must be in the epoch format.
actualEndDateEpoch	Actual date and time at which the change request ended. The value must be in the epoch format.
completionDateEpoch	Date and time at which the change request is completed. The value must be in the epoch format.
changeNotes	Notes added to the change request
changeReason	Reasons for the change request
changeStatus	Status of the change request. The supported statuses are as follows: Scheduled Implementation In Progress Pending Cancelled Completed Closed
CIReconcilationID	Unique identifier for CI reconciliation
CIName	Alias name of the CI
CIClass	Class to which the CI belongs
changeStatusReason	Reason for the change request's status
CIDataSetID	Unique identifier for the CI data set
CIAssociationType	Association type to which the CI belongs
changeImpact	Impact of the change request. The supported impact types are as follows: 1 — Extensive/Widespread 2 — Significant/Large 3 — Moderate/Limited 4 — Minor/Localized
changeUrgency	Urgency of the change request. The supported urgency types are as follows: 1 — Critical 2 — High 3 — Medium 4 — Low
changePriority	Priority of the change request. The supported priorities are as follows: Critical High Medium Low
changeRiskLevel	Risk level of the change request. The supported risk levels are as follows: Risk Level 1 Risk Level 2 Risk Level 3 Risk Level 4 Risk Level 5
Task event
parentChangeID	Unique identifier of the change request to which the task is associated
taskName	Name of the task
taskSummary	A brief summary of the task
taskNotes	Notes associated with the task
taskPriority	Priority of the task. The supported priorities are as follows: Critical High Medium Low
taskID	Unique identifier for the task
taskType	Type of task. The supported types are as follows: Manual Automatic
taskStatus	Status of the task. The supported statuses are as follows: Staged Assigned Pending Work In Progress
taskStatusReason	Reason for the status of the task
taskAssigneeCompany	Company to which the task is assigned
taskAssigneeGroup	Group to which the task is assigned
taskAssignee	Individual to which the task is assigned
actualStartDateEpoch	Actual date and time when the task started. The value must be in the epoch format.
actualEndDateEpoch	Actual date and time when the task ended. The value must be in the epoch format.
taskModifiedDateEpoch	Date and time when the task was last modified. The value must be in the epoch format.
CIAssociationDateEpoch	Date and time when the task was associated with CI. The value must be in the epoch format.
CIReconcilationID	Unique identifier for the CI reconciliation
CIName	Name of the CI
CIClass	Class to which the CI belongs
CIDataSetID	Unique identifier for the CI data set
CIAssociationType	Association type to which the CI belongs

Sample input parameters in the JSON format to create a change event for integration of Remedy Change Management with TrueSight Infrastructure Management

{
    "applicationType": "CHANGE_MANAGEMENT",
    "eventSourceHostName": "itsmServer.calbro.com",
    "eventSourceIPAddress": "123.456.78.999",
    "eventId": "testevent.unique.id",
    "transactionId": "sample.trasantion.id",
    "correlationId": "",
    "routingInfo": "",
    "eventType": "CM_CHANGE_EVENT",
    "eventDate": 1314276082,
    "attributes": {
        "changeImpact": "4-Minor/Localized",
        "changeModifiedDateEpoch": "1314276082",
        "changePriority": "Low",
        "actualStartDateEpoch": "",
        "changeRiskLevel": "Risk Level 5",
        "actualEndDateEpoch": "",
        "changeStatus": "Scheduled",
        "CIDataSetID": "IMPACT.ASSET",
        "changeStatusReason": "Change Schedule",
        "scheduledEndDateEpoch": "1314283282",
        "changeLocationServer": "ITSMServer.calbro.com",
        "CIClass": "BMC_ComputerSystem",
        "changeCategory": "NORMAL",
        "changeUrgency": "4-Low",
        "CIAssociationType": "Impact",
        "changeNotes": "Sample Event Creation Note",
        "completionDateEpoch": "",
        "changeOwner": "ChangeUser",
        "changeID": "sample.change.unique.id",
        "changeCoordinator": "ChangeCo-Ordinator",
        "CIReconcilationID": "SAMPLE.RECON.ID",
        "changeReason": "Maintenance",
        "changeCompany": "MyCompany",
        "scheduledStartDateEpoch": "1314279682",
        "CIName": "sampleCI-name",
        "CIAssociationDateEpoch": "1314279682",
        "changeCustomerName": "Sample App Team",
        "CICellName": "pncell_cellName",
        "changeSummary": "Sample Change Event Creation"
    }
}

Response for creating an event for Remedy Change Management integration

A change event is created for Remedy Change Management integration with TrueSight Infrastructure Management.

Integration of TrueSight Capacity Optimization with TrueSight Infrastructure Management

TrueSight Capacity Optimization communicates events to TrueSight Infrastructure Management through the REST API. Using the REST API, you can create or modify events.

For more information about the integration of TrueSight Capacity Optimization with TrueSight Infrastructure Management, see Integrating events from TrueSight Capacity Optimization Open link

Example URL to create an event for TrueSight Capacity Optimization integration

An example URL to create an event for TrueSight Capacity Optimization integration is as follows:

http://bppmwsserver:80/bppmws/api/Device/bppmwsserver.calbro.com/event?idtype=Name

Example input parameters in the JSON format to create an event for TrueSight Capacity Optimization integration

Input parameters in the JSON format to create an event lists the input parameters that you can provide to create an event. The list of attributes varies depending on the application type you select. The following table lists the attributes that are specific to integration of TrueSight Capacity Optimization with TrueSight Infrastructure Management.

List of attributes for the REST API to create an event for TrueSight Capacity Optimization integration with TrueSight Infrastructure Management

Attributes	Description
CLASS	Class of the event. The supported class is BCO_EV.
utilization_measurment_unit	Unit to measure the utilization
mc_object_uri	Address used to cross-launch
is_predictive	Indicates whether the event has a predictive severity
entity	Type of BCO monitored object for which TrueSight Infrastructure Management receives an event
event_type	Type of the event
severity	Severity of the event
host_name	Fully qualified name of the host on which the event is created
msg	Textual description of the event
days_to_reach_threshold	Number of days required to reach the threshold
cluster_name	Name of the cluster
metric_utilization	Utilization of the metric such as CPU, FILESYSTEM, and so on
file_system_name	Name of the file system entity type
threshold_measurment_unit	Unit to measure the threshold value
metric	Name of the metric. For example, FILESYSTEM
mc_smc_alias	Alias of the event description
threshold_value	Value of the threshold
partition_name	Name of the file system partition
unique_identifier	Universal event identifier

Sample input parameters in the JSON format to create an event for integration of TrueSight Capacity Optimization with TrueSight Infrastructure Management

{
    "applicationType": "CAPACITY_MANAGEMENT",
    "eventSourceHostName": "source.server.com",
    "eventSourceIPAddress": "192.168.123.46",
    "attributes": {
        "CLASS": "BCO_EV",
        "utilization_measurment_unit": "PCT",
        "mc_object_uri": "http://sample.server.com",
        "is_predictive": "true",
        "entity": "LPAR",
        "event_type": "LPAR_FS_EXCEEDS_THRESHOLD",
        "severity": "WARNING",
        "host_name": "",
        "msg": "Sample BMC Capacity Event",
        "days_to_reach_threshold": "10",
        "cluster_name": "",
        "metric_utilization": "50",
        "file_system_name": "/TMP",
        "datastore_name": "",
        "threshold_measurment_unit": "PCT",
        "metric": "FILESYSTEM",
        "mc_smc_alias": "relatedDeviceAlias",
        "VM_name": "",
        "threshold_value": "100",
        "partition_name": "pbpa9lp3",
        "unique_identifier": "bco_unique_identifier"
    }
}

Response for creating an event for TrueSight Capacity Optimization integration

An event is created for TrueSight Capacity Optimization integration with TrueSight Infrastructure Management.