How to show the specific custom error message for an Appian web API which is used for creating records in Appian?

In general it is a good practice to validate incoming data before processing it. Then you know, what is wrong and can return that reason in an error message.

Inside a!writeToDataStoreEntity you do not have access to any error details.

Hi Stefan,

I got your valid point about validaton and we are doing it,but we need an extra feature for providing more details about error if incase the api fails.

Is there any way to show the error details in response as our business is asking this as a requirement to make the user experience better, so that user will come to know where they made the mistake while entering the values and why the error occured ?

Hi Stefan,

I got your valid point about validaton and we are doing it,but we need an extra feature for providing more details about error if incase the api fails.

Is there any way to show the error details in response as our business is asking this as a requirement to make the user experience better, so that user will come to know where they made the mistake while entering the values and why the error occured ?

You can easily create a JSON structure which returns any details required. Then showing that to the user is SAP's job.

Hi Stefan ,

Thanks for the response . Can you help me with a sample JSON structure used in realtime create API , if you do not mind so that I will get a clear idea of what you explained me above. 

I would create a new expression which checks each field and creates an error message if something is wrong. This results in a list of dictionaries like

{
  {field: "field1", error: "some error here"},
  {field: "field42", error: "more errors there"}
}

Then when defining the HTTP response, use toJson() to turn that into JSON.

Thank you Stefan,

I believe we have to bring this expression in the OnError() method of API created?I think the response from you will help us.

The a!writeToDataStore has an onError parameter. But I recommend to do the validation before calling that. In case the validation fails, create a separate httpResponse.

Ok Stefan got it , many thanks

I have a same problem. how can i call this customize error msg  expression from webapi and how to connect my validation check rule .

I do not understand your question. Please elaborate.

Thank you for your reply.
I would like to error check each field before registering and I would like to display a customized error message.

OK. And what exactly do you have trouble with?