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)

Parâmetros body

NomeTipoDescriçãoObrigatórioValor padrão
firstExecutionCharacter

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
processIDCharacter

Função/Rotina a ser atribuída.

X
executionParameterJson

Informações referentes a execução do agendamento.

X


dailyJson

Definições de período DIÁRIO.



weeklyJson

Definições de período SEMANAL.



monthlyJson

Definições de período MENSAL.



rangeExecutionsJson

Definições do range de execuções.

X
recurrentBoolean

Define recorrência ativa.

X
statusCharacter

Status do agendamento. Por exemplo, active, inactive ou completed.

X


Parâmetros body: executionParameter

NomeTipoDescriçãoObrigatórioValor Padrão
companyArray(character)código do grupo de empresasX
branchArray(character)código da filial

moduleidCharacter

Código do módulo.

X
useridCharacter

Código do usuário.

X
descriptionCharacter

Descrição do agendamento.



companybranchCharacter

Empresa/Filial que serão atribuídas. Por exemplo, T1/D MG 01.

X
titleCharacter

Título da Impressão.



printFormatNumeric

Formato de Impressão (1-Web Spool/2-Email).



fileMailCharacter

Nome do arquivo de impressão ou e-mail destinatário.



printTypeNumeric

Tipo de impressão (1-HTML/2-PDF/3-Planilha).



sheetFormatNumeric

Formato da planilha (1-Normal/2-Suprime linhas brancas e totais/3-Tabela).



MV_PAR??Any

Definição dos parâmetros(MV_PAR's)

Formato Pergunte(SX1):
MV_PAR01
MV_PAR02
MV_PAR03
...

Obs.: preenchimento deve respeitar a tipagem de cada pergunte definido no dicionário SX1, como: caractere, numérico ou data.

Formato PARAMDEF:
MV_PAR01 numérico: ORDEM
MV_PAR02 caractere: DE
MV_PAR03 caractere: ATE



MV_FOR??Character

Fórmula(expressão) a ser executada para preenchimento do parâmetro.

Formato Pergunte(SX1):
MV_FOR01
MV_POR02
MV_POR03
...

Obs.: Formulas são utilizadas apenas quando os parâmetros são definidos via Pergunte(SX1).




Parâmetros body: daily

NomeTipoDescriçãoObrigatórioValor Padrão
dayNumericDia de execuçãoX
hourNumericHora de execuçãoX
minuteNumericMinuto de execuçãoX


Parâmetros body: weekly

NomeTipoDescriçãoObrigatórioValor Padrão
dayNumericDia de execuçãoX
hourNumericHora de execuçãoX
minuteNumericMinuto de execuçãoX


Parâmetros body: montly

NomeTipoDescriçãoObrigatórioValor Padrão
dayNumericDia de execuçãoX
hourNumericHora de execuçãoX
minuteNumericMinuto de execuçãoX


Parâmetros body: rangeExecutions

NomeTipoDescriçãoObrigatórioValor Padrão
frequencyJsonDefinições de frequência.X
rangeLimitJsonDefinições de limite de execução.X


Parâmetros rangeExecutions: frequency

NomeTipoDescriçãoObrigatórioValor Padrão
typeCharacterTipo de frequencia, exemplo: day, hour, minute.X
valueNumericIntervalo da frequencia.X


Parâmetros rangeExecutions: rangeLimit

NomeTipoDescriçãoObrigatórioValor Padrão
dayNumericDia de execução

hourNumericHora de execução

minuteNumericMinuto de execução

daysOfWeekArrayDias da semana de execução, exemplo:
Sunday;
Monday;
Tuesday;
Wednesday;
Thursday;
Friday;
Saturday;


Exemplo UNICA (Body Parameters)

{
    "firstExecution": "2023-12-13T12:28:00-03:00",
    "recurrent": false,
    "executionParameter": {
        "company": [
            "T2"
        ],
        "branch": "",
        "moduleid": 6,
        "userid": "000000",
        "description": "Agendamento UNICO",
        "companybranch": "T2;"
    },
    "processID": "TSTEMP",
    "status": "active"
}


Exemplo MENSAL (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"
}


Exemplo SEMANAL (Body Parameters)

{
    "firstExecution": "2023-12-13T12:15:00-03:00",
    "recurrent": true,
    "executionParameter": {
        "company": [
            "T1"
        ],
        "branch": [
            "T1/M SP 01 ",
            "T1/M SP 02 ",
            "T1/M PR 01 "
        ],
        "moduleid": 5,
        "userid": "000000",
        "description": "Agendamento SEMANAL",
        "companybranch": "T1/M SP 01 ;T1/M SP 02 ;T1/M PR 01 ;"
    },
    "weekly": {
        "daysOfWeek": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Friday",
            "Thursday"
        ],
        "hour": 0,
        "minute": 0
    },
    "rangeExecutions": {
        "frequency": {
            "type": "hour",
            "value": 24
        },
        "rangeLimit": {
            "hour": 23,
            "minute": 59
        }
    },
    "processID": "TSTEMP",
    "status": "active"
}


Exemplo DIARIO (Body Parameters)

{
    "firstExecution": "2023-12-13T12:22:00-03:00",
    "recurrent": true,
    "executionParameter": {
        "company": [
            "T1"
        ],
        "branch": "",
        "moduleid": 2,
        "userid": "000000",
        "description": "Agendamento DIARIO",
        "companybranch": "T1;"
    },
    "daily": {
        "hour": 12,
        "minute": 0
    },
    "rangeExecutions": {
        "frequency": {
            "type": "minute",
            "value": 30
        },
        "rangeLimit": {
            "hour": 17,
            "minute": 0
        }
    },
    "processID": "TSTEMP",
    "status": "active"
}


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)
200SuccessNão háNão há
400Bad RequestNão háNão há


Response: 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"
}