Feature released in SummitAI Service Management (Denali SP1, SummitAI Platform)

What's New?

The following new APIs are added for the Common Master and User Master:

Authentication

To authenticate the APIs, use the Form or API login details. Create a User with the required Role Template access, use these details to authenticate, and execute the APIs. For more information, see Adding Users.

Common Parameters

For API Key Based Authentication

Common Parameters

Parameter Name	Type	Description	Notes
APIKey	STRING	APIKey that is generated is described in API Authentication and Authorization section.
AuthType	STRING	Type of Authentication.	Value should be APIKey.
OrgID	INTEGER	Unique Identification of the Organization.
ProxyID	INTEGER	Unique Identification number of the proxy.
ReturnType	STRING	Type of the request return.	Example: Json, XML, YAML, etc.
TokenID	STRING	Number of the token whose details must come in Response.

For Username and Password Based Authentication

Common Parameters

Parameter Name	Type	Description	Notes
UserName	STRING	Login name of the User.
Password	STRING	Login password of the User.
ProxyID	INTEGER	Unique Identification number of the proxy.
ReturnType	STRING	Type of the Request return.	Example: Json, XML, YAML, etc.
OrgID	INTEGER	Unique Identification of the Organization.
TokenID	STRING	Number of the token whose details must come in Response.

Creating or Updating the Common Master

Common Master is a unique feature in the SummitAI application that allows Administrators to set most commonly used label names and drop-down values across all the modules. If there is a change or addition required in the label names or drop-down values, this feature saves the efforts of the Administrator to make the same changes in all the pages separately. In other words, it simplifies the customization process required to be done by the Administrators for most commonly used labels names and drop-down values. Use the following API Request to create the Common Master types.

API Details

Sample Request

{
    "ServiceName": "ADM_CreateOrUpdateCommonMaster",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "ReturnType": "JSON",
            "APIKey": "XXXXXXXXXXXXXXXXXXXXXX",
            "AuthType": "APIKEY"
        },
        "objCommonMasterDetail": {
            "DomainName": "Symphony summit",
            "CommonMasterDetails": [
                {
                    "MaterType": "State",
                    "MasterValue": "Victoria",
                    "Active": 1
                },
                {
                    "MaterType": "State",
                    "MasterValue": "Tasmania",
                    "Active": 1,
                    "ParentMasterType": "Country",
                    "ParentValue": "Australia"
                },
                {
                    "CM_ID": "147491",
                    "MaterType": "State",
                    "MasterValue": "Queensland_updated",
                    "Active": 1
                },
                {
                    "CM_ID": "147492",
                    "MaterType": "State",
                    "MasterValue": "NewSouthWales_Updated",
                    "Active": 1,
                    "ParentMasterType": "Country",
                    "ParentValue": "Australia_Updated"
                }
            ]
        }
    }
}

Request Parameters

Parameter Name	Type	Mandatory	Description
CM_ID	STRING	TRUE	Unique identification number of the Common Master. This parameter is mandatory while updating a specific Master Type.
MaterType	STRING	TRUE	Name of the MasterType.
MasterValue	STRING	TRUE	Value of the specified MasterType.
ParentMasterType	STRING	TRUE	Name of the Parent MasterType.
ParentValue	STRING	TRUE	Value of the specified ParentMasterType.
Active	STRING	TRUE	Status of the configuration. Specify the value as 1 to make the configuration active or 0 to make the configuration inactive.

Note:

The Domains of the Master data and Parent data must be the same.

Sample Response

{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": "A04DE77753528619E19F4E23CC818AAE77BB3A86982166BAEFBA46FFDBBACC8AA50B84E66FBEAA69E4C6B79AE6B7BB929DA63DA5FACF2415E6716AE2EC
F053C7BDD4527E24882FD6D6147312601897DF4D7E7DC4E802E8DED56EFBB8404CB47A0AEC2A3DCBFEF888C9C4EB7082A9AC2F049CAD9CE1AC0ACC61B57F1663D247AF
B20D1759EC26AE4EA9EE6808F03EFAD3",
  "OrgID": 0,
  "OutputObject": {
    "CommonMasterDetails": [
      {
        "CM_ID": "17642",
        "MasterType": "state",
        "MasterValue": "GOAA",
        "ParentMasterType": null,
        "ParentValue": null,
        "Parent_CM_ID": null,
        "Action": "Inserted"
      },
      {
        "CM_ID": "17641",
        "MasterType": "state",
        "MasterValue": "GOA002",
        "ParentMasterType": "Country",
        "ParentValue": "India1",
        "Parent_CM_ID": "4870",
        "Action": "Updated"
      }
    ]
  },
  "OutputID": 0,
  "Input": null
}

Creating or Updating the User Master

