Overview
This node interacts with the "Mes-Démarches" API of French Polynesia to retrieve detailed information about administrative files ("dossiers"). Specifically, the "Consulter Un Dossier" operation fetches comprehensive data for a single dossier identified by its dossier number. This includes optional details such as form fields, annotations, treatment history, instructors, messages, opinions, corrections, and geographic data.
Use cases include:
- Automating retrieval of dossier details for case management systems.
- Integrating dossier data into databases or spreadsheets for reporting.
- Monitoring dossier status and associated communications programmatically.
For example, you can input a dossier number to get all related information including private annotations and messaging history, which helps in tracking dossier progress or auditing.
Properties
| Name | Meaning |
|---|---|
| Numéro De Dossier | The unique numeric identifier of the dossier to consult (required). |
| Format Des Attributs | Format of attribute labels: - Libellés Originaux (Original labels as entered, recommended for Baserow) - Format Technique (Snake_case conversion of labels) |
| Inclure Les Champs | Whether to include form field values in the output (boolean). |
| Inclure Les Annotations | Whether to include private annotations related to the dossier (boolean). |
| Inclure Les Traitements | Whether to include the treatment history of the dossier (boolean). |
| Inclure Les Instructeurs | Whether to include the list of instructors involved with the dossier (boolean). |
| Inclure Les Messages | Whether to include file messaging history (boolean). |
| Inclure Les Avis | Whether to include opinions related to the dossier (boolean). |
| Inclure Les Corrections | Whether to include pending corrections on the dossier (boolean). |
| Inclure La Géométrie | Whether to include geographic data related to the dossier (boolean). |
Output
The node outputs a JSON object representing the dossier's complete information structured as follows:
- All original dossier properties are included.
- Fields (
champs): Converted into an object where keys are attribute labels formatted per the selected attribute format, and values are the corresponding string or raw values. - Annotations: Similarly converted into an object keyed by formatted annotation labels.
- Other included sections depend on the boolean flags set in the input properties (e.g., treatments, instructors, messages, opinions, corrections, geometry).
No binary data is output by this operation.
Example snippet of output JSON structure:
{
"id": "...",
"number": 456,
"state": "...",
"champs": {
"field_label_1": "value1",
"field_label_2": "value2"
},
"annotations": {
"annotation_label_1": "note1"
},
"traitements": [...],
"instructeurs": [...],
"messages": [...],
"avis": [...],
"corrections": [...],
"geometry": {...}
}
Dependencies
- Requires an API key credential for authenticating with the Mes-Démarches API.
- The node makes GraphQL POST requests to the configured Mes-Démarches server endpoint.
- Proper configuration of the API token and server URL in the node credentials is necessary.
Troubleshooting
Error: "Dossier [number] non trouvé ou non accessible"
Means the dossier number provided does not exist or the API user lacks access rights. Verify the dossier number and API permissions.GraphQL errors may occur if the request parameters are invalid or the API service is down. Check the error message for details.
Empty or incomplete data might result from disabling some inclusion flags (e.g., not including fields or annotations). Adjust input properties accordingly.
Ensure the API token is valid and has not expired; otherwise, authentication will fail.
Links and References
- Mes-Démarches API Documentation (replace with actual URL if available)
- n8n documentation on Creating Custom Nodes
- General GraphQL API usage guidelines
This summary is based solely on static analysis of the provided source code and property definitions.