getAllForms
Obtenha todos os objetos de formulário.
Descrição
Este método recupera todos os objetos de formulário com paginação. Ele retorna uma Promise que resolve para um objeto IFormsResponse contendo itens e contagem total.
Forms.getAllForms(
langCode,
offset,
limit
);
Esquema de parâmetros
Esquema
langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"
offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0
limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30
Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.
Exemplos
Experimente ao vivo
Execute este método interativamente no sandbox do JS SDK — conecte sua URL do Projeto e Token do App na primeira visita, depois abra:
- Obter todos os formulários — recupere todos os formulários configurados no projeto.
Exemplo mínimo
const response = await Forms.getAllForms();
Exemplo com atributos
const response = await Forms.getAllForms('en_US', 0, 30);
Exemplo de resposta
{
"items": [
{
"id": 4,
"attributeSetId": 11,
"type": "data",
"localizeInfos": {
"title": "user_form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 9,
"position": 1,
"identifier": "user_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name_attr",
"isLogin": false,
"isSignUp": false,
"position": 1,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "name"
},
"additionalFields": {},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
{
"type": "string",
"marker": "username",
"isLogin": true,
"isSignUp": false,
"position": 2,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "username"
},
"additionalFields": {},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
{
"type": "string",
"marker": "password",
"isLogin": false,
"isSignUp": false,
"position": 3,
"settings": {},
"isVisible": true,
"isPassword": true,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "password"
},
"additionalFields": {},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
"..."
]
},
{
"id": 6,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "Test form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 14,
"position": 2,
"identifier": "test-form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"isLogin": false,
"isSignUp": false,
"position": 1,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data",
"marker": "additional_field"
}
},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
{
"type": "file",
"marker": "file",
"isLogin": false,
"isSignUp": false,
"position": 2,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
}
]
},
{
"id": 7,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "File form",
"titleForSite": "Form title (for application)",
"successMessage": "Message about successful data processing",
"unsuccessMessage": "Message about unsuccessful data processing",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 15,
"position": 3,
"identifier": "file_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"isLogin": false,
"isSignUp": false,
"position": 1,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data",
"marker": "additional_field"
}
},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
},
{
"type": "file",
"marker": "file",
"isLogin": false,
"isSignUp": false,
"position": 2,
"settings": {},
"isVisible": true,
"isPassword": false,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {},
"isSignUpRequired": false,
"isNotificationEmail": false,
"isNotificationPhoneSMS": false,
"isNotificationPhonePush": false
}
]
},
"..."
],
"total": 9
}
Esquema de resposta
Esquema: IFormsEntity[]
total: number
Contagem total de itens.
items: IFormsEntity[]
Array de entidades de formulário.
items.id: number
O identificador do objeto.
exemplo: 12345
items.attributeSetId: number | null
O identificador do conjunto de atributos sendo usado, ou null se não aplicável.
exemplo: 1234
items.type: string | null
Tipo de formulário.
exemplo: "contato"
items.localizeInfos: IFormLocalizeInfo
O nome do formulário e campos de localização do lado do formulário (mensagens de sucesso/erro, configuração de processamento, etc.).
exemplo:
{
"key": "value"
}
items.version: number
O número da versão do objeto.
exemplo: 1
items.position: number
A posição do objeto.
exemplo: 1
items.identifier: string
O identificador textual para o campo de registro.
exemplo: "form_contact_us"
items.processingType: string
Tipo de processamento do formulário.
exemplo: "assíncrono"
items.templateId: number | null
O identificador do template usado pelo formulário, ou null se nenhum template for usado.
exemplo: 6789
items.attributes: IFormAttribute[]
Campos do formulário com sua localização, validadores e flags específicas do formulário.
attributes.marker: string
Marcador do campo (nome da máquina).
exemplo: "email"
attributes.type: AttributeType
Tipo de dado do atributo (por exemplo, "string", "file").
attributes.position: number
Posição de ordenação do campo.
exemplo: 1
attributes.isVisible: boolean
Se o campo é exposto ao usuário.
exemplo: true
attributes.localizeInfos: IAttributeLocalizeInfo
Rótulos localizados para o campo. Para atributos timeInterval, também carrega a carga útil do cronograma intervals.
attributes.initialValue: unknown
Valor padrão aplicado quando o campo não é preenchido.
attributes.listTitles: IListTitle[]
Opções predefinidas para campos list/radioButton; array vazio para outros tipos.
listTitles.title: string
O título ou nome associado ao item da lista.
exemplo: "Nome do Item"
listTitles.value: number | string
O valor do item da lista, que pode ser um número ou uma string dependendo do contexto.
exemplo: 42
listTitles.position: string | number | null
A posição do item da lista, que pode ser representada como uma string, número ou null se não aplicável.
exemplo: 1
listTitles.extended: object
Um objeto contendo propriedades ou metadados adicionais relacionados ao item da lista. Isso pode incluir quaisquer detalhes extras que ampliem as informações básicas.
listTitles.extended.value: string | null
O valor estendido, que pode ser uma string ou null.
exemplo: "valor_extra"
listTitles.extended.type: string | null
O tipo do valor estendido, que pode ser uma string ou null.
exemplo: "cor"
attributes.validators: IAttributeValidators
Regras de validação; objeto vazio quando nenhum validador está configurado.
validators.requiredValidator: object
Marca o campo como obrigatório. Forma: { strict: boolean }.
exemplo: { strict: true }
validators.stringInspectionValidator: object
Restrições de comprimento para campos de string. Forma: { stringMin: number; stringMax: number; stringLength: number }.
validators.emailInspectionValidator: boolean
Alterna a validação de formato de email.
validators.defaultValueValidator: object
Configuração de valor padrão com texto de erro personalizado opcional. Forma: { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.
attributes.settings: Record<string, unknown>
Configuração específica do campo; objeto vazio por padrão.
attributes.additionalFields: Record<string, IFormAttributeAdditionalField>
Subcampos aninhados indexados por marcador; objeto vazio quando nenhum.
attributes.isLogin: boolean
Se este campo carrega o valor de login usado para autenticação.
exemplo: false
attributes.isSignUp: boolean
Se este campo é obrigatório durante o cadastro.
exemplo: false
attributes.isNotificationEmail: boolean
Se este campo armazena o email usado para notificações.
exemplo: false
attributes.isNotificationPhonePush: boolean
Se este campo armazena o número de telefone usado para notificações push.
exemplo: false
attributes.isNotificationPhoneSMS: boolean
Se este campo armazena o número de telefone usado para notificações SMS.
exemplo: false
items.total: number | string
Contagem total de entradas relacionadas.
exemplo: "1"
items.moduleFormConfigs: IFormConfig[]
Array de configurações de formulário do módulo associadas ao formulário.
moduleFormConfigs.id: number
O identificador da configuração do formulário.
exemplo: 123
moduleFormConfigs.formIdentifier: string
O identificador do formulário (apenas na API de produtos/páginas).
exemplo: "review"
moduleFormConfigs.moduleIdentifier: string
O identificador do módulo associado à configuração do formulário.
exemplo: "module_identifier"
moduleFormConfigs.isGlobal: boolean
Indica se a configuração do formulário é global.
exemplo: true
moduleFormConfigs.isClosed: boolean
Indica se a configuração do formulário está fechada.
exemplo: true
moduleFormConfigs.isModerate: boolean
Indica se o formulário requer moderação (apenas na API de produtos/páginas).
exemplo: false
moduleFormConfigs.viewOnlyUserData: boolean
Indica se a configuração do formulário permite visualizar dados do usuário (usado na API de formulários).
exemplo: true
moduleFormConfigs.commentOnlyUserData: boolean
Indica se a configuração do formulário permite comentar sobre dados do usuário (usado na API de formulários).
exemplo: true
moduleFormConfigs.viewOnlyMyData: boolean
Indica se a configuração do formulário permite visualizar meus dados (usado na API de produtos/páginas).
exemplo: false
moduleFormConfigs.commentOnlyMyData: boolean
Indica se a configuração do formulário permite comentar sobre meus dados (usado na API de produtos/páginas).
exemplo: false
moduleFormConfigs.entityIdentifiers: object[]
Um array de identificadores de entidades associadas à configuração do formulário.
moduleFormConfigs.nestedEntityIdentifiers: string[]
Um array de strings de identificadores de entidades aninhadas (apenas na API de produtos/páginas).
exemplo: ["catalog"]
moduleFormConfigs.exceptionIds: string[]
Um array de identificadores de exceção.
moduleFormConfigs.formDataCount: number
Contagem total de entradas de dados do formulário (apenas na API de produtos/páginas).
exemplo: 306
moduleFormConfigs.entityFormDataCount: Record<string, number>
Contagem de dados do formulário por identificador de entidade (apenas na API de produtos/páginas).
exemplo: {"catalog": 306}
moduleFormConfigs.isRating: boolean | null
Indica se esta configuração de formulário é para avaliações.
exemplo: null
moduleFormConfigs.isAnonymous: boolean | null
Indica se envios anônimos são permitidos.
exemplo: null
moduleFormConfigs.allowHalfRatings: boolean | null
Indica se avaliações parciais são permitidas.
exemplo: null
moduleFormConfigs.allowRerating: boolean | null
Indica se reavaliações são permitidas.
exemplo: null
moduleFormConfigs.maxRatingScale: number | null
Valor máximo da escala de avaliação.
exemplo: 5
moduleFormConfigs.ratingCalculation: string
Método de cálculo da avaliação.
exemplo: "média"