Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

Overview

  • API is a Workflow Action That is used to call records or External URLs.

  • API Can be called from two source

    • Model

    • URL

Config

  • Source API Type: Source API type

  • Model: If you select Source type as Model, then Select your Model

  • URL: If you select Source type as URL, then provide URL

    • Authorization Type: Select the type of URL

    • Relative Url: Enter the API URL

    • Method: Select the method which you want to request, following are the methods that are available

      • GET

      • POST

      • PUT

      • DELETE

    • Is Request Array: If the checkbox is checked, then the request is stored in an array

    • Request Body: Click on the + icon to add Request Body

      • Label: The label is used to identify the Request Body

      • Name: Name is the unique identifier of the Requested Body

      • Field Type: Select the field type

      • Required: If the checkbox is checked, then the field will be required

      • Is Array: If the checkbox is checked, then the field is stored in an array

      • Default Value: Enter the default value for your request

    • Response: Click on the + icon to add Response

      • Label: The label is used to identify the Response

      • Name: Name is the unique identifier of the Response

      • Field Type: Select the field type

      • Required: If the checkbox is checked, then the field will be required

      • Is Array: If the checkbox is checked, then the field is stored in an array

      • Default Value: Enter the default value for your Response

Action Details

  • Label: Label is used to identify the Query Records at UI

  • Name: Name is the unique identifier of the modal

  • Description: Description is some information about the workflow action

API Workflow Creation

  • Drag and drop the API

  • Return to the Layout Page

  • No labels