TOTVS - RESTFul API


Service: /smartschedapi/

endpoint do smartSchedule

Métodos

DELETE
/api/framework/v1/smartSchedApi/{Sched_ID}

Description

Exclusão de schedules

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
sched_id character optional

GET
/api/framework/v1/smartSchedApi/GetDefParams/{FuncParam}

Description

Retorna os valores default de uma pergunta atrelada na rotina.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
funcparam character optional

GET
/api/framework/v1/smartSchedApi/engineRunning

Description

Retorna qual motor está em execução (antigo ou smart).

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
/api/framework/v1/smartSchedApi/GetExistFunc/{FuncParam}

Description

Retorna se a função pode ser agendada.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
funcparam character optional

GET
/api/framework/v1/smartSchedApi/{Sched_ID}

Description

Recupera as informações de um schedule do cadastro.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
sched_id character optional

GET
/api/framework/v1/smartSchedApi/GetOrderParams/{FuncParam}/{id}

Description

Retorna informações da ordem dos parametros definidos a partir de uma ordem.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
funcparam character optional
id integer optional

GET
/api/framework/v1/smartSchedApi/GetOrderParams/{FuncParam}

Description

Retorna informações da ordem dos parametros definidos.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
funcparam character optional

GET
/api/framework/v1/smartSchedApi/GetParams/{FuncParam}

Description

Retorna informações dos parametros da função solicitada.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
funcparam character optional

GET
/api/framework/v1/smartSchedApi

Description

Schedules cadastrados

Response Content Type

Parameters

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

POST
/api/framework/v1/smartSchedApi

Description

Inclusão de schedules

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
/api/framework/v1/smartSchedApi/{Sched_ID}

Description

Alteração de schedules

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
sched_id character optional