End-of-Life (EOL) Announcement for Change V1 APIs

End-of-Life (EOL) Announcement for Change V1 APIs

Dear users,

ServiceDesk Plus V1 APIs for the change module will reach its end-of-life (EOL) on January 31, 2024. Moving forward, any upcoming releases will not have access to the V1 Change APIs. 

Impact:

Any external products, web clients or desktop applications which are integrated to ServiceDesk Plus via the V1 APIs would be impacted (specifically integrations that use the Change API).

To put it simply, any functionalities such as client integrations, custom scripts or functions configured with v1 APIs will no longer work.

Recommended Actions:

We highly recommend to update aforesaid functionalities with V3 APIs in case they are configured with V1 APIs.

Here is the list of Change V1 APIs which are being deprecated, along with the equivalent V3 APIs:

API NAME
V1 API URL
V1 OPERATION NAME
EQUIVALENT V3 API URL
V3 HTTP METHOD
GET Change
/sdpapi/change/{change_id}
GET
/api/v3/changes/{change_id}
GET
GET All Changes
/sdpapi/change
GET_ALL
/api/v3/changes
GET
ADD Change
/sdpapi/change
ADD
/api/v3/changes
POST
UPDATE Change
/sdpapi/change/{change_id}
UPDATE
/api/v3/changes/{change_id}
PUT
DELETE Change
/sdpapi/change/{change_id}
DELETE
/api/v3/changes/{change_id}/move_to_trash
DELETE
ADD Attachment in Change
/sdpapi/change/{change_id}/attachment
ADD_ATTACHMENT
/api/v3/changes/{change_id}/upload

(Here the input data would be the file data.)
PUT


Within ServiceDesk Plus, Change APIs are used in several functionalities where we have scripting support (listed below). We highly recommend our users to check and update these as well: 

1. Admin > Automation - Custom Triggers - Change > Execute script operation.
2. Admin > Developer Space - Custom Function - Change > Custom functions.
3. Admin > Automation - Custom Schedules > Executor.
4. Admin > Developer Space - Page Scripts.
5. Admin > Developer Space - Webhooks - Change
6. Custom scripts in <SDP_Home>\integration\custom_scripts folder.

V3 API Documentation:

Refer to the V3 API documentation tool available within the application. Navigate to Admin > Developer Space > API. You can also have a look on our Demo site using the following link.


Find some change module sample functions configured with V3 APIs in the following KB articles:



        New to M365 Manager Plus?
        New to M365 Manager Plus?
          New to RecoveryManager Plus?
          New to RecoveryManager Plus?
            New to Exchange Reporter Plus?
            New to Exchange Reporter Plus?
              New to SharePoint Manager Plus?
              New to SharePoint Manager Plus?
                See all integrations
                New to ADManager Plus?
                See all integrations
                New to ADManager Plus?

                  New to ADSelfService Plus?

                  Start your free trial
                  Start your free trial


                          Related Products