TOTVS - RESTFul API


Service: /agentschedule/

Endpoint de agentes de schedule

Métodos

DELETE
/api/framework/v1/agentSchedule/{IdAgent}

Description

Exclusão de agente

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required

GET
/api/framework/v1/agentSchedule

Description

Retorna informações dos agentes de schedule.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
order character optional
fields character optional
aquerystring array optional

GET
/api/framework/v1/agentSchedule/getIdAgent/{IdAgent}

Description

Retorna informações do agente de schedule solicitado.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required

GET
/api/framework/v1/agentSchedule/readAgentEvents/{IdAgent}/{Company}

Description

Retorna os eventos do agente de schedule solicitado.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required
company character required

GET
/api/framework/v1/agentSchedule/statusAgentEvents/{IdAgent}

Description

Retorna o status de inicialização dos agentes de schedule.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required

POST
/api/framework/v1/agentSchedule

Description

Inclusão de agente

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
/api/framework/v1/agentSchedule/{IdAgent}

Description

Alteração de agente

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required

PUT
/api/framework/v1/agentSchedule/startAgent/{IdAgent}

Description

Inicia um agente

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required

PUT
/api/framework/v1/agentSchedule/stopAgent/{IdAgent}

Description

Pausa um agente

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
idagent character required