Response schema

Last Updated : Apr 14, 2023 |

In Automation, you can use schemas for success and error responses. You can create a success and error variable from the Response schema in the task properties. Automation stores the REST response in the following variable types:

  • String

  • Number

  • Boolean

  • Object

  • Array of strings, numbers, and booleans

The success and error variable names are REST-API_success and REST-API_error by default. You can change the task name from the Properties pane to change the variable name. For example, if you change the task name to REST1, the name of the success and error variables change to REST1_success and REST1_error. Change the task name before creating the variables on the Response schema. Otherwise the variable names do not change.