Solved

Process flow API settings SF 2021.1

  • 19 January 2021
  • 3 replies
  • 130 views

Userlevel 3
Badge +9

In the process flow definition (of SF 2021.1) two settings are available for an API configuration: API switch and API alias. 

Our assumption is that these fields need to be configured to start the process flow as an API (Indicium Universal). However when trying to POST to the API alias we receive a 404 (not found) error. 
Posting (via Insomnia) to the original process flow name as an API does work.
 

What is the purpose of these API fields?

icon

Best answer by Vincent Doppenberg 19 January 2021, 19:02

View original

This topic has been closed for comments

3 replies

Userlevel 6
Badge +16

These fields are used when a third party application uses a different message protocol than OData (REST/SOAP etc.). 

https://docs.thinkwisesoftware.com/docs/sf/process_flows.html#a-message-protocol-independent-web-service-in-a-process-flow

Userlevel 6
Badge +4

Hello K.Bakkenes,

The API and API alias fields are currently ignored by Indicium. Given the names of these fields, I understand your assumption that you would need to use these if you want to start your process flow with an API call, but this is not the case.

Every process flow can be started with an API call.

But if you want to keep it simple, please make sure that your process flow follows these requirements:

  • Have only one starting action (only one arrow leaving the Start process action).
  • Use only system flow actions (this excludes tasks and reports as well).

If you stick to those requirements, starting your flow is as simple as the following API call:

POST
/iam/appl/process_flow_id

If the first process action in your flow is a task, an add record, an edit record or a delete record action, then you can start your process flow by performing the corresponding API call. It will trigger the flow automatically. In this case it doesn't matter if you have multiple starting actions, but please make sure that the rest of your process actions are system flow actions.

I hope this helps.

Userlevel 3
Badge +9

Hello Erwin and Vincent,

thank you for your responses. The purpose of these API setting fields is clear now.