Deletes an API in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | DeleteDataServiceApi | The operation that you want to perform. Set the value to DeleteDataServiceApi. |
TenantId | Long | No | 10002 | The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the username for the logon in the upper-right corner and click User Info in the Menu section. |
ProjectId | Long | Yes | 10001 | The workspace ID. |
ApiId | Long | Yes | 10000 | The ID of the DataService Studio API. |
Response parameters
Parameter | Type | Example | Description |
HttpStatusCode | Integer | 200 | The HTTP status code. |
Data | Boolean | true | Indicates whether the API was deleted. |
ErrorMessage | String | The connection does not exist. | The error message. |
RequestId | String | 0000-ABCD-EFG**** | The request ID. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists | The error code. |
Success | Boolean | true | Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DeleteDataServiceApi
&TenantId=10002
&ProjectId=10001
&ApiId=10000
&<Common request parameters>Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<DeleteDataServiceApiResponse>
<HttpStatusCode>200</HttpStatusCode>
<Data>true</Data>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<Success>true</Success>
</DeleteDataServiceApiResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Data" : true,
"ErrorMessage" : "The connection does not exist.",
"RequestId" : "0000-ABCD-EFG****",
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
"Success" : true
}Error codes
HTTP status code | Error code | Error message | Description |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The number of requests for the resource has exceeded the upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | The DataWorks system is busy. Try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | Excessive requests have been submitted within a short period of time. Try again later. |
500 | InternalError.System | An internal system error occurred. Try again later. | An internal error has occurred. Try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal error has occurred. Try again later. |
For a list of error codes, see Service error codes.