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, isExtended, 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": 14,
  "entityparentIdentifier": 167,
  "userIdentifier": "",
  "status": [
    "new",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

isExtended: number
Indicateur pour obtenir des champs supplémentaires
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

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module selon vos besoins dans la section correspondante.

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": 3464,
      "formIdentifier": "test-form",
      "time": "2026-01-07T04:10:50.809Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3447,
      "formIdentifier": "test-form",
      "time": "2026-01-07T02:09:20.987Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3430,
      "formIdentifier": "test-form",
      "time": "2026-01-07T00:05:59.818Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    "..."
  ],
  "total": 518
}

Schéma de réponse

Schéma : IFormsDataEntity

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

[
  {
    "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
  }
]

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

---