Aller au contenu principal

getFormsDataByMarker

Recherche de données de formulaire par identifiant textuel (marqueur).

Description​

Cette méthode récupère un objet de données de formulaire spécifique par son marqueur depuis l'API. Elle accepte un paramètre marqueur en tant que marqueur des données de formulaire. Elle renvoie une promesse qui se résout en un tableau d'objets de type FormDataEntity.

FormData.getFormsDataByMarker(

marker, formModuleConfigId, body, isNested, langCode, offset, limit

);

Schéma des paramètres​

Schéma

marker(obligatoire): string
Marqueur du formulaire
exemple : "contact_form"

formModuleConfigId(obligatoire): number
ID de configuration du module de formulaire
exemple : 4

body: object
Corps de la requête
exemple :

{
  "entityIdentifier": "test",
  "userIdentifier": "",
  "status": "",
  "dateFrom": "2025-08-11",
  "dateTo": ""
}

isNested: any
Indicateur pour obtenir des données hiérarchiques
exemple : 1

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset: number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Exemples​

Exemple minimal​

const response = await FormData.getFormsDataByMarker('my-marker');

Exemple avec des attributs​

const response = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30);

Exemple de réponse​

{
  "items": [
    {
      "id": 42,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:17.458Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 43,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 44,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:52:00.625Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    "..."
  ],
  "total": 213
}

Schéma de réponse​

Schéma : IFormsDataEntity

items: IFormByMarkerDataEntity[]
Tableau d'objets de données de formulaire.
exemple :

  [
    {
      "id": 43,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    }
  ]

total: number
Nombre total d'enregistrements trouvés.
exemple : 100