Formulários de Assuntos dos Veteranos (Editor Independente) (Versão prévia)
Acesse a API de Va Forms para pesquisar, recuperar links PDF e metadados para formulários va, incluindo o acompanhamento de versão. Mantenha-se atualizado com as informações mais recentes do formulário va, pesquise por número de formulário ou palavra-chave, obtenha metadados detalhados e muito mais. Autenticar usando um token de API. Teste no ambiente de área restrita antes de solicitar uma chave de API de produção. Acompanhe o histórico de revisão SHA256 para garantir a integridade dos dados e validar links PDF. Identifique formulários excluídos por meio de metadados.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Richard Wilson |
| URL | https://www.richardawilson.com/ |
| richard.a.wilson@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Richard Wilson |
| Site | https://developer.va.gov/explore/api/va-facilities |
| Política de privacidade | https://department.va.gov/privacy/ |
| Categorias | Recursos Humanos |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API va | secureString | A chave da API va para esta api | Verdade |
| Ambiente | cadeia | O ambiente de API de VA a ser usado (Produção ou Área Restrita) | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Formulários de lista |
Recupere todos os formulários de VA disponíveis. Opcionalmente, filtre por número de formulário ou título. |
| Obter formulário por nome |
Recuperar um único formulário e seu histórico de revisão completo |
Formulários de lista
Recupere todos os formulários de VA disponíveis. Opcionalmente, filtre por número de formulário ou título.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Query
|
query | string |
Recupere dados do formulário com base no nome do formulário inserido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of FormsIndex |
Obter formulário por nome
Recuperar um único formulário e seu histórico de revisão completo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Formulário
|
form_name | True | string |
O nome do formulário va do formulário que está sendo solicitado. Inclua prefixos e hifens quando necessário. |
Retornos
Dados para um formulário de VA específico, incluindo o histórico de versão do formulário.
- Corpo
- FormShow
Definições
FormsIndex
Uma listagem de formulários de VA disponíveis e sua localização.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificador da API JSON |
|
Tipo
|
type | string |
Especificação de tipo de API JSON |
|
Nome do Formulário
|
attributes.form_name | string |
Nome do formulário va |
|
URL
|
attributes.url | string |
Local da Web do formulário |
|
Title
|
attributes.title | string |
Título do formulário, conforme dado pelo VA |
|
Primeiro emitido em
|
attributes.first_issued_on | date |
A data em que o formulário se tornou disponível pela primeira vez |
|
Última revisão ativada
|
attributes.last_revision_on | date |
A data em que o formulário foi atualizado pela última vez |
|
Páginas
|
attributes.pages | integer |
Número de páginas contidas no formulário |
|
Sha256
|
attributes.sha256 | string |
Um hash sha256 do conteúdo do formulário |
|
Última alteração sha256
|
attributes.last_sha256_change | date |
A data da última alteração de hash sha256 |
|
Pdf válido
|
attributes.valid_pdf | boolean |
Um sinalizador que indica se a URL do formulário foi confirmada como um download válido |
|
Uso do Formulário
|
attributes.form_usage | string |
Uma descrição de como o formulário deve ser usado |
|
Introdução à Ferramenta de Formulário
|
attributes.form_tool_intro | string |
Texto introdutório que descreve a ferramenta online va para este formulário |
|
URL da Ferramenta de Formulário
|
attributes.form_tool_url | string |
Local da ferramenta online para este formulário |
|
URL de Detalhes do Formulário
|
attributes.form_details_url | string |
Local no www.va.gov da página de informações para este formulário |
|
Tipo de formulário
|
attributes.form_type | string |
Tipo de VA do formulário |
|
Linguagem
|
attributes.language | string |
Código de idioma do formulário |
|
Excluído em
|
attributes.deleted_at | date-time |
O carimbo de data/hora no qual o formulário foi excluído |
|
Formulários relacionados
|
attributes.related_forms | array of string |
Uma listagem de outros formulários relacionados ao formulário atual |
|
Categorias de benefícios
|
attributes.benefit_categories | array of object |
Listagem de categorias de benefícios e correspondência |
|
Nome
|
attributes.benefit_categories.name | string |
Nome da categoria de benefício do formulário |
|
Description
|
attributes.benefit_categories.description | string |
Descrição da categoria de benefício do formulário |
|
Administração de Formulário de VA
|
attributes.va_form_administration | string |
A organização va que administra o formulário |
FormShow
Dados para um formulário de VA específico, incluindo o histórico de versão do formulário.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificador da API JSON |
|
Tipo
|
type | string |
Especificação de tipo de API JSON |
|
Nome do Formulário
|
attributes.form_name | string |
Nome do formulário va |
|
URL
|
attributes.url | string |
Local da Web do formulário |
|
Title
|
attributes.title | string |
Título do formulário, conforme dado pelo VA |
|
Primeiro emitido em
|
attributes.first_issued_on | date |
A data em que o formulário se tornou disponível pela primeira vez |
|
Última revisão ativada
|
attributes.last_revision_on | date |
A data em que o formulário foi atualizado pela última vez |
|
Criado em
|
attributes.created_at | date-time |
Campo interno para uso VA.gov |
|
Páginas
|
attributes.pages | integer |
Número de páginas contidas no formulário |
|
Sha256
|
attributes.sha256 | string |
Um hash sha256 do conteúdo do formulário |
|
Pdf válido
|
attributes.valid_pdf | boolean |
Um sinalizador que indica se a URL do formulário foi confirmada como um download válido |
|
Uso do Formulário
|
attributes.form_usage | string |
Uma descrição de como o formulário deve ser usado |
|
Introdução à Ferramenta de Formulário
|
attributes.form_tool_intro | string |
Texto introdutório que descreve a ferramenta online va para este formulário |
|
URL da Ferramenta de Formulário
|
attributes.form_tool_url | string |
Local da ferramenta online para este formulário |
|
URL de Detalhes do Formulário
|
attributes.form_details_url | string |
Local no www.va.gov da página de informações para este formulário |
|
Tipo de formulário
|
attributes.form_type | string |
Tipo de VA do formulário |
|
Linguagem
|
attributes.language | string |
Código de idioma do formulário |
|
Excluído em
|
attributes.deleted_at | date-time |
O carimbo de data/hora no qual o formulário foi excluído |
|
Formulários relacionados
|
attributes.related_forms | array of string |
Uma listagem de outros formulários relacionados ao formulário atual |
|
Categorias de benefícios
|
attributes.benefit_categories | array of object |
Listagem de categorias de benefícios e correspondência |
|
Nome
|
attributes.benefit_categories.name | string |
Nome da categoria de benefício do formulário |
|
Description
|
attributes.benefit_categories.description | string |
Descrição da categoria de benefício do formulário |
|
Administração de Formulário de VA
|
attributes.va_form_administration | string |
A organização va que administra o formulário |
|
versões
|
attributes.versions | array of object |
O histórico de versões de revisões para o formulário |
|
Sha256
|
attributes.versions.sha256 | string |
Um hash sha256 do conteúdo do formulário para essa versão |
|
Revisão em
|
attributes.versions.revision_on | date |
A data em que o hash sha256 foi calculado |