fap-sisbr

REST do fap-sisbr 3.0
criarRestricao
POST /sisbr/restricoes

Cria registro de Restrição Negocial na tabela RESTRICAONEGOCIAL

Request body

Responses

201 Created

O recurso informado foi criado com sucesso.

400 Bad Request

Não foi possível interpretar a requisição.

atualizarRestricao
PUT /sisbr/restricoes/{idRestricaoNegocial}

Path variables

idRestricaoNegocial
string required

Responses

200 OK

O recurso solicitado foi processado e retornado com sucesso.

404 Not Found

O recurso solicitado ou o endpoint não foi encontrado.

400 Bad Request

Não foi possível interpretar a requisição

obterRestricoes
GET /sisbr/restricoes

Retorna coleção de restrições

Request parameters

ativo
boolean optional
valor
string optional
tipoRestricao
string optional

Responses

200 OK

O recurso solicitado foi processado e retornado com sucesso.

Body
Array of RestricaoDTO
400 Bad Request

Não foi possível interpretar a requisição

obterRestricao
GET /sisbr/restricoes/{idRestricaoNegocial}

Consulta pelo ID da tabela de Restrição Negocial

Path variables

idRestricaoNegocial
string required

Id da tabela de Restrição negocial

Responses

200 OK

O recurso solicitado foi processado e retornado com sucesso.

400 Bad Request

Não foi possível interpretar a requisição

404 Not Found

O recurso solicitado ou o endpoint não foi encontrado.

excluirRestricao
DELETE /sisbr/restricoes/{idRestricaoNegocial}

Path variables

idRestricaoNegocial
string required

Responses

204 No Content

O recurso solicitado foi processado com sucesso (sem retorno)

400 Bad Request

Não foi possível interpretar a requisição

404 Not Found

O recurso solicitado ou o endpoint não foi encontrado.

criarTipoRestricao
POST /sisbr/tiposRestricoes

Request body

Responses

201 Created

O recurso informado foi criado com sucesso.

400 Bad Request

Não foi possível interpretar a requisição

obterTiposRestricoes
GET /sisbr/tiposRestricoes

Retorna lista de tipos de restrição

Request parameters

descricao
string optional
tabelaRestricao
string optional
campoRestricao
string optional
tabelaReferencia
string optional
campoReferencia
string optional

Responses

200 OK
Body
obterTipoRestricao
GET /sisbr/tiposRestricoes/{idTipo}

Obtem Tipo de Restrição

Path variables

idTipo
string required

Responses

200 OK
atualizarTipoRestricao
PUT /sisbr/tiposRestricoes/{idTipo}

Atualiza Tipo de Restrição

Path variables

idTipo
string required

Request body

Responses

200 OK

O recurso solicitado foi processado e retornado com sucesso.

excluirTipoRestricao
DELETE /sisbr/tiposRestricoes/{idTipo}

Path variables

idTipo
string required

Responses

204 No Content

Requisição processada com sucesso sem retorno

404 Not Found

O recurso solicitado ou o endpoint não foi encontrado.

400 Bad Request

Não foi possível interpretar a requisição

RestricaoDTO

DTO Restrição Negocial

Object
idRestricaoNegocial
number

Id da tabela RESTRICAONEGOCIAL

valor
string

Coluna VALORRESTRICAONEGOCIAL da tabela RESTRICAONEGOCIAL

tipoRestricao

DTO correspondente a tabela TIPORESTRICAONEGOCIAL da tabela RESTRICAONEGOCIAL

dataHoraCriacao
string

Coluna DATAHORACRIACAO da tabela RESTRICAONEGOCIAL

dataHoraAtualizacao
string

Coluna DATAHORAATUALIZACAO da tabela RESTRICAONEGOCIAL

idUsuarioAlteracao
string

Coluna IDUSUARIOALTERACAO da tabela RESTRICAONEGOCIAL

bolAtivo
boolean

Coluna BOLATIVO da tabela RESTRICAONEGOCIAL

TipoRestricaoDTO

DTO Tipo de Restrição Negocial

Object
idTipoRestricaoNegocial
number

Id da tabela TIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL

descricao
string

Coluna DESCTIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL

tabelaRestricao
string

Coluna NOMETIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL

campoRestricao
string

Coluna VALORTIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL

tabelaReferencia
string

Coluna NOMEREFERENCIATIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL

campoReferencia
string

Coluna VALORREFERENCIATIPORESTRICAONEGOCIAL da tabela TIPORESTRICAONEGOCIAL