Use this API you can create an User with details such as user level, designation, manager, contact number, User Type allocation, and so on .

API Details

Sample Request

{
    "ServiceName": "ADM_CreateorUpdateUser",
    "objCommonParameters": {
        "_ProxyDetails": {
            "APIKey": "XXXXXXXXXXXXXXXXXXXXXXXX",
            "AuthType": "APIKEY",
            "ProxyID": 0,
            "ReturnType": "JSON",
            "orgid": 1
        },
        "UniqueField": "EmpId",
        "Users": [
            {
                "UserName": "john",
                "EmployeeId": "S1234",
                "Password": "XXXXXXXX",
                "Login_ID": "john@xyz.com",
                "DomainName": "xyz",
                "EmailId": "john@xyz.com",
                "ManagerEmailId": "ryan@xyz.com",
                "ManagerEmployeeID": "S123",
                "Manager_NT_UID": "SUS1233455",
                "MobileNumber": "9123456780",
                "NT_UID": "",
                "RoleTemplate": "Super Admin",
                "Designation": "Lead",
                "Joindate": "05/02/2020",
                "Address": "Gollastreet,Mumbai",
                "Location": "mumbai-911",
                "City": "Vijayawada",
                "ContactNumber": "+81-0944022338789",
                "State": "Maharastra",
                "Country": "India",
                "Customer": "SUMMIT",
                "TimeZone": "(UTC - 02:00) FNT - Fernando de Noronha Time",
                "UserLevel": "level5",
                "ZipCode": "534235",
                "LoginType": "FORM",
                "APIKeyExpiry": "2020-08-21",
                "Remarks": "This is created by me",
                "UserType": "Analyst",
                "AlternateMailID1": "test11@xyz.in",
                "AlternateMailID2": "test12@xyz.in",
                "AlternateMailID3": "test13@xyz.in",
                "AlternateMailID4": "test14@xyz.in",
                "SortOrder": "0",
                "IsLocked": "0",
                "checkboxcustomattributes": [
                    {
                        "Attr_Name": "Multiple Unit",
                        "Attr_Value": "0100001 - Board Of Directors",
                        "Group_Name": "Default Group"
                    },
                    {
                        "Attr_Name": "manual chk",
                        "Attr_Value": "B",
                        "Group_Name": "Default Group"
                    }
                ],
                "CustomAttributes": [
                    {
                        "Attr_Name": "Drop",
                        "Attr_Value": "bangalore",
                        "Group_Name": "Default Group"
                    },
                    {
                        "Attr_Name": "User Text Area",
                        "Attr_Value": "Yes",
                        "Group_Name": "Default Group"
                    }
                ]
            }
        ]
    }
}

Request Parameters

