URL: service-desk/api/release/{releaseId} Method: DELETE Description : Delete a Release. Parameters: Parameter Type Optional/Required Description release_id integer Required Release id of the release to be deleted. Success Response : { “success”:true, “Message”:“Release deleted successfully” }
Category: Contract Management
Terminate Contract
Description: URL: service-desk/api/contract-terminate/{contractId} Method: POST Description : Route to terminate contract Parameters: Parameter Type Optional/Required Description contract_id integer Required Contract id of the contract to be terminated Success Response : { “success”:true, “Message”:“Contract Terminated Successfully” }
Extend Contract
Description: URL: service-desk/api/contract-extend/{contractId} Method: POST Description : Route to extend contract Parameters: Parameter Type Optional/Required Description contract_id integer Required Contract id of the contract to be renewed approver_id integer Required Approver ID that will approve contract Renewal cost integer Required Cost of the Extended Contract contract_start_date string Required Date From which extended contract will start,Current […]
Approve Contract
Description: URL: service-desk/api/contract-approve/{contractId} Method: POST Description : Route to approve contract Parameters: Parameter Type Optional/Required Description contract_id integer Required Contract id of the contract to be approved Success Response : { “success”:true, “Message”:“Contract Approved Successfully” }
Renew Contract
Description: URL: service-desk/api/contract-renew/{contractId} Method: POST Description : Route to renew contract Parameters: Parameter Type Optional/Required Description contract_id integer Required Contract id of the contract to be renewed approver_id integer Required Approver ID that will approve contract Renewal cost integer Required Cost of the Renewed Contract contract_start_date string Required Date when renewed contract will start contract_end_date […]
Delete Contract
URL: service-desk/api/contract/{contractId} Method: DELETE Description : Delete a contract. Parameters: Parameter Type Optional/Required Description contract_id integer Required Contract id of the contract to be deleted. Success Response : { “success”:true, “Message”:“Contract deleted successfully” }
Detach Asset from Contract
Description: URL: service-desk/api/contract-detach-asset/{contractId}/{assetId} Method: DELETE Description : Route to detach asset from contract based on contractId and assetId Parameters: Parameter Type Optional/Required Description contract id integer Required Contract id of the contract to detach change asset id integer Required Asset id of the asset to be detached from contract Success Response : { “success”:true, “Message”:“Asset Detached […]
Attach Asset to Contract
Description: URL: service-desk/api/contract-attach-asset Method: POST Description : Route to attach asset to contract based on contractId and assetId Parameters: Parameter Type Optional/Required Description contract id integer Required Contract id of the contractto attach change is passed through request asset ids integer Required Asset ids of the assets to be attached to contract is passed through request Success […]
Contract List
NOTE: User must me logged in as agent or admin to access this API URL : service-desk/api/contract-list Method : GET Query Parameters : Parameter Type Possible Values Required/Optional Description sort-field String name, contract_number, expiry Optional Field name to sort sort-order String asc, desc Optional Sorting order either ascending or descending search-query String any Optional Keyword […]
Delete Contract
NOTE: User must be logged in as admin to access this API URL : service-desk/api/contract/{contractId} Method : DELETE Query Parameters : Parameter Type Possible Values Required/Optional Description contractId Integer Required Contract id Success Response: { “success”:true, “message”:”Contract Deleted Successfully” } Error Response: { “success”:false, “message”:”Contract Not Found” }