Totvs custom tabs box items |
---|
| Parâmetros de Entrada POST:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header |
| autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | content | request da api | Sim | body |
| Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de Período de Estabilidade: - employeeId: Informação pertinente ao funcionário.
- startDate: Data do Início do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade registrado.
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/stabilityControl
Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"companyId": "T1",
"branchId": "D MG 01 ",
"employeeId": "T1|D MG 01 |000001",
"startDate": "2020-01-01T18:25:43",
"stabilityCode": "T1|D MG |S01"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa |
| branchId | RFX_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01 " | employeeId | RFX_MAT | Matrícula do Funcionário | "T1|D MG 01 |000001" | startDate | RFX_DATAI | Data de Início do Período | "2020-01-01T18:25:43" | stabilityCode | RFX_TPESTB | Tipo de Estabilidade | "T1|D MG |S01" |
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 201 | Registro criado. |
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code "companyId": "201T1",
"description "branchId": "Registro criado."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades json companyId ou branchId estão preenchidas com conteúdo válido. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400 "D MG 01 ",
"startDate": "2020-01-01T18:25:43",
"detailedMessageemployeeId": "De-Para de Empresa/Filial não encontrado na base.\r\nT1|D MG 01 |000001",
"helpUrlstabilityCode": "https://tdn.totvs.com/x/ZYNvIT1|D MG |S01",
"messageid": "ErroT1|D naMG validação do recebimento da mensagem."
}01 |T1|D MG 01 |000001|2020-01-01T18:25:43|T1|D MG |S01"
} |
| 400 | Erro na validação do | 400 | Erro na validação do recebimento da mensagem. | Verificar se | a propriedade json employeeId possui informações válidasas propriedades json companyId ou branchId estão preenchidas com conteúdo válido. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "VerifiqueDe-Para o conteúdo da TAG (employeeId) pois não foi possível encontrar esta informação no Protheus'\de Empresa/Filial não encontrado na base.\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se a propriedade json startDate está no formato corretoemployeeId possui informações válidas. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Verifique o conteúdo da TAG (startDateemployeeId) pois anão datafoi nãopossível estáencontrar noesta formatoinformação correto:no 'YYYY-MM-DDTHH:MM:SS'Protheus'\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se a propriedade json startDate está com conteúdo existente na tabela S053 - Tipos de Estabilidade do Protheusno formato correto. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Verifique o conteúdo da TAG (stabilityCodestartDate) pois nãoa foidata possívelnão encontrarestá estano informaçãoformato no Protheus.correto: 'YYYY-MM-DDTHH:MM:SS'\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades json obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidasa propriedade json stabilityCode está com conteúdo existente na tabela S053 - Tipos de Estabilidade do Protheus. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Verifique o conteúdo da TAG (employeeIdstabilityCode) pois elanão éfoi obrigatóriapossível paraencontrar aesta manipulaçãoinformação desteno processoProtheus.\r\n\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades json obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidas | 500 | Ocorreu uma falha no retorno da informação. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCodecode": 500400,
"errorMessagedetailedMessage": "Ocorreu uma falha no retorno da informação."
}Verifique o conteúdo da TAG (employeeId) pois ela é obrigatória para a manipulação deste processo.\r\n\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Ocorreu uma falha no retorno da informação. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 500,
"detailedMessage": "Ocorreu uma falha no retorno da informação.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
|
Totvs custom tabs box items |
---|
| Parâmetros de Entrada PUT:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | "" | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | stabilityId | T1|D MG 01 |T1|D MG 01 |000001|2020-01-01T18:25:43|T1|D MG |S01 | Sim | request | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|FILIAL|CHAVE FUNCIONÁRIO|DATA DE INÍCIO| CHAVE TIPO DE ESTABILIDADE". | content | layout json | sim | body | "" | Estrutura json com informações de cadastro do currículo: Dados de Período de Estabilidade: - endDate: Data do Final do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/stabilityControl
Image RemovedImage Added Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"code": "200",
"endDate": "2020-01-15T18:30:43",
"stabilityCode": "T1|D MG |S02",
"description": "Operação realizada com sucesso!"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa |
| branchId | RFX_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01" | employeeId | RFX_MAT | Matrícula do Funcionário. | "T1|D MG 01 |000001" | startDate | RFX_DATAI | Data de Início do Período | "2020-01-01T18:25:43" | stabilityCode | RFX_TPESTB | Descrição do resumo de qualificações | "T1|D MG |S01" |
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Mensagens Validação API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 200 | Operação realizada com sucesso. | Registro foi alterado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "Operação realizada com sucesso!"
} |
| 400 |
|
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação do pacote difere do parâmetro stabilityId, favor verificar e reenviar.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem. |
| Erro | Mensagem | Solução | API RESPONSE | 200 | Operação realizada com sucesso. | Registro foi alterado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "Operação realizada com sucesso!"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado. - Dados de Empresa e Filial,
- Dados de Filial e Matrícula,
- Formato da Data de Início,
- Tipo de Estabilidade.
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação stabilityId ausente ou inválida.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Ocorreu uma falha no retorno da informação. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCodecode": 500,
"detailedMessage": "Ocorreu uma falha no retorno da informação.",
"helpUrl": "errorMessage": "Ocorreu uma falha no retorno da informação."https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. |
Totvs custom tabs box items |
---|
default | no |
---|
referencia | DELETE |
---|
| Parâmetros de Entrada DELETE:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | "" | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | stabilityId | T1|D MG 01 |T1|D MG 01 |000001|2020-01-01T18:25:43|S01 | Sim | query | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|FILIAL|CHAVE FUNCIONÁRIO|DATA DE INÍCIO| CHAVE TIPO DE ESTABILIDADE". |
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/stabilityControl
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 200 | Operação realizada com sucesso. | Registro foi deletado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "Operação realizada com sucesso!"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado. - Dados de Empresa e Filial,
- Dados de Filial e Matrícula,
- Formato da Data de Início,
- Tipo de Estabilidade.
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação stabilityId ausente ou inválida.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCodecode": 500,
"errorMessagedetailedMessage": "Ocorreu uma falha no retorno da informação.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. |
|