GPIC - Backend  1.0
Aplicações .NET para o backend do GPIC
Referência à classe WebAPI.Controllers.ProjectPartialReportController

Controller de Relatório de Projeto. Mais...

Diagrama de heranças da classe WebAPI.Controllers.ProjectPartialReportController
[legenda]
Diagrama de colaboração para WebAPI.Controllers.ProjectPartialReportController:
[legenda]

Membros públicos

 ProjectPartialReportController (IGetProjectPartialReportById getProjectPartialReportById, IGetProjectPartialReportByProjectId getProjectPartialReportByProjectId, ICreateProjectPartialReport createProjectPartialReport, IUpdateProjectPartialReport updateProjectPartialReport, IDeleteProjectPartialReport deleteProjectPartialReport, ILogger< ProjectPartialReportController > logger)
 Construtor do Controller de Relatório de Projeto. Mais...
 
async Task< ActionResult< DetailedReadProjectPartialReportOutput > > GetById (Guid? id)
 Busca relatório parcial de projeto pelo Id. Mais...
 
async Task< ActionResult< DetailedReadProjectPartialReportOutput > > GetByProjectId (Guid? projectId)
 Busca relatório parcial de projeto pelo Id do projeto. Mais...
 
async Task< ActionResult< DetailedReadProjectPartialReportOutput > > Create ([FromBody] CreateProjectPartialReportInput request)
 Cria relatório parcial de projeto. Mais...
 
async Task< ActionResult< DetailedReadProjectPartialReportOutput > > Update (Guid? id, [FromBody] UpdateProjectPartialReportInput request)
 Atualiza relatório parcial de projeto. Mais...
 
async Task< ActionResult< DetailedReadProjectPartialReportOutput > > Delete (Guid? id)
 Remove relatório parcial de projeto. Mais...
 

Descrição detalhada

Controller de Relatório de Projeto.

Documentação dos Construtores & Destrutor

◆ ProjectPartialReportController()

WebAPI.Controllers.ProjectPartialReportController.ProjectPartialReportController ( IGetProjectPartialReportById  getProjectPartialReportById,
IGetProjectPartialReportByProjectId  getProjectPartialReportByProjectId,
ICreateProjectPartialReport  createProjectPartialReport,
IUpdateProjectPartialReport  updateProjectPartialReport,
IDeleteProjectPartialReport  deleteProjectPartialReport,
ILogger< ProjectPartialReportController logger 
)
inline

Construtor do Controller de Relatório de Projeto.

Parâmetros
getProjectPartialReportByIdUse Case de busca de relatório parcial de projeto por Id.
getProjectPartialReportByProjectIdUse Case de busca de relatório parcial de projeto por Id do projeto.
createProjectPartialReportUse Case de criação de relatório parcial de projeto.
updateProjectPartialReportUse Case de atualização de relatório parcial de projeto.
deleteProjectPartialReportUse Case de remoção de relatório parcial de projeto.
loggerLogger.

Documentação dos métodos

◆ Create()

async Task<ActionResult<DetailedReadProjectPartialReportOutput> > WebAPI.Controllers.ProjectPartialReportController.Create ( [FromBody] CreateProjectPartialReportInput  request)
inline

Cria relatório parcial de projeto.

Parâmetros
requestDados para criação de relatório parcial de projeto.
Retorna
Relatório de projeto criado.

<response code="201">Relatório de projeto criado.</response> <response code="400">Dados inválidos.</response> <response code="401">Usuário não autorizado.</response>

Grafo de chamadas desta função:

◆ Delete()

async Task<ActionResult<DetailedReadProjectPartialReportOutput> > WebAPI.Controllers.ProjectPartialReportController.Delete ( Guid?  id)
inline

Remove relatório parcial de projeto.

Parâmetros
idId do relatório parcial de projeto.
Retorna
Relatório de projeto removido.

<response code="200">Relatório de projeto removido.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Relatório de projeto não encontrado.</response>

◆ GetById()

async Task<ActionResult<DetailedReadProjectPartialReportOutput> > WebAPI.Controllers.ProjectPartialReportController.GetById ( Guid?  id)
inline

Busca relatório parcial de projeto pelo Id.

Parâmetros
idId do relatório parcial de projeto.
Retorna
Relatório de projeto.

<response code="200">Relatório de projeto encontrado.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Relatório de projeto não encontrado.</response>

Este é o diagrama das funções que utilizam esta função:

◆ GetByProjectId()

async Task<ActionResult<DetailedReadProjectPartialReportOutput> > WebAPI.Controllers.ProjectPartialReportController.GetByProjectId ( Guid?  projectId)
inline

Busca relatório parcial de projeto pelo Id do projeto.

Parâmetros
projectIdId do projeto.
Retorna
Relatório parcial do projeto.

<response code="200">Relatórios de projeto encontrados.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Relatórios de projeto não encontrados.</response>

◆ Update()

async Task<ActionResult<DetailedReadProjectPartialReportOutput> > WebAPI.Controllers.ProjectPartialReportController.Update ( Guid?  id,
[FromBody] UpdateProjectPartialReportInput  request 
)
inline

Atualiza relatório parcial de projeto.

Parâmetros
idId do relatório parcial de projeto.
requestDados para atualização de relatório parcial de projeto.
Retorna
Relatório de projeto atualizado.

<response code="200">Relatório de projeto atualizado.</response> <response code="400">Dados inválidos.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Relatório de projeto não encontrado.</response>


A documentação para esta classe foi gerada a partir do seguinte ficheiro: