Virima API Specification - ITSMTicketMgtService Services

The requests documented in this section are directed to ITSMTicketMgtService resources, which represent .

Contents

1 saveITSMTicketMgtInboxConfiguration POST Interface
2 getITSMTicketMgtInboxProperties GET Interface
3 saveITSMTicketMgtSMTPConfiguration POST Interface
4 saveITSMAuthSMTPConfiguration POST Interface
5 getITSMTicketMgtSMTPProperties GET Interface
6 deleteITSMTicketMgtSMTPProperties POST Interface
7 getITSMTicketMgtSMTPPropertiesDefault GET Interface
8 deleteITSMTicketMgtInboxProperties GET Interface

saveITSMTicketMgtInboxConfiguration POST Interface

Method: POST

Relative URL: itsm-ticket-mgt/save-itsm-ticket-mgt-inbox-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ITSMTicketMgtInboxProperties

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEITSMTICKETMGTINBOXCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userName":"?",
   "password":"?",
   "host":"?",
   "folder":"?",
   "alertType":"?",
   "lastReadOn":?,
   "enableMonitoring":?,
   "monitoringFrequency":?,
   "senderEmail":"?",
   "protocol":"?",
   "port":"?",
   "useProxy":?,
   "enableTLS":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

Example Response:

{
   "id":494965218,
   "response":"?"
}

getITSMTicketMgtInboxProperties GET Interface

Method: GET

Relative URL: itsm-ticket-mgt/get-itsm-inbox-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ITSMTicketMgtInboxProperties

Example Request:

Example Response:

{
   "id":2147483647,
   "userName":"?",
   "password":"?",
   "host":"?",
   "folder":"?",
   "alertType":"?",
   "lastReadOn":?,
   "enableMonitoring":?,
   "monitoringFrequency":?,
   "senderEmail":"?",
   "protocol":"?",
   "port":"?",
   "useProxy":?,
   "enableTLS":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

saveITSMTicketMgtSMTPConfiguration POST Interface

Method: POST

Relative URL: itsm-ticket-mgt/save-itsm-ticket-mgt-smtp-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ITSMTicketMgtSMTPProperties

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEITSMTICKETMGTSMTPCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userName":"?",
   "password":"?",
   "host":"?",
   "from":"?",
   "replyTo":"?",
   "port":"?",
   "lastReadOn":?,
   "enableSSL":?,
   "auth":?,
   "startTLSEnable":?,
   "startTLSRequired":?,
   "protocol":"?",
   "useProxy":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "isDefault":?,
   "smtpReplyTo":"?",
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveITSMAuthSMTPConfiguration POST Interface

Method: POST

Relative URL: itsm-ticket-mgt/save-itsm-ticket-mgt-smtp-auth-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ITSMTicketMgtSMTPProperties

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEITSMAUTHSMTPCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userName":"?",
   "password":"?",
   "host":"?",
   "from":"?",
   "replyTo":"?",
   "port":"?",
   "lastReadOn":?,
   "enableSSL":?,
   "auth":?,
   "startTLSEnable":?,
   "startTLSRequired":?,
   "protocol":"?",
   "useProxy":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "isDefault":?,
   "smtpReplyTo":"?",
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getITSMTicketMgtSMTPProperties GET Interface

Method: GET

Relative URL: itsm-ticket-mgt/get-itsm-smtp-configuration/is-default

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ITSMTicketMgtSMTPProperties

Example Request:

Example Response:

{
   "id":2147483647,
   "userName":"?",
   "password":"?",
   "host":"?",
   "from":"?",
   "replyTo":"?",
   "port":"?",
   "lastReadOn":?,
   "enableSSL":?,
   "auth":?,
   "startTLSEnable":?,
   "startTLSRequired":?,
   "protocol":"?",
   "useProxy":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "isDefault":?,
   "smtpReplyTo":"?",
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

deleteITSMTicketMgtSMTPProperties POST Interface

Method: POST

Relative URL: itsm-ticket-mgt/delete-itsm-smtp-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ITSMTicketMgtSMTPProperties

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEITSMTICKETMGTSMTPPROPERTIES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userName":"?",
   "password":"?",
   "host":"?",
   "from":"?",
   "replyTo":"?",
   "port":"?",
   "lastReadOn":?,
   "enableSSL":?,
   "auth":?,
   "startTLSEnable":?,
   "startTLSRequired":?,
   "protocol":"?",
   "useProxy":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "isDefault":?,
   "smtpReplyTo":"?",
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getITSMTicketMgtSMTPPropertiesDefault GET Interface

Method: GET

Relative URL: itsm-ticket-mgt/get-itsm-smtp-configuration-default

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ITSMTicketMgtSMTPProperties

Example Request:

Example Response:

{
   "id":710241936,
   "userName":"?",
   "password":"?",
   "host":"?",
   "from":"?",
   "replyTo":"?",
   "port":"?",
   "lastReadOn":?,
   "enableSSL":?,
   "auth":?,
   "startTLSEnable":?,
   "startTLSRequired":?,
   "protocol":"?",
   "useProxy":?,
   "proxyHost":"?",
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyPort":"?",
   "archive":?,
   "isDefault":?,
   "smtpReplyTo":"?",
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

deleteITSMTicketMgtInboxProperties GET Interface

Method: GET

Relative URL: itsm-ticket-mgt/delete-itsm-inbox-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}