Exibir origem

Objetivo:

A finalidade deste método é possibilitar a inclusão de Agendamentos do Smart Schedule.

post

api/framework/v1/smartSchedApi

Informações para Requisição (Request Information)

Exemplo (Body Parameters)

{
    "firstExecution": "2023-12-12T15:07:00-03:00",
	"processID": "TSTEMP",
    "executionParameter": {
        "company": [
            "T1",
            "T2"
        ],
        "branch": "",
        "moduleid": 5,
        "userid": "000000",
        "description": "TESTE ",
        "companybranch": "T1;T2;"
    },
    "monthly": {
        "day": 1,
        "hour": 8,
        "minute": 0
    },
    "rangeExecutions": {
        "frequency": {
            "type": "minute",
            "value": 30
        },
        "rangeLimit": {
            "hour": 12,
            "minute": 0,
            "day": 10
        }
    },
	"recurrent": true,
    "status": "active"
}

Parâmetros body

Nome	Tipo	Descrição	Obrigatório
firstExecution	Character	Data e hora inicial, para primeira execução. Formato UTC aaaa-mm-ddThh:mm:ss-+Time Zone (coloca a hora local + o timezone (ISO 8601))	X
processID	Character	Função/Rotina a ser atribuída.	X
executionParameter	Json	Informações referentes a execução do agendamento.	X
daily	Json	Definições de período DIÁRIO.
weekly	Json	Definições de período SEMANAL.
monthly	Json	Definições de período MENSAL.
rangeExecutions	Json	Definições do range de execuções.	X
recurrent	Boolean	Define recorrência ativa.	X
status	Character	Status do agendamento. Por exemplo, active, inactive ou completed.	X

Parâmetros body: executionParameter

Nome	Tipo	Descrição	Obrigatório
company	array(character)	código do grupo de empresas	X
branch	array(character)	código da filial
moduleid	Character	Código do módulo.	X
userid	Character	Código do usuário.	X
description	Character	Descrição do agendamento.
companybranch	Character	Empresa/Filial que serão atribuídas. Por exemplo, T1/D MG 01.	X

Parâmetros body: daily

Nome	Tipo	Descrição	Obrigatório
day	Numeric	Dia de execução	X
hour	Numeric	Hora de execução	X
minute	Numeric	Minuto de execução	X

Parâmetros body: weekly

Nome	Tipo	Descrição	Obrigatório
day	Numeric	Dia de execução	X
hour	Numeric	Hora de execução	X
minute	Numeric	Minuto de execução	X

Parâmetros body: montly

Nome	Tipo	Descrição	Obrigatório
day	Numeric	Dia de execução	X
hour	Numeric	Hora de execução	X
minute	Numeric	Minuto de execução	X

Parâmetros body: rangeExecutions

Nome	Tipo	Descrição	Obrigatório	Valor Padrão
frequency	Json	Definições de frequência.	X
rangeLimit	Json	Definições de limite de execução.	X

Parâmetros rangeExecutions: frequency

Nome	Tipo	Descrição	Obrigatório	Valor Padrão
type	Character	Tipo de frequencia, exemplo: day, hour, minute.	X
value	Numeric	Intervalo da frequencia.	X

Parâmetros rangeExecutions: rangeLimit

Nome	Tipo	Descrição
day	Numeric	Dia de execução
hour	Numeric	Hora de execução
minute	Numeric	Minuto de execução
daysOfWeek	Array	Dias da semana de execução, exemplo: Sunday; Monday; Tuesday; Wednesday; Thursday; Friday; Saturday;

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Não há.

Formatos de Resposta (Response Formats)

Código (Code)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
200	Success	Não há	Não há
400	Bad Request	Não há	Não há

application/json, text/json

{
    "isNewSchedule": true,
    "jobscheduleid": "000007",
    "processID": "TSTEMP                                                                          ",
    "recurrent": true,
    "monthly": {
        "day": 1,
        "hour": 8,
        "minute": 0
    },
    "rangeExecutions": {
        "frequency": {
            "type": "minute",
            "value": 30
        },
        "rangeLimit": {
            "day": 10,
            "hour": 12,
            "minute": 0
        }
    },
    "status": "active",
    "firstExecution": "2023-12-12T15:07:00-03:00",
    "executionParameter": {
        "printType": 1,
        "sheetFormat": 1,
        "paramdef1": null,
        "paramdef2": null,
        "company": [
            "T1",
            "T2"
        ],
        "userid": "000000",
        "moduleid": 5,
        "description": "TESTE "
    },
    "manageable": "1"
}

Response

Parâmetro	Tipo	Descrição	Valores
isNewSchedule	Boolean
jobscheduleid
processID
recurrent
status



manageable