API Server Setup

How to Configure API Server

API Server enables on-premises local access to the IT-Conductor API interface. The Gateway(s) must be configured to act as an API Server.

1. In the IT-Conductor main menu, navigate to Dashboards > Administrator.

Figure 1: IT-Conductor Dashboard Menu

2.) Click the Gateway you would like to configure to show the metric object menu. Then, click Modify.

Figure 2: Sample Gateway to Modify

Figure 3: Modify Option

3.) Check the API Server checkbox and specify the API Server Port value. Then, click the "Save" icon.

Note: Ensure the port is available for listening and is not blocked by the local firewall.

Figure 4: API Server and API Server Port Modification

Within several minutes the Gateway will start the API server.

Usage

The IT-Conductor Gateway on Windows includes a client program that can interact with the API server.

The "ITCAPIClient.exe" program can be found in the Gateway installation folder "C:\Program Files\IT-Conductor\Agent\bin" and can be copied to another folder or another Windows computer. There are no external dependencies except Windows .Net Framework 4.5.

The program usages are as the following:

C:\Program Files\IT-Conductor\Agent\bin>ITCAPIClient.exe
Usage: -server <host>:<port> -class <Class> <options>
        Options:
        When -class Notify specified:
                [-ACTIVITY_QueueId <Person ID>|<Group ID>|<Role ID>]
                [-NOTIFY_TargetClass Person|Group|Role|Customer] : ignored if ACTIVITY_QueueId is specified
                [-NOTIFY_TargetAttrName PERSON_LoginName|OBJECT_Name] : ignored if ACTIVITY_QueueId is specified
                [-NOTIFY_TargetAttrValue <Person Login>|<Group Name>|<Role Name>] : ignored if ACTIVITY_QueueId is specified
                -NOTIFY_Subject <subject>
                -NOTIFY_MessageLong <message>
        When -class <other> specified:
                Not documented

The sample below will create an IT-Conductor Notification for the IT-Conductor user identified by e-mail "[email protected]". The Notification will send e-mail(s) based on the person's notification schedule.

ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Person -NOTIFY_TargetAttrName PERSON_LoginName -NOTIFY_TargetAttrValue [email protected] -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"

The sample below will create IT-Conductor Notification for the IT-Conductor group BasisAdmins. The Notification will send e-mail(s) to all group members based on their notification schedules.

ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Group -NOTIFY_TargetAttrName OBJECT_Name -NOTIFY_TargetAttrValue BasisAdmins -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"

The IT-Conductor Gateway on Linux does not include a client program however it is possible to use wget in a similar manner:

wget http://<host>:<port>/<Class>?<options>
Options:
        When Class Notify specified:
                [ACTIVITY_QueueId=<Person ID>|<Group ID>|<Role ID>&]
                [NOTIFY_TargetClass=Person|Group|Role|Customer&] : ignored if ACTIVITY_QueueId is specified
                [NOTIFY_TargetAttrName=PERSON_LoginName|OBJECT_Name&] : ignored if ACTIVITY_QueueId is specified
                [NOTIFY_TargetAttrValue=<Person Login>|<Group Name>|<Role Name>&] : ignored if ACTIVITY_QueueId is specified
                NOTIFY_Subject=<subject>&
                NOTIFY_MessageLong=<message>&
        When other classes specified:
                Not documented

For example:

wget http://ozraid01:8881/Notify?NOTIFY_TargetClass=Person&NOTIFY_TargetAttrName=PERSON_LoginName&[email protected]&NOTIFY_Subject=Test Message&NOTIFY_MessageLong=This is a test message sent via API Server

This notation can also be used from any web browser for testing purposes.