Aller au contenu principal

getFormsByPageUrl

Recevoir des objets pour un formulaire associé par l'URL de la page.

Description​

Obtenez des objets PositionForm pour un formulaire associé par URL. Renvoie un tableau d'objets PositionForm.

Pages.getFormsByPageUrl( url*, langCode );

Schéma des paramètres​

Schéma

url:* string
URL de la page
exemple : shop

langCode: string
code de langue
exemple : en_US

Exemples​

Exemple minimal​

const response = await Pages.getFormsByPageUrl('shop');

Exemple avec des attributs​

const response = await Pages.getFormsByPageUrl('shop', 'en_US');

Exemple de réponse​

[
  {
    "id": 1764,
    "version": 10,
    "identifier": "catalog",
    "attributeSetId": 0,
    "processingType": "email",
    "localizeInfos": {
      "title": "Mon formulaire",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "processingData": {},
    "position": 0,
    "attributes": [
      {
        "type": "list",
        "marker": "list_marker",
        "position": 2,
        "listTitles": [
          {
            "title": "rouge",
            "value": 1,
            "position": 1,
            "extendedValue": null,
            "extendedValueType": null
          },
          {
            "title": "jaune",
            "value": 2,
            "position": 2,
            "extendedValue": null,
            "extendedValueType": null
          }
        ],
        "validators": {},
        "localizeInfos": {
          "title": "l1"
        }
      }
    ]
  }
]

Schéma de réponse​

Schéma : IPositionForm[]

id: number
identifiant de l'objet
exemple : 1764

version number
numéro de version de l'objet
exemple : 10

identifier: string
identifiant textuel pour le champ d'enregistrement
exemple : catalog

attributeSetId: number
identifiant de l'ensemble d'attributs
exemple : 7

processingType: string
type de traitement du formulaire
exemple : email
Enum: [ db, email, script ]

localizeInfos: Record<string, any>
description json de l'objet de données de la page principale tenant compte de la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

processingData:
données du formulaire

attributes: Record<string, string>
tableau des valeurs d'attributs de l'ensemble d'attributs utilisé pour afficher le formulaire (tenant compte de la langue spécifiée)
exemple :

[
  {
    "type": "list",
    "marker": "l1",
    "position": 2,
    "listTitles": [
      {
        "title": "rouge",
        "value": 1,
        "position": 1,
        "extendedValue": null,
        "extendedValueType": null
      },
      {
        "title": "jaune",
        "value": 2,
        "position": 2,
        "extendedValue": null,
        "extendedValueType": null
      }
    ],
    "validators": {},
    "localizeInfos": {
      "title": "l1"
    }
  }
]

position: number
numéro de position pour le tri (optionnel)
exemple : 192