API Qualificações (Manutenção Industrial)

Disponibilizado endpoint para integração do cadastro de Qualificações com os métodos GET, POST, PUT, PATCH e DELETE.

Estrutura:

Atributos	Descrição	Tamanho	Tipo	Chave Primária	Requerido	Valor Default	Valores Válidos	Observação
id	Id único para rastreamento do registro de ponta a ponta	10	NUMBER	S	N	-	-	Gerado automaticamente quando o registro é inserido na tabela.
codigoErp	Código de relacionamento com o ERP	15	STRING	N	N	-	-	-
descricao	Descrição	40	STRING	N	S	-	-	-
detalhe	Detalhamento	500	STRING	N	N	-	-	-
utilizadoIndustria	Utiliza na Indústria	1	STRING	N	N	"N"	"N" = Não "S" = Sim	-

GET (Consulta Qualificação)

http:127.0.0.1:8080/api/entity/v1/qualificacoesInd

Response

{
    "hasNext": true,
    "items": [
        {
            "id": 2,
            "codigoErp": null,
            "descricao": "AJUSTADOR MECANICO",
            "detalhe": null,
            "utilizadoIndustria": "N"
        },
        {
            "id": 3,
            "codigoErp": null,
            "descricao": "ALMOXARIFE",
            "detalhe": null,
            "utilizadoIndustria": "N"
        }
    ]
}

Parâmetros

page: Número da página.
pagesize: Quantidade máxima de registros por página.

Observações

Todos os atributos podem ser usados como parâmetro para a busca.

PUT/PATCH (Modifica Qualificação)

http:127.0.0.1:8080/api/entity/v1/qualificacoesInd

Estrutura de dados para envio (exemplo):

Body

{
    "codigoErp": "CARGO-0003",
    "descricao": "ANALISTA DE SISTEMAS SR. III",
    "detalhe": "Pessoa responsável por analistar e implementar soluções tecnológicas para resolução dos problemas"
}

Estrutura de dados retorno:

Response

{
    "codigoErp": "CARGO-0003",
    "descricao": "ANALISTA DE SISTEMAS SR. III",
    "detalhe": "Pessoa responsável por analistar e implementar soluções tecnológicas para resolução dos problemas",
    "id": "10028"
}

Observações

Quando PATCH poderão ser informados apenas os atributos que necessitam de atualização.
No caso de PUT deverão ser informados os atributos necessários bem como os obrigatórios.
Deverá ser informado ao menos um dos atributos para localização da Qualificação (id ou codigoErp).
Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização da qualificação. Será realizada uma busca por outras qualificações com IDs diferentes que utilizem o codigoErp informado e caso nenhuma qualificação seja encontrada o valor informado será alterado, e caso seja encontrada uma ou mais qualificações com IDs diferentes já utilizando este codigoErp uma mensagem será exibida e a alteração não será realizada.
Caso apenas o atributo codigoErp for informado, será realizada uma busca pelas qualificações que utilizem esse código e caso sejam encontradas duas ou mais qualificações utilizando este codigoErp uma mensagem será exibida e a alteração não será realizada.
Caso o atributo descricao for informado, será realizada uma busca por outras qualificações com IDs diferentes que utilizem a descricao informada e caso nenhuma qualificação seja encontrada o valor informado será alterado, e caso seja encontrada uma ou mais qualificações com IDs diferentes já utilizando essa descricao uma mensagem será exibida e a alteração não será realizada.

POST (Insere Qualificação)

http:127.0.0.1:8080/api/entity/v1/qualificacoesInd

Estrutura de dados para envio:

Body

{
    "codigoErp": "CARGO-0003",
    "descricao": "ANALIST. DE SIST. SR. III",
    "detalhe": "sem detalhes"
}

Estrutura de dados retorno:

Response

{
    "codigoErp": "CARGO-0003",
    "descricao": "ANALIST. DE SIST. SR. III",
    "detalhe": "sem detalhes",
    "utilizadoIndustria": "N",
    "id": "10028"
}

Observações

O atributo id será gerado automaticamente e atribuído à nova qualificação, e caso seja informado será desconsiderado.
Caso o atributo codigoErp for informado, será realizada uma busca por outras qualificações que utilizem esse código e caso seja encontrada uma ou mais qualificações já utilizando este codigoErp uma mensagem será exibida e a inclusão não será realizada.
O atributo descricao deverá ser informado. Será realizada uma busca por outras qualificações que utilizem essa descrição e caso nenhuma qualificação seja encontrada a inclusão será realizada, e caso seja encontrada uma ou mais qualificações já utilizando essa descricao uma mensagem será exibida e a inclusão não será realizada.

DELETE (Exclui Qualificação)

Disponibilizado endpoint para excluir a Qualificação.

Método DELETE:

http:127.0.0.1:8080/api/entity/v1/qualificacoesInd

Parâmetros

Deverá ser informado ao menos um dos atributos para localização da Qualificação (id ou codigoErp).
Caso seja informado apenas o atributo codigoErp, será realizada uma busca pelas qualificações que utilizem esse código e caso sejam encontradas duas ou mais qualificações utilizando este codigoErp uma mensagem será exibida e a deleção não será realizada.
Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização e exclusão da qualificação e o codigoErp será desconsiderado.
Caso o registro da qualificação esteja sendo utilizado por registros de outras tabelas relacionadas a exclusão não será realizada e uma mensagem será exibida.

Páginas filhas

API Qualificações (Manutenção Industrial)