Paramètres standards
Voici la liste exhaustive des paramètres standards, leur direction (entrée / sortie), et à quoi ils servent.
Les paramètres de sortie sont à retourner via un SELECT.
Les arguments de procédure en mode sortie (OUTPUT) ne sont pas pris en charge.
À propos la requête
Nom | Direction | Type .NET | Format | Type SQL-Server | Description |
---|---|---|---|---|---|
request_content_type | Entrée | string | Type MIME | VARCHAR(255) | Type MIME du corp de la requête, provenant de l'en-tête HTTP Content-Type. |
request_body | Entrée | string | Brut | NVARCHAR(MAX) | Corp de la requête. |
request_form | Input | string | JSON | NVARCHAR(MAX) | Un JSON représentant le formulaire ayant été soumis par l'utilisateur à travers un Content-Type de type form. Quand ce paramètre n'est pas null, request_body l'est. |
request_headers | Entrée | string | JSON | NVARCHAR(MAX) | En-têtes de la requête, dictionnaire clé-valeur. |
request_cookies | Entrée | string | JSON | NVARCHAR(MAX) | Cookie joint à la requête, dictionnaire clé-valeur. |
request_path | Entrée | string | Brut | NVARCHAR(MAX) | Route de la requête. |
query_params | Entrée | string | JSON | NVARCHAR(MAX) | Paramètres de requête (présent après le ? dans l'URI), dictionnaire clé-valeur. |
path_params | Entrée | string | JSON | NVARCHAR(MAX) | Paramètres résolus depuis la route, dictionnaire clé-valeur. |
request_model | Entrée | string | JSON | NVARCHAR(MAX) | Modèle brut géré par SQListe, contenant toutes les informations de la requête. |
error | Entrée | string | JSON | NVARCHAR(MAX) | .Modèle contenant des informations à propos de la dernière erreur survenue. Pour en savoir plus, cf. TODO. |
response_model | Entrée | string | JSON | NVARCHAR(MAX) | Modèle brut géré par SQListe, contenant toutes les informations de la réponse en l'état actuel. |
À propos la réponse
Ces paramètres peuvent-être retourné depuis une procédure via un SELECT, et viendront altérer l'état de la réponse.
Nom | Direction | Type .NET | Format | Type SQL-Server | Description |
---|---|---|---|---|---|
response_content_type | Entrée / Sortie | string | Type MIME | VARCHAR(255) | Type MIME du corp de la réponse, qui sera assignée à l'en-tête HTTP Content-Type si non définie. |
response_body | Entrée / Sortie | string | Brut | NVARCHAR(MAX) | Corp de la réponse. |
response_file | Entrée / Sortie | byte[] | Brut | VARBINARY(MAX) | Le fichier allant être inclus dans la réponse. |
response_file_name | Entrée / Sortie | string | Brut | NVARCHAR(MAX) | Le nom du fichier allant être inclus dans la réponse. |
response_file_inline | Entrée / Sortie | bool | BIT | Vrai si le fichier doit-être ouvert dans la visionneuse du navigateur. | |
response_headers | Entrée / Sortie | string | JSON | NVARCHAR(MAX) | En-têtes de la réponse, dictionnaire clé-valeur. |
response_cookies | Entrée / Sortie | string | JSON | NVARCHAR(MAX) | Cookie joint à la réponse. Pour en savoir plus sur le format : cf. section... TODO |
response_status | Entrée / Sortie | int | Statut HTTP | INT | Code de statut de la réponse. |
Ces paramètres peuvent aussi être pris en argument de procédure.
Cela permet de récupérer l'état actuel de la réponse, ce qui peut être utile après un traitement par intergiciel.
À propos du stockage
Ces paramètres peuvent-être pris en arguments de procédure, ainsi que retourné pour altérer l'état.
Nom | Direction | Type .NET | Format | Type SQL-Server | Description |
---|---|---|---|---|---|
request_storage | Entrée / Sortie | string | JSON* | NVARCHAR(MAX) | Stockage ayant une durée de vie d'une requête. Il est initialisé à un objet JSON vide au début d'une requête ('{}'). |
session | Entrée / Sortie | string | JSON* | NVARCHAR(MAX) | Accès à la session HTTP. Pour en savoir plus : TODO. |
JSON* : Bien que le contenu soit initialisé avec un JSON vide ('{}') par défaut, il peut néanmoins être changé de manière sûre étant donné que ce contenu ne fait pas l'objet d'un traitement de la part de SQListe.
Paramètres spécifiques aux intergiciels
Ces paramètres peuvent-être pris en arguments de procédure, ainsi que retourné pour altérer l'état.
Nom | Direction | Type .NET | Format | Type SQL-Server | Description |
---|---|---|---|---|---|
next | Sortie | bool | BIT | Si retourné à 0, interromp la pipeline de requête. Est égal à 1 par défaut. |