Skip to main content

Key Aspects of Server Flow

  1. Creation & Management

    • Users can create server flows within categorized folders.
    • Each server flow is configured with properties such as name, API exposure, async operations, and activity status.

  2. Server Flow Properties

    • Expose as API: Determines if the server flow should be available as an API.
    • Async Operation: Enables asynchronous processing.
    • Is Active: Controls whether the server flow is included in builds and executions.

  3. API Definition Information If a server flow is exposed as an API, additional API-related properties are configured, including:

    • HTTP Methods (Verb Type): Supports GET, POST, PUT, and DELETE methods.
    • Request Payload: Defines the structure of the incoming request.
    • Response Payload: Specifies the format of the API response.

  4. Structure of a Server Flow

    • Path Parameters: Required values embedded in the URL.
    • Query Parameters: Optional values passed via the URL.
    • Request Body: Data sent with POST, PUT, or PATCH requests.
    • Output Parameters: The expected response from the flow.
    • Headers: Metadata such as authentication tokens.
    • Exceptions: Custom error handling to prevent crashes and improve error messaging.

  5. Constructs in Server Flows Constructs define the logical execution of a flow. Some available constructs include:

    • Conditional Logic: If, Switch, While, Foreach.
    • API & Database Interaction: Call REST API, Run Query, Query Output Mapping.
    • Data Handling: JSON Parsing, Object Creation, XML to JSON Conversion.
    • Transactions & Exception Handling: Begin Transaction, Raise Exception, Handle HTTP Status Codes.