Fieldcode Manual

Tip: You can use filters for better results

Last updated:June 21, 2024

fcinterface - Interface specific functions

Copy the URL link to this section to share

The fcinterface module is a library provided for Fieldcode Interface mapping specific functionalities.

Available Functions

Copy the URL link to this section to share

Below are the functions available in the fcinterface module.

fcinterface.stop(message)

Exits the mapping process with the given message and marks the process DONE. Can be used to apply business conditions without blocking the ticket flow.

fcinterface.error(message)

Exits the mapping process with the given error message and marks the process REJECTED. Can be used to handle errors with custom message.

Available Objects

Copy the URL link to this section to share

fcinterface.apis

A dict of user defined API definition callbacks mapped by the API definition ID. Can be used to execute API calls within the mapping process. The stored API definition callback takes a request payload as argument for execution.

Example usage:
response = fcinterface.apis[‘12345678-90ab-cdef-1234-567890abcdef’](request_payload)

fcinterface.actions

A dict of system defined Action callbacks mapped by the Action ID. Can be used to execute an Action within the mapping process. The stored Action callback takes an action payload as argument for execution.

Example usage:
fcinterface.actions[‘12345678-90ab-cdef-1234-567890abcdef’](action_payload)

Was this topic helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we further improve this topic?
Please provide the reason for your vote. This will help us improve this topic.
Tags:
Navigation