API Overview

Updated on 2025-03-21 GMT+08:00

View PDF

Data Modules

You can use data module APIs to query, update, or delete data by record ID. These APIs allow you to both query and add data within an object.

**Table 1** Data module APIs
API	Description
Querying Data by Record ID	Query data by record ID.
Deleting Data by Record ID	Delete data by record ID.
Updating Data by Record ID	Update data by record ID.
Querying Data by Record ID List	Query data by record ID list.
Adding Data to an Object	Add data to an object.
Deleting Data by Record ID List	Delete data by record ID list.
Updating Data by Condition	Update data by condition.
Querying Data by Condition	Query data by condition.
Deleting Data by Condition	Delete data by condition.
Querying the Number of Object Records by Condition	Query the number of object records based on conditions.
Batch Adding or Updating Object Data	Add or update data records in batches. If the request contains id, this API is used to update data. If the request does not contain id, this API is used to add data.

Metadata

You can use metadata APIs to create objects, flows, and creating workflows.

**Table 2** Metadata APIs
API	Description
Creating a Custom Object	Create an object instance.
Querying All Custom Objects	Query all object instances.
Querying a Custom Object Instance by ID	Query an object instance by ID.
Adding a Field to an Object Instance	Add a custom field to an object instance.
Adding a Trigger for an Object Instance	Add a trigger for an object instance.
Adding a Validator for an Object Instance	Add a validator for an object instance.
Adding a Layout for an Object Instance	Add a layout for an object instance.
Querying a Field by field_id	Query a field by field_id.
Querying a Layout by object_id	Query a layout by object_id.
Querying a Layout by layout_id	Query a layout by layout_id.
Querying a Button by object_id	Query a button by object_id.
Querying a Button by button_id	Query a button by button_id.
Querying a Trigger by object_id	Query a trigger by object_id.
Querying a Trigger by trigger_id	Query a trigger by trigger_id.
Querying an Object Verification Rule by object_id	Query a validator by object_id.
Querying a Validator by validator_id	Query a validator by validator_id.
Creating a Flow Instance	Create a flow instance.
Querying Flow Instances	Query flow instances that meet specific conditions.
Querying Input and Output Parameters of a Flow Instance	Query the input and output parameters of a flow instance.
Updating a Flow Instance	Update a flow instance.
Deleting a Flow Instance	Delete a flow instance.
Creating a BPM Instance	Create a BPM instance.
Querying BPM Instances by Condition	Query BPM instances by condition.
Querying a BPM Instance by ID	Query a BPM instance by bpm_id.
Updating a BPM Instance	Update a BPM instance.
Deleting a BPM Instance	Delete a BPM instance.
Creating a Picklist Instance	Create a picklist instance.
Querying Picklist Instances by Condition	Query picklist instances by condition.
Adding Values to a Picklist Instance	Add values to a picklist instance by picklist_id.
Querying a Picklist Instance or Objects That Reference a Picklist Instance	Query a picklist instance or the objects that reference a picklist instance.
Updating a Picklist Instance	Update a picklist instance.
Deleting a Picklist Instance or the Value of a Picklist Instance	Delete a picklist instance or the value of a picklist instance.
Listing All Applications	Query all applications under the current account.
Querying an Application by ID	Query an application based on the application ID.
Querying the Standard Page List	Query the list of standard pages, including only basic information. To obtain the content of a standard page, query the content by ID.
Querying a Standard Page by ID	Query standard pages by view_id.
Querying Application Tabs	Query the list of application tab pages.

Flows

You can use flow APIs to orchestrate flows and view the running flow instances.

**Table 3** Flow APIs
API	Description
Orchestrating a Flow Instance	Orchestrate a flow instance.
Querying a Flow Instance	Query a flow instance

Scripts

You can use script APIs to run, debug, and obtain script signature information.

**Table 4** Script APIs
API	Description
Running a Script	Run a script.
Debugging a Script	Debug a script.
Obtaining Script Signature Information	Obtain signature information of a script.
Obtaining the Built-in Library Declaration of a Script	Obtain the declaration of the built-in library of a script.
Obtaining Formulas of a Flow Instance	Obtain a flow formula.

BPM

You can use business process management (BPM) APIs to start, delete, suspend, resume, and terminate BPM instances.

**Table 5** BPM APIs
API	Description
Starting a BPM Instance	Create and start a BPM instance.
Querying BPM Instances	Obtain information about all BPM instances of the current account.
Suspending, Resuming, or Terminating a BPM Instance	Suspend, resume, or terminate a BPM instance. After a BPM instance is suspended, it will not be displayed in the to-do task list, the SLA timer stops, and no follow-up reminder will be sent. After a BPM instance is resumed, the system proceeds with subsequent operations. After a BPM instance is terminated, the BPM instance is forcibly stopped and you can view the BPM instance only in the historical task list.
Deleting a BPM Instance	Delete a BPM instance. It is recommended that a BPM be deleted only when the administrator needs to clear expired data. In other cases, do not delete BPM instance data.
Setting or Modifying the Values of Variables in a BPM Instance	Modify variable values in a BPM instance, allowing updates to single, multiple, or all variables simultaneously. Nonexistent or read-only variables are ignored.

Import and Export

You can use import and export APIs to import and export data and metadata, enabling data migration.

**Table 6** Import and export APIs
API	Description
Exporting Data	Export specific data of a table. The internal data of the objects created in Huawei Cloud Astro Zero can be exported. This API exports the data of these objects based on the preset period, frequency, and filter criteria.
Importing Data	Import data. The data to be imported should be compressed to a .zip package. Data files in the package must be in .txt or .csv format. In each file, the first row indicates the object to which the data belongs, the second row indicates the field names, and the other rows indicate data records.
Exporting Metadata	Export the metadata of a data table, that is, export the information about each field in the data table, excluding specific data records.
Importing Metadata	Import the metadata of a table. If the metadata of a data table is available, you can quickly create an object table based on the metadata.
Importing Data by Using a Template	Import data by using a template. Before importing data, you need to create a data import template and define data mapping rules in the template. When this API is called, the template name must be specified and the operation script must be defined in the template.

Connectors

You can use the preset connector APIs to upload, download, delete, and list files and directories.

**Table 7** Connector APIs
API	Description
Uploading a File	Upload local files to the storage. By default, files are uploaded to the first bucket set up for the connector.
Downloading a File	Download files from the storage.
Deleting a File	Delete useless files from the storage.
Deleting a Directory	Delete a directory from storage. All files within it will be deleted along with the directory.
Listing Files in a Directory	List files in a directory on the storage.
Uploading Multipart	To upload a large file, multipart upload is recommended. Multipart upload is applicable to many scenarios, including: Files to be uploaded are larger than 100 MB. The network condition is poor, and the connection between the storage server such as OBS is frequently disconnected. Sizes of files to be uploaded are uncertain.
Obtaining endpoint (Prefix of the File Storage Address)	endpoint is the prefix of the file storage address. Combine it with the object's path to get the full access path. In Uploading a File, the path of the uploaded file on the bucket is returned. You can call the API in this section to obtain the endpoint and combine it with the returned path to get the full access path.
Sharing Token	You can call this API (described in Obtaining a Sharing Token) to obtain a temporary token. You can use this temporary token to access the file without using the access-token for authentication.