Pular para o conteúdo principal

getFormsByPageUrl

Recebendo objetos para um formulário relacionado pela URL da página.

Descrição​

Obtém objetos PositionForm para um formulário relacionado pela URL. Retorna uma Promise que resolve para um array de objetos IPositionForm.

Páginas.getFormsByPageUrl(

url*, langCode

);

Esquema de parâmetros​

Esquema

url:* string
URL da página
exemplo: shop

langCode: string
código do idioma
exemplo: en_US

Exemplos​

Exemplo mínimo​

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

Exemplo com atributos​

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

Exemplo de resposta​

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

Esquema de resposta​

Esquema: IPositionForm[]

id: number
identificador do objeto
exemplo: 1764

version number
número da versão do objeto
exemplo: 10

identifier: string
identificador de texto para o campo do registro
exemplo: catalog

attributeSetId: number
identificador do conjunto de atributos
exemplo: 7

processingType: string
tipo de processamento do formulário
exemplo: email
Enum: [ db, email, script ]

localizeInfos: Record<string, any>
descrição em json do objeto de dados da página principal levando em consideração o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

processingData:
dados do formulário

attributes: Record<string, string>
array de valores de atributos do conjunto de atributos utilizado para exibir o formulário (levando em consideração o idioma especificado)
exemplo:

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

position: number
número da posição para ordenação (opcional)
exemplo: 192