All Products
Search
Document Center

DataWorks:CallbackExtension

Last Updated:Oct 17, 2024

Sends the processing result of an extension point event by an extension to DataWorks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ExtensionCodestringYes

The unique code of the extension.

8abcb91f-d266-4073-b907-2ed670378ed1
MessageIdstringYes

The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.

03400b03-b721-4c34-8727-2d6884077091
CheckResultstringYes

The check status of the extension point event. Valid values:

  • OK: The event passes the check.
  • FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.
  • WARN: The event passes the check, but an alert is reported.
FAIL
CheckMessagestringNo

The check message of the extension point event. If CheckResult is set to FAIL, you must provide the failure cause.

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

7C352CB7-CD88-50CF-9D0D-E81BDF020E7F
Successstring

Indicates whether the request was successful. Valid values:

true

false

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF020E7F",
  "Success": "true"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history