Integration (API's)

Which APIs are available in OpenProcess?

1) Get Documents API

This API provides the means using:

  • DocumentId

To retrieve a document associated with a process. As we will see with the worked example this is useful for the purposes of getting the XML document created as a part of an online form where the XML has been mapped in eDesigner.

 

2) Post a Note API

This API provides the means using:

  • ProcessId

To add a note to a process. This therefore enables automated addition of notes to processes.

 

3) Get Current Step API

This API provides the means using:

  • ProcessId

To find the current step id for a process. Therefore enabling this to be known should one want to complete it automatically, which is the next API.

 

4) Complete a Step API

This API provides the means using: 

  • ProcessId
  • StepId

To automatically complete a step. I.e. back office update is completed and automatically sets the appropriate step to being completed.