TestDataServiceApi

Tests a DataService Studio API asynchronously. Call GetDataServiceApiTest to obtain the test result.

Try it now

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Parameter	Type	Required	Description	Example
ApiId	integer	Yes	The ID of the DataService Studio API to test.	12343
QueryParam	array<object>	No	The query parameters in the request.
	object	No	The parameter object.
ParamKey	string	No	The name of the parameter.	name
ParamValue	string	No	The value of the parameter.	test
BodyParams	array<object>	No	The parameters in the request body.
	object	No	The parameter object.
ParamKey	string	No	The name of the parameter.	name
ParamValue	string	No	The value of the parameter.	test
PathParams	array<object>	No	The parameters in the request path.
	object	No	The parameter object.
ParamKey	string	No	The name of the parameter.	path1
ParamValue	string	No	The value of the parameter.	api
HeadParams	array<object>	No	The parameters in the request header.
	object	No	The parameter object.
ParamKey	string	No	The name of the parameter.	requestId
ParamValue	string	No	The value of the parameter.	abcd
BodyContent	string	No	The request body content.	{"name":"test"}

Success response

JSON format

{
  "RequestId": "abdsfewe",
  "Data": {
    "TestId": "232432"
  }
}

HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

See Release Notes for a complete list.