Deprecating few params of v3 API urls

Deprecating few params of v3 API urls

Dear users,

 

We would like to inform you that we have made some changes to the V3 API (URLs starting with /api/v3) format. These changes are incorporated in the 11204 version of the application.  To avoid disruption of service or normal operations, we recommend you incorporate the changes as early as possible. We will be removing the support for the deprecated params in about 6 months time, backward compatibility will given till then.

 

What's changing

 

As a part of this, we have made the following changes for API request parameters and headers

 

  1. The parameter INPUT_DATA(uppercase) is changed to input_data(lowercase).

  2. The authtoken and portalid will be accepted as header only.

  3. The following parameters will not be supported anymore "format", "TECHNICIAN_KEY", "AUTHTOKEN", "PORTALID".

 

 

New Restrictions

  • The parameter "input_data" will be a JSONObject, hence the usage of null or empty string for this parameter is restricted.

  • If the value for any attribute/key within "input_data" is of type JSONArray, the usage of null or empty string as value for this attribute is restricted.

  • If the value for any attribute/key within "input_data" is of type JSONObject, the usage of empty string as value for this attribute is restricted.

  • If any URL supports the parameter "ids", the usage of null or empty string as value for this parameter is restricted.

  • Empty string or null values are restricted for the entity id.

 

 

Major Difference

 

 

Old Version

New Version

INPUT_DATA

input_data

TECHNICIAN_KEY

authtoken (will be accepted as a header only)

PORTALID

portalid (will be accepted as a header only)

 

 

 

Impacted Areas

Any external products, web clients, desktop applications which are integrated to ServiceDesk Plus via the V3 APIs would be impacted.