Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Objetivo:
A finalidade deste método é possibilitar a inclusão de Agendamentos do Smart Schedule.
post
Painel | ||
---|---|---|
| ||
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 | arrayArray(character) | código do grupo de empresas | X | |
branch | arrayArray(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
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
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:
rangeExecutionsweekly
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
---|
day |
Numeric |
Dia de |
execução | X |
hour |
Numeric |
Hora de execução |
X |
Parâmetros rangeExecutions: frequency
minute | Numeric | Minuto de execução |
X |
Parâmetros
rangeExecutionsbody:
rangeLimitmontly
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 |
Sunday;
Monday;
Tuesday;
Wednesday;
Thursday;
Friday;
Saturday;
Exemplo UNICA (Body Parameters)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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)
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 UNICA (Body Parameters)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Bloco de código | ||||||||
| ||||||||
{
"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)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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, "useridfirstExecution": "000000", "description": "Agendamento SEMANAL", "MV_PAR01": "000001 2023-12-13T12:28:00-03:00", "recurrent": false, "executionParameter": { "company": [ "T2" ], "branch": "", "MV_PAR02moduleid": "9999996, "userid": "000000", "description": "Agendamento UNICO", "companybranch": "T2;" }, "processID": "TSTEMP", "status": "active" } |
Exemplo MENSAL (Body Parameters)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ ", "MV_PAR03"firstExecution": "2023-12-12T15:07:00-03:00", "processID": "Date(20110101)TSTEMP", "MV_PAR04executionParameter": "Date(20291231)",{ "MV_PAR05company": 2,[ "MV_PAR06": "C7_DESCRI "T1", "T2" ], "branch": "", "moduleid": 5, "userid": "000000", "description": "TESTE ", "MV_PAR07companybranch": 1,"T1;T2;" }, "MV_PAR08monthly": 1,{ "MV_PAR09day": 31, "MV_PAR10hour": 28, "MV_PAR11minute": 1,0 }, "MV_PAR12rangeExecutions": "",{ "MV_PAR13frequency": "{ "type": "minute", "value": 30 }, "rangeLimit": { "hour": 12, ", "MV_PAR14minute": 20, "title": "", "printFormatday": 1,10 "fileMail} }, "recurrent": ""true, "printTypestatus": "active" } |
Exemplo SEMANAL (Body Parameters)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ 1, "sheetFormatfirstExecution": 1"2023-12-13T12:15:00-03:00", "MV_FOR01recurrent": ""true, "MV_FOR02"executionParameter": "",{ "MV_FOR03company": "", [ "MV_FOR04": "T1", "MV_FOR05": ""], "MV_FOR06branch": "", [ "MV_FOR07": "T1/M SP 01 ", "MV_FOR08": "T1/M SP 02 ", "MV_FOR09": "", "T1/M PR 01 "MV_FOR10": "", "MV_FOR11": ""], "MV_FOR12moduleid": ""5, "MV_FOR13userid": "000000", "MV_FOR14description": "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": "MATR110TSTEMP", "status": "active" } |
Exemplo DIARIO (Body Parameters)
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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) |
200 | Success | Não há | Não há |
400 | Bad Request | Não há | Não há |
Response: application/json, text/json
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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" } |