☁️
Flow IFS Cloud Development Guidelines
  • Flow IFS Cloud Development Guidelines
  • 👶Getting started
    • OData Basics
    • IFS Cloud
    • Terminology
    • Useful Applications
    • IFS documentation
      • IFS API Explorer
      • Entity details
    • Setting up the OData connector
      • Configure connection between Flow Server and IFS Cloud
      • Selecting which configurations are visible in Flow Server
  • 👩‍💻Flow Development with OData
    • Architecture
    • Flow development and distribution strategy
    • Implementation
      • Operations in OData machine steps
      • Missing operations
      • Translations
      • Iteration
      • Join data sets
      • Misc Tips and trix
      • Document / Media Library Management
      • Response status handling
        • Errors from IFS
      • Operation specific notes
        • Set input parameters using flow script
        • Update
        • 🛠️WIP - Create
        • Read
    • Configuration
      • Authentication models
        • Setup Client credential flow
        • 🛠️Setup Password credentials flow
        • 🛠️Setup Authorization code flow
        • 🛠️Setup OpenID flow
        • Obtaining Authentication related URLs from IFS Cloud
      • Projection administration
        • Administrating new projections
        • Administrating updated projections
      • Configuring projections in IFS
        • Custom Entities
        • Custom Projections
        • 🛠️WIP - Query Designer
        • Quick Reports
    • Trigger Flows from IFS Cloud
      • Trigger User Flows via External Navigation Links
      • Trigger Machine Flows via BPA using commands
      • 🛠️Trigger Flow via Event Action
    • Debugging and Testing
      • Aurena debugging
        • Inspect in web browser
        • IFS debug console
      • OData Connector Log
  • 🪄Advanced
    • Custom Request
    • C# usage in the OData connector
      • Different methods
      • Building request
      • 🛠️WIP - Code examples
Powered by GitBook
On this page

Was this helpful?

  1. Getting started
  2. IFS documentation

IFS API Explorer

PreviousIFS documentationNextEntity details

Last updated 2 years ago

Was this helpful?

The API Explorer is well documented in the IFS Documentation. You can find it here via the link below. This page will summarize the key elements of the API Explorer.

Read detailed configuration instructions from , search for Api Explorer.

Navigate to the API Explorer by searching in the navigator.

By clicking on the three dots ( ) you can navigate to the projection Specification and Documentation . The Specification describes the projection, the contract. Using the Specification it's possible to generate clients. e.g. request collections in Postman or the machine step operations in the OData connector. The Documentation shows all the details of the Projection with all Operations, filters parameters, payloads, responses etc.

👶
IFS documentation
Navigate to the API Explorer