- Criado por Leonardo Castro da Silva, última alteração em 20 dez, 2023
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
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
firstExecution | Character | Data e hora inicial, para primeira execução. | 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 | Valor Padrão |
---|---|---|---|---|
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 | |
title | Character | Título da Impressão. | ||
printFormat | Numeric | Formato de Impressão (1-Web Spool/2-Email). | ||
fileMail | Character | Nome do arquivo de impressão ou e-mail destinatário. | ||
printType | Numeric | Tipo de impressão (1-HTML/2-PDF/3-Planilha). | ||
sheetFormat | Numeric | 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): Obs.: preenchimento deve respeitar a tipagem de cada pergunte definido no dicionário SX1, como: caractere, numérico ou data. | ||
MV_FOR?? | Character | Fórmula(expressão) a ser executada para preenchimento do parâmetro. Formato Pergunte(SX1): Obs.: Formulas são utilizadas apenas quando os parâmetros são definidos via Pergunte(SX1). |
Parâmetros body: daily
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
---|---|---|---|---|
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 | Valor Padrão |
---|---|---|---|---|
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 | Valor Padrão |
---|---|---|---|---|
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 | Obrigatório | Valor Padrã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; |
Exemplo (Body Parameters) UNICA
{ "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 (Body Parameters) MENSAL com MULTI-FILIAIS, PARAMETROS(SX1), PARAMETROS DE IMPRESSÃO e RECORRENCIA.
{ "firstExecution": "2023-12-20T17:33:00-03:00", "recurrent": true, "executionParameter": { "company": [ "T1" ], "branch": [ "T1/M SP 01", "T1/M SP 02" ], "moduleid": 5, "userid": "000000", "description": "Agendamento Automatico Mensal", "MV_PAR01": "000001 ", "MV_PAR02": "999999 ", "MV_PAR03": "Date(20230101)", "MV_PAR04": "Date(20231231)", "MV_PAR05": 2, "MV_PAR06": "C7_DESCRI ", "MV_PAR07": 1, "MV_PAR08": 1, "MV_PAR09": 3, "MV_PAR10": 1, "MV_PAR11": 1, "MV_PAR12": "", "MV_PAR13": " ", "MV_PAR14": 1, "title": "Automática", "printFormat": 1, "fileMail": "arquivo", "printType": 1, "sheetFormat": 1, "MV_FOR01": "", "MV_FOR02": "", "MV_FOR03": "", "MV_FOR04": "", "MV_FOR05": "", "MV_FOR06": "", "MV_FOR07": "", "MV_FOR08": "", "MV_FOR09": "", "MV_FOR10": "", "MV_FOR11": "", "MV_FOR12": "", "MV_FOR13": "", "MV_FOR14": "", "companybranch": "T1/M SP 01;T1/M SP 02;" }, "monthly": { "day": 10, "hour": 10, "minute": 0 }, "rangeExecutions": { "frequency": { "type": "hour", "value": 2 }, "rangeLimit": { "hour": 18, "minute": 0, "day": 20 } }, "processID": "MATR110", "status": "active" }
Exemplo (Body Parameters) SEMANAL com MULTI-FILIAIS.
{ "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 (Body Parameters) DIARIO com PARAMDEF(SA1) e PARÂMETROS DE IMPRESSÃO FORMATO PLANILHA.
{ "firstExecution": "2023-12-20T17:50:00-03:00", "recurrent": false, "executionParameter": { "company": [ "T2", "T1" ], "branch": [ "T2/D MG 01", "T1/D RJ 01" ], "moduleid": 1, "userid": "000000", "description": "Agendamento Diário PARAMDEF", "order": 1, "paramdef1": "00000101", "paramdef2": "99999901", "title": "", "printFormat": 2, "fileMail": "[email protected]", "printType": 3, "sheetFormat": 3, "companybranch": "T2/D MG 01;T1/D RJ 01;" }, "daily": { "hour": 10, "minute": 0 }, "rangeExecutions": { "frequency": { "type": "minute", "value": 30 }, "rangeLimit": { "hour": 16, "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) |
200 | Success | Não há | Não há |
400 | Bad Request | Nã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" }
- Sem rótulos