The Return task lets you customize the error messages corresponding to the HTTP response codes that are returned during an integration execution failure.
You can modify or customize error messages for the following HTTP response codes:HTTP code | Canonical code | 400 | INVALID_ARGUMENT |
---|---|
400 | OUT_OF_RANGE |
401 | UNAUTHENTICATED |
403 | PERMISSION_DENIED |
404 | NOT_FOUND |
409 | ALREADY_EXISTS |
429 | RESOURCE_EXHAUSTED |
499 | CANCELLED |
Configure the Return task
To configure the Return task:
- In the Apigee UI, select your Apigee Organization.
- Click Develop > Integrations.
- Select an existing integration or create a new integration by clicking Create Integration.
If you are creating a new integration:
- Enter a name and description in the Create Integration dialog.
- Select a Region for the integration from the list of supported regions.
- Click Create.
This opens the integration in the integration designer.
- In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
- Click and place the Return task element in the integration editor.
- Click the Return task element on the designer to open the Return task configuration pane.
- Configure the displayed fields using the Configuration properties for the task
as detailed in the tables below.
All changes to the properties are saved automatically.
Configuration properties
The following table describes the configuration properties of the Return task.
Property | Data type | Description |
---|---|---|
HTTP code
|
Integer | The 4XX HTTP code for which you want to customize the error message.
|
Customized return message
|
String | The custom error message for the specified HTTP code. |
Error handling strategy
An error handling strategy for a task specifies the action to take if the task fails due to a temporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see Error handling strategies.