TOTVS - RESTFul API


Service: /pcpmonitorapi/

API REST dedicada ao Totvs Supply Monitor

Métodos

DELETE
api/pcp/v1/pcpmonitorapi/visaoMonitor/{codVisao}/{codMonitor}/{sequencia}

Description

Exclui o Monitor da Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional
codmonitor string optional
sequencia integer optional

DELETE
api/pcp/v1/pcpmonitorapi/visao/deleteUsuarios/{codVisao}/{usuario}

Description

Exclui um usuário na Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional
usuario string optional

DELETE
api/pcp/v1/pcpmonitorapi/visao/{codVisao}

Description

Exclui uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional

GET
api/pcp/v1/pcpmonitorapi/visaoMonitor

Description

Retorna os Monitores da Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
codvisao integer optional
expand string optional
order string optional

GET
api/pcp/v1/pcpmonitorapi/usuarios/{usuario}

Description

Retorna os dados de um Usuário do Sistema

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
usuario string optional

GET
api/pcp/v1/pcpmonitorapi/consulta/{value}

Description

Retorna um registro da lista

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
metodo string optional
filial string optional
tabela string optional
campocodigo string optional
campodescricao string optional
_pathparam UndefinedUndefined
value string optional

GET
api/pcp/v1/pcpmonitorapi/consulta

Description

Retorna uma lista de registros

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
filter string optional
order string optional
metodo string optional
filial string optional
code string optional
tabela string optional
campocodigo string optional
campodescricao string optional

GET
api/pcp/v1/pcpmonitorapi/monitor/modulos

Description

Retorna os Modulos que agruparão os Monitores

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
api/pcp/v1/pcpmonitorapi/monitor

Description

Retorna os Monitores

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
agrupador string optional
expand string optional
filter string optional

GET
api/pcp/v1/pcpmonitorapi/usuarios

Description

Retorna a lista de Usuários do Sistema

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
filter string optional

GET
api/pcp/v1/pcpmonitorapi/visao

Description

Retorna os dados de várias Visões

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
filtrausuario boolean optional
page integer optional
pagesize integer optional
order string optional
filter string optional

GET
api/pcp/v1/pcpmonitorapi/visao/{codVisao}

Description

Retorna os dados de uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
_pathparam UndefinedUndefined
codvisao integer optional

POST
api/pcp/v1/pcpmonitorapi/visao/copiaVisao/{codVisao}

Description

Copia uma visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional

POST
api/pcp/v1/pcpmonitorapi/monitor/monitorDataSchema

Description

Retorna os dados para apresentar no Monitor

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visao/desfavoritaVisao

Description

Desfavorita uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/monitor/details

Description

Retorna os dados para montar os detalhes

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visao/favoritaVisao

Description

Atualiza uma Visão como favorita

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/monitor/loadMonitors

Description

Realiza a carga dos Monitores

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visaoMonitor/reorder

Description

Atualiza ordenação de monitores de uma visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visaoMonitor

Description

Inclui um Monitor em uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visao/saveUsuarios

Description

Inclui um usuário na Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/monitor/validate

Description

Valida se o usuário tem acesso ao Monitor

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
api/pcp/v1/pcpmonitorapi/visao

Description

Inclui uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
api/pcp/v1/pcpmonitorapi/visaoMonitor/{codVisao}/{codMonitor}/{sequencia}

Description

Altera os dados do Monitor na Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional
codmonitor string optional
sequencia integer optional

PUT
api/pcp/v1/pcpmonitorapi/visao/{codVisao}

Description

Edita uma Visão

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
codvisao integer optional