API

Parameter

Description

Select data source

Select API.

API source

Options:

• data analysis service: Call APIs developed in the IoT Platform data service, including common APIs and user APIs. The response serves as the component's data source.

  common APIs refer to the predefined metric APIs and product data APIs of the data service. user APIs refer to the custom service APIs of the data service. For more information, see Data API.

  Important

  • Only data service assets that are associated with a project can be accessed and used in the project's applications and business logic development.

    For more information about how to associate data assets, see Data assets.

  • The Data Service API is limited to 1 query per second (QPS). For more information, see API calls.

• custom API: Call your custom-developed APIs, open APIs, or third-party APIs. The response serves as the component's data source.

  Important

  A custom API must meet the following requirements:

  • If you set request parameters, the data must be in JSON format.

  • The API response must be in JSON format.

  • Custom API calls time out after 10 seconds.

  Supported JSON data formats include:

  • Object: {}

  • Array: []

  • String: "test"

  • Number: 123

  • Boolean: true, false

• business logic development: Call service APIs developed in the current project by using the business logic development console. The response serves as the component's data source.

  Important

  If a data analysis node is used in the business service, the service API is limited to 1 QPS. For more information, see Data analysis.

• product and thing management: Call APIs to query product lists, product properties, thing details, or the total number of things. The response serves as the component's data source.

Request method

Select the request method for the custom API. Options: get, post.

This parameter appears when you select custom API as the API source.

Request URL

Enter the request URL for your custom API.

This parameter appears when you select custom API as the API source.

Select API

Select the API to call.

This parameter appears when you select data analysis service, business logic development, or product and thing management as the API source.

Request parameters

Options:

• static parameter: In the input box below, enter the request parameter as key-value pairs in standard JSON format.

• dynamic parameter: Add request parameters below by setting keys and values.

  Auto-update: The data source updates automatically when a parameter changes. If you do not select this option, you can trigger a data source update through an interactive action.

  The parameter value can come from:

  • Page variable: Select an existing page variable in the current application as the parameter value. For more information about how to create and assign values to page variables, see Manage page variables.

  • Component value: Select a configured form component in the current application as the parameter value.

  • URL parameter: Use a parameter from the final published page URL as the request parameter value. This is often used when embedding pages to receive dynamic parameters from a host page, such as using an incoming product model as a request parameter.

  • Logged-in account: If application account authentication is enabled, you can select the logged-in user's account information as a request parameter when configuring a custom API or business logic development API. This allows for customization of the interface or features. For more information, see Account data.

  • From interactive action: Use the data source of a pop-up window configured on the Interaction tab as the request parameter value. For more information, see Open a pop-up container.

    Important

    The From interactive action option is available only for pop-up components.

Response

When you click Validate Data Format or OK, the system writes the response to the Response field.

Data filter script

If selected, you can use JavaScript to process the raw data from the API response to fit the display requirements of charts or text. For more information, see Data filter.

Data table configuration

If selected, you can parse and sort the structured data from the API response or after script processing to determine which data the component displays. For more information, see Data filter.

Processed result

The result after script processing and data table configuration. This result is used directly to display data in the component.

This parameter appears when you select data filter script or Data table configuration.

Save response to page variable

If selected, the API response can be saved as a page variable when the service is called. You can also select an existing page variable to store the response. Click Add Page Variable to manage page variables, including adding, editing, and deleting them.

Scheduled refresh

If selected, specify the interval in seconds for automatically calling the API to get the latest data. This feature is disabled by default.

Operation

Description

Format reference

Click Format reference to view the data formats that the component supports.

Validate data format

Click Validate data format to check if the current data format meets the component's requirements. If the format is valid, a "Validation successful" message appears. If not, a detailed error message is displayed.