API Server Setup

API Server enables on-premises local access to IT-Conductor API interface

Configuration

The Gateway(s) needs to be configured to act as an API Server:

1. Click on the Gateway you would like to configure
2. Check API Server checkbox and specify API Server Port value.
   
   Make sure the port is available for listening and is not blocked by the local firewall
3. Save the Gateway

Within several minutes the Gateway will start the API server.

Usage

IT-Conductor Gateway on Windows includes a client program that can be used to interact with API server:
The program ITCAPIClient.exe can be located 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 is 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

For example:

ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Person -NOTIFY_TargetAttrName PERSON_LoginName -NOTIFY_TargetAttrValue admin@itconductor.com -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"

Will create IT-Conductor "Notification" for the IT-Conductor user identified by e-mail "admin@itconductor.com". The Notification will send e-mail(s) based on persons notification schedule.

and

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"

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

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&NOTIFY_TargetAttrValue=admin@itconductor.com&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.