All Products
Search
Document Center

DataWorks:CallbackExtension

Last Updated:Sep 12, 2023

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes CallbackExtension

The operation that you want to perform. Set the value to CallbackExtension.

ExtensionCode String Yes 8abcb91f-d266-4073-b907-2ed670378ed1

The unique code of the extension.

MessageId String Yes 034********091

The message ID. You can obtain the ID from the received message when the extension point event is triggered.

CheckResult String Yes FAIL

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.
CheckMessage String No The xxx rule is triggered. Fix the error and try again.

If CheckResult is set to FAIL, provide the failure cause.

Response parameters

Parameter

Type

Example

Description

RequestId String 7C352CB7-CD88-50CF-9D0D-E81BDF020E7F

The unique ID of the request.

Success String true

Indicates whether the request was successful. Valid values:

true

false

Examples

Sample requests

http(s)://[Endpoint]/?Action=CallbackExtension
&ExtensionCode=8abcb91f-d266-4073-b907-2ed670378ed1
&MessageId=03400b03-b721-4c34-8727-2d6884077091
&CheckResult=FAIL
&CheckMessage=The xxx rule is triggered. Fix the error and try again.
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CallbackExtensionResponse>
    <RequestId>7C352CB7-CD88-50CF-9D0D-E81BDF020E7F</RequestId>
    <Success>true</Success>
</CallbackExtensionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.