Parameter Name	Type	Mandatory	Description	Notes
UniqueField	STRING	TRUE	Unique Field value can be one of the following: EmpId EmailId NT_UID	If the value of this parameter is EmpId, the EmployeeId parameter is mandatory. If the value of this parameter is EmailId, the EmailId parameter is mandatory. If the value of this parameter is NT_UID, the NT_UID parameter is mandatory.
Users	ARRAY	TRUE	Under Users array, you can add multiple Users.
UserName	STRING	TRUE	Name of the User.
EmployeeId	STRING		Employee identification number of the User.
Password	STRING	TRUE	Enter the password of your choice.	This parameter is mandatory when the LoginType parameter value is entered as Form Login.
Login_ID	STRING	TRUE	Configured login ID of the User for Form Login.	This parameter is mandatory when the LoginType parameter value is entered as Form Login.
DomainName	STRING	TRUE	Domain name of the User.
EmailId	STRING	FALSE	E-mail ID of the User.
ManagerEmailId	STRING	FALSE	E-mail ID of the User's Manager.	You can enter ManagerEmailId or ManagerEmployeeID or Manager_NT_UID. Also, you can enter all these parameter values. If the entered values for ManagerEmailId, ManagerEmployeeID, and Manager_NT_UID are valid, the User ID of the manager gets the precedence over the other two parameters.
ManagerEmployeeID	STRING	FALSE	Employee identification number of the User's Manager.
Manager_NT_UID	STRING	FALSE	NT login ID of the User's Manager.
MobileNumber	STRING	FALSE	Mobile number of the User.
NT_UID	STRING	TRUE	NT login ID of the User to log in.	This parameter is mandatory when the LoginType parameter value is entered as NT Login.
RoleTemplate	STRING	TRUE	Assign Role Templates to the User by clicking the Select check box next to the Role Template name. Based on this mapping, the User is able to view the module menu options, drop-down list options, and edit the page details.
Designation	STRING	FALSE	Designation of the User.
Joindate	STRING	FALSE	Joining date of the User.
Address	STRING	FALSE	Address of the User.
Location	STRING	FALSE	Specify the location.. The user can view the list of incidents logged by other users who are mapped to the location specified in this parameter. The user can specify multiple locations.
City	STRING	FALSE	City name of the User.
ContactNumber	STRING	FALSE	Contact number of the User. This can be the User's landline number or a desk extension.
State	STRING	FALSE	State name of the User.
Country	STRING	FALSE	Country name of the User.
Customer	STRING	FALSE	Specify the customer name. The user can view the list of incidents logged by other users who are mapped to the customer specified in this parameter. The user can select multiple customers.
TimeZone	STRING	TRUE	Time zone for the User.
UserLevel	STRING	FALSE	Grade of the User in the Organization.
ZipCode	STRING	FALSE	Zip code of the City.
LoginType	STRING	TRUE	Login type of the User.	The value can be one of the following: NT Login Form Login API Key.
APIKeyExpiry	STRING	FALSE	Specify a future date for the expiry of the API Key.	If no value is specified, the API considers the expiry date as 1 year from the date of user creation.
Remarks	STRING	FALSE	Additional information about the User.
UserType	STRING	FALSE	Type of the User.	Example: End User, Analyst, or Administrator.
AlternateMailID	STRING	FALSE	Enter alternative E-mail IDs for the user. You can configure a maximum of four additional E-mail IDs. When an Incident is logged for the User, an E-mail is sent to the configured primary or alternate E-mail ids.	You can enter four alternate E-mail IDs using AlternateMailID1, AlternateMailID2, AlternateMailID3, and AlternateMailID4. While updating any one of the alternate E-mail ID, the User must update all four E-mail IDs. Otherwise, the entered single E-mail ID will not get updated.
SortOrder	BOOLEAN	FALSE	The order in which User names gets sorted or displayed.
IsLocked	STRING	FALSE	Is the Account of the User locked?	The value is either 0 or 1.
checkboxcustomattributes	ARRAY	TRUE	Custom attributes that can be specified and shown in as a check box in the Application. These Custom Fields include the following parameters: GroupName AttributeName AttributeValue
CustomAttributes	ARAY	TRUE	Custom attributes for a specified User. These Custom Fields include the following parameters: GroupName AttributeName AttributeValue

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "0 Users Updated Succesfully.1 Users created Succesfully.",
    "OrgID": 0,
    "Output": "0 Users Updated Succesfully.1 Users created Succesfully.",
    "OutputID": 0,
    "OutputObject": "{\"Inserted_Records\":[{\"Id\":\"428270\",\"UniqueId\":\"manik123\",\"APIKey\":\"\"}],\"Updated_Records\":null}",
    "TokenID": "3607726A11AC867B6030FBF353413C8B6617A8C76EA89B5522C5E25B7A4FE4C460C265BE170C89A5C2C4D5B57FCB1243988FB1BE7D600AE139467DC5211BB4552D0
E77EFCA76EE99FB70396D63B11ABB499C2B301806BA38E545A51DC9A69E91D107C610CAF64CC53A6EB0F3D4FCB820D3A5E2CA139D41747555689F54D16AA87C6AEFCD14A1AC8F
D8671DD2809A9F2A8A9F70929BB55124CE9700981740A4208061449C"
}

Response Parameters

Parameter Name	Type	Description
Inserted_Records	ARRAY	Displays the list of records created or updated.
Id	STRING	Unique Identification number of the user
UniqueId	STRING	Based on the UniqueField Request parameter, the value is displayed. The value can be the Employee ID or the Email ID or the login ID of the User.
APIKey	STRING	Displays the allocated API Key. This value gets created if the Login Type is API Key.
Updated_Records	STRING	Displays the number of updated records.

Errors Messages

All successful API Responses return with the HTTP Status code 200 OK. This document contains some of the errors that APIs return in Response.

Error	Description
Invalid	API Request is failed to fetch due to an invalid value. The value can be a Parameter value, a Header value, or a Property value.
Specify the value	API Request is missing with the mandatory Parameter value.
APIKey and AuthType	API Request is failed due to missing values of either APIKey or AuthType.
Invalid or expired API Key	Specified API Key is invalid or expired. Generate a new API Key or extend the API expiry date. For more information, see API Authentication.

Note:

Standard HTTP status codes are displayed to indicate whether the API request is executed successfully or not. Following are the standards response codes:

Successful Responses (200-299)
Client Errors (400-499)
Server Errors (500-599)

Common Master and User Master APIs

What's New?

Authentication

Common Parameters

Common Parameters

Common Parameters

Creating or Updating the Common Master

API Details

Request Parameters

Creating or Updating the User Master

API Details

Request Parameters

Response Parameters

Errors Messages