Skip to content

Commit 59320e5

Browse files
authored
docs: update request body instruction (#391)
1 parent f560079 commit 59320e5

4 files changed

Lines changed: 100 additions & 21 deletions

File tree

  • docs

docs/en-US/handbook/workflow-request/index.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,32 @@ Define key-value pairs for the query string. Values can dynamically utilize vari
4848

4949
**Request Body**
5050

51-
Currently, the request body supports only standard JSON format. Use the variable button in the upper-right corner of the text editor to insert context variables.
51+
Depends on the `Content-Type` option, different formats are supported.
52+
53+
##### application/json
54+
55+
Standard JSON format text is supported. Use the variable button in the upper-right corner of the text editor to insert context variables.
5256

5357
:::info{title=Note}
5458
Ensure that variables within JSON are used as strings, for example: `"a": "{{$context.data.a}}"`.
5559
:::
5660

61+
##### application/x-www-form-urlencoded
62+
63+
This format supports standard key-value pairs. The variable button in the text editor can also be used to insert context variables.
64+
65+
##### application/xml
66+
67+
Supports standard XML format text. Similar to JSON, you can use the variable button to insert context variables.
68+
69+
##### multipart/form-data
70+
71+
Supports `multipart/form-data` format for key-value pairs. When selecting a data type as a file object, you can upload files. Files can only be selected from existing file objects in the context, such as results from file collection queries or related data from associated file collection.
72+
73+
:::info{title=Note}
74+
When selecting file data, ensure that the variable corresponds to a single file object, not a list of files (in many-to-one relationships, the relationship field's value will be an array).
75+
:::
76+
5777
**Timeout Settings**
5878

5979
If the request takes too long to respond, the timeout setting will cancel it, leading to the premature termination of the current workflow with a failure status.

docs/fr-FR/handbook/workflow-request/index.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,81 @@
1-
### Requêtes HTTP
1+
# Requêtes HTTP
22

33
Lorsqu'il est nécessaire d'interagir avec un autre système web, le nœud **Requête HTTP** est l'outil idéal. Ce nœud vous permet d'envoyer une requête HTTP à une adresse spécifiée, accompagnée de données dans les formats JSON ou `application/x-www-form-urlencoded`, facilitant ainsi la communication avec des systèmes externes.
44

55
Si vous êtes déjà familier avec des outils comme Postman, maîtriser le nœud Requête HTTP sera un jeu d'enfant. Cependant, contrairement aux outils traditionnels, ce nœud exploite des variables de contexte du workflow actuel, ce qui en fait un ajout puissant à l'intégration de votre processus métier.
66

7-
### Installation
7+
## Installation
88

99
Il s'agit d'un plugin intégré, il n'est donc pas nécessaire de procéder à une installation.
1010

11-
### Guide de l'Utilisateur
11+
## Guide de l'Utilisateur
1212

13-
#### Création d'un Nœud
13+
### Création d'un Nœud
1414

1515
Dans l'interface de configuration du workflow, cliquez sur le bouton plus ("+") pour ajouter un nœud "Requête HTTP" au processus :
1616

1717
![Requête HTTP_Ajouter](https://static-docs.nocobase.com/46f2a6fc3f6869c80f8fbd362a54e644.png)
1818

19-
#### Configuration du Nœud
19+
### Configuration du Nœud
2020

2121
![Configuration du Nœud Requête HTTP](https://static-docs.nocobase.com/2fcb29af66b892fa704add52e2974a52.png)
2222

23-
**Méthode de Requête**
23+
#### Méthode de Requête
2424

2525
Choisissez parmi les méthodes de requête HTTP disponibles : `GET`, `POST`, `PUT`, `PATCH`, et `DELETE`.
2626

27-
**URL de Requête**
27+
#### URL de Requête
2828

2929
Indiquez l'URL du service HTTP, y compris le protocole (`http://` ou `https://`). Pour des raisons de sécurité, il est recommandé d'utiliser `https://`.
3030

31-
**Format des Données de Requête**
31+
#### Format des Données de Requête
3232

3333
Cela définit le `Content-Type` dans l'en-tête de la requête, avec les options `application/json` et `application/x-www-form-urlencoded`.
3434

35-
**Configuration des En-têtes de Requête**
35+
#### Configuration des En-têtes de Requête
3636

3737
Définissez des paires clé-valeur pour les en-têtes de la requête, avec des valeurs qui peuvent faire référence dynamiquement aux variables du contexte du workflow.
3838

3939
:::info{title=Note}
4040
L'en-tête `Content-Type` est prédéfini par le paramètre de format des données de la requête. La saisie manuelle ici ne remplacera pas cette configuration.
4141
:::
4242

43-
**Paramètres de Requête**
43+
#### Paramètres de Requête
4444

4545
Définissez des paires clé-valeur pour la chaîne de requête. Les valeurs peuvent utiliser dynamiquement des variables du contexte du workflow.
46+
#### Corps de la requête
4647

47-
**Corps de la Requête**
48+
La partie Body de la requête prend en charge différents formats selon le `Content-Type` sélectionné.
4849

49-
Actuellement, le corps de la requête prend uniquement en charge le format JSON standard. Utilisez le bouton de variable dans le coin supérieur droit de l'éditeur de texte pour insérer des variables de contexte.
50+
##### application/json
5051

51-
:::info{title=Note}
52-
Assurez-vous que les variables dans le JSON soient utilisées sous forme de chaînes, par exemple : `"a": "{{$context.data.a}}"`.
52+
Prend en charge le format texte JSON standard. Vous pouvez insérer des variables du contexte du flux à l'aide du bouton de variable situé en haut à droite de la zone d'édition de texte.
53+
54+
:::info{title=Astuce}
55+
Les variables doivent être utilisées à l'intérieur d'une chaîne JSON, par exemple : `"a": "{{$context.data.a}}"`.
56+
:::
57+
58+
##### application/x-www-form-urlencoded
59+
60+
Prend en charge le format `application/x-www-form-urlencoded` sous forme de paires clé-valeur. La valeur peut contenir des variables du contexte du flux, qui seront interprétées comme un modèle de chaîne et concaténées pour former la valeur finale.
61+
62+
##### application/xml
63+
64+
Prend en charge le format texte XML standard. Vous pouvez insérer des variables du contexte du flux à l'aide du bouton de variable situé en haut à droite de la zone d'édition de texte.
65+
66+
##### multipart/form-data <Badge>v1.8.0+</Badge>
67+
68+
Prend en charge les données de formulaire au format `multipart/form-data` sous forme de paires clé-valeur. Si le type de données est défini sur "objet fichier", il est possible de téléverser un fichier. Le fichier doit être sélectionné via une variable pointant vers un objet fichier existant dans le contexte, comme un résultat de requête sur une table de fichiers ou une relation avec une table de fichiers.
69+
70+
:::info{title=Astuce}
71+
Lorsque vous sélectionnez un fichier, assurez-vous que la variable correspond à un **objet fichier unique**, et non à une **liste de fichiers** (dans le cas d'une relation multiple, le champ relationnel sera un tableau).
5372
:::
5473

55-
**Paramètres de Délai d'Attente**
74+
#### Paramètres de Délai d'Attente
5675

5776
Si la requête prend trop de temps pour répondre, le paramètre de délai d'attente l'annulera, ce qui entraînera la terminaison prématurée du workflow actuel avec un état d'échec.
5877

59-
**Ignorer l'Échec**
78+
#### Ignorer l'Échec
6079

6180
Le nœud de requête considère tout code d'état HTTP entre `200` et `299` comme un succès. Les codes en dehors de cette plage sont considérés comme des échecs. Si vous sélectionnez l'option "Ignorer les requêtes échouées et continuer le workflow", le workflow poursuivra les nœuds suivants, même si la requête échoue.
6281

docs/ja-JP/handbook/workflow-request/index.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,30 @@ HTTPサービスのURLで、プロトコル部分(`http://`または`https://`
4848

4949
#### リクエストボディ
5050

51-
リクエストのボディ部分は、現在標準のJSON形式のみをサポートしています。テキストエディタの右上隅にある変数ボタンを使用して、プロセスコンテキストの変数を挿入できます。
51+
リクエストの Body 部分は、`Content-Type` の選択に応じて、さまざまな形式をサポートします。
52+
53+
##### application/json
54+
55+
標準的な JSON 形式のテキストをサポートしており、テキスト編集ボックスの右上にある変数ボタンから、フローのコンテキスト変数を挿入できます。
56+
57+
:::info{title=ヒント}
58+
変数は JSON の文字列内で使用する必要があります。例:`"a": "{{$context.data.a}}"`
59+
:::
60+
61+
##### application/x-www-form-urlencoded
62+
63+
`application/x-www-form-urlencoded` 形式のキーと値のペアをサポートしており、値にはフローコンテキストの変数を使用できます。変数が含まれる場合、それは文字列テンプレートとして解釈され、最終的な文字列に連結されます。
64+
65+
##### application/xml
66+
67+
標準的な XML 形式のテキストをサポートしており、テキスト編集ボックスの右上にある変数ボタンから、フローのコンテキスト変数を挿入できます。
68+
69+
##### multipart/form-data <Badge>v1.8.0+</Badge>
70+
71+
`multipart/form-data` 形式のキーと値のペアのフォームデータをサポートしています。データタイプにファイルオブジェクトを選択すると、ファイルのアップロードが可能です。ファイルは、コンテキスト内にすでに存在するファイルオブジェクト(ファイルテーブルのクエリ結果や、関連ファイルテーブルのリレーションデータ)を変数で指定する必要があります。
5272

5373
:::info{title=ヒント}
54-
注:変数はJSONの文字列の中で使用する必要があります。例:`"a": "{{$context.data.a}}"`
74+
ファイルデータを選択する場合、変数が単一のファイルオブジェクトを指していることを確認してください。複数ファイルの関係(多対多)のクエリでは、リレーションフィールドの値は配列になります
5575
:::
5676

5777
#### タイムアウト設定

docs/zh-CN/handbook/workflow-request/index.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,30 @@ HTTP 服务的 URL,需要包含协议部分(`http://` 或 `https://`),
4848

4949
#### 请求体
5050

51-
请求的 Body 部分,目前仅支持标准的 JSON 格式,可以通过文本编辑框右上角的变量按钮插入流程上下文中的变量。
51+
请求的 Body 部分,根据 `Content-Type` 选择的不同,支持不同的格式。
52+
53+
##### application/json
54+
55+
支持标准的 JSON 格式的文本,可以通过文本编辑框右上角的变量按钮插入流程上下文中的变量。
56+
57+
:::info{title=提示}
58+
变量必须在 JSON 的字符串中使用,例如:`"a": "{{$context.data.a}}"`
59+
:::
60+
61+
##### application/x-www-form-urlencoded
62+
63+
支持 `application/x-www-form-urlencoded` 格式的键值对,值可以使用流程上下文中的变量,包含变量时会作为字符串模板解析并拼接为最终的字符串值。
64+
65+
##### application/xml
66+
67+
支持标准的 XML 格式的文本,可以通过文本编辑框右上角的变量按钮插入流程上下文中的变量。
68+
69+
##### multipart/form-data <Badge>v1.8.0+</Badge>
70+
71+
支持 `multipart/form-data` 格式的键值对表单数据,数据类型选择文件对象时可以上传文件。文件仅能通过变量选择上下文中已存在的文件对象,如对文件表查询的结果,或关联文件表的关系数据。
5272

5373
:::info{title=提示}
54-
注:变量必须在 JSON 的字符串中使用,例如:`"a": "{{$context.data.a}}"`
74+
选择文件数据时,需要确保变量对应的是单个文件对象,而不是一个文件列表(在对多关系查询时,关系字段的值会是一个数组)
5575
:::
5676

5777
#### 超时设置

0 commit comments

Comments
 (0)