New API features in R2023-05

Features	Description
API usability enhancement	Consistent endeavor is continuously being carried out to address API discrepancy issues to help you efficiently develop your API solutions. Highlighted endpoints: Get Plan configuration and Configure Plan execution: the API documentation is corrected to confirm that the Runtime attribute is not required in the response or the request body. Get Plan details: a BaseArtifactVersion type instead of artifactVersion is used in the payload.
Run profile deletion	When deleting a run profile, use the newRunProfileId query parameter to specify the run profile that replaces the deleted one. In addition, a list of tasks using the run profile to be deleted is returned: If you do not provide a new run profile ID for the replacement, the deletion fails because the tasks on this list still use this run profile and you have not provided an alternative. If you provide a new run profile ID, the deletion succeeds. Then you need to update the tasks on that list with the new run profile ID. Related endpoints: Delete engine run profile

Features

Description

API usability enhancement

Consistent endeavor is continuously being carried out to address API discrepancy issues to help you efficiently develop your API solutions.

Highlighted endpoints:

Get Plan configuration and Configure Plan execution: the API documentation is corrected to confirm that the Runtime attribute is not required in the response or the request body.
Get Plan details: a BaseArtifactVersion type instead of artifactVersion is used in the payload.

Run profile deletion

When deleting a run profile, use the newRunProfileId query parameter to specify the run profile that replaces the deleted one.

In addition, a list of tasks using the run profile to be deleted is returned:

If you do not provide a new run profile ID for the replacement, the deletion fails because the tasks on this list still use this run profile and you have not provided an alternative.
If you provide a new run profile ID, the deletion succeeds. Then you need to update the tasks on that list with the new run profile ID.
Related endpoints:
- Delete engine run profile

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!