Descrição:
API para inserção, atualização, consulta e deleção de Profile do Protheus.
Observação: Essa API gera um profile com um prefixo diferente, para apartar os Profiles oriundos da web, apps, portais etc para o Profile gerado dentro do Protheus, como browse, filtros etc.
Importante: A gravação do Profile é feita sempre de acordo com o usuário logado, portanto a API só funcionará caso o header de Authorization seja enviado, além disso, o grupo de empresa e filial é gravado de acordo com estado do ambiente, logo pode ser utilizado o header de tenantid para ficar de acordo com sua necessidade.
post
Descrição:
Efetua a inserção de um Profile
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|
| branch | Boolean | Indica que a gravação vai considerar o grupo de empresas e filial |
| false |
/api/framework/v1/profileService/
Body
{
"programName": "xisto",
"task": "xpto",
"type": "etc",
"value": "Meu valor de Profile"
}
put
Descrição:
Efetua a alteração de um Profile previamente cadastrado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|
| branch | Boolean | Indica que a alteração vai considerar o grupo de empresas e filial |
| false |
api/framework/v1/profileService/xisto/xpto/etc
Body
{
"programName": "xisto",
"task": "xpto",
"type": "etc",
"value": "Meu novo valor de profile"
}
A propriedade value do JSON é aberta e pode ser enviado qualquer valor, até mesmo um JSON, esse valor será convertido para character do ADVPL via cValToChar, portanto é necessário apenas se atentar a qual conversão a cValToChar pode fazer com o valor recebido.
delete
Descrição:
Efetua a exclusão de um Profile previamente cadastrado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|
| branch | Boolean | Indica que a exclusão vai considerar o grupo de empresas e filial |
| false |
api/framework/v1/profileService/xisto/xpto/etc
get
Descrição:
Efetua a busca e retorno de um Profile
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|
| branch | Boolean | Indica que a busca vai considerar o grupo de empresas e filial |
| false |
| defaultValue | String | Valor padrão para o Profile caso o mesmo não seja encontrado |
| "" |
api/framework/v1/profileService/xisto/xpto/etc
Retorno
"Meu novo valor de profile"
Accept
O header Accept pode ser enviado para a API e o mesmo será enviado como retorno no header Content-Type, permitindo por exemplo, retornar um text/plain para Profiles mais simples, ou um application/json entre outros.
Limitações
O tamanho de alguns dados possuem limitações, abaixo uma tabela com seus respectivos tamanhos
| Dado | Tamanho |
|---|
| programName | 05 |
| task | 10 |
| type | 10 |
