Histórico da Página

Objetivo:

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

post

Painel

title	Exemplos de uso

api/framework/v1/smartSchedApi

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

Exemplo (Body Parameters)

Bloco de código

language	js
theme	Midnight
title	Exemplo de body

{
    "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;

Exemplo UNICA (Body Parameters)

Bloco de código

language	js
theme	Midnight
title	Body Parameters
collapse	true

{
    "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)

Bloco de código

language	js
theme	Midnight
title	Body Parameters
collapse	true

{
    "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

language	js
theme	Midnight
title	Body Parameters
collapse	true

{
    "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",
        "MV_PAR01": "000001                                                      ",
        "MV_PAR02": "999999                                                      ",
        "MV_PAR03": "Date(20110101)",
        "MV_PAR04": "Date(20291231)",
        "MV_PAR05": 2,
        "MV_PAR06": "C7_DESCRI                                                   ",
        "MV_PAR07": 1,
        "MV_PAR08": 1,
        "MV_PAR09": 3,
        "MV_PAR10": 2,
        "MV_PAR11": 1,
        "MV_PAR12": "",
        "MV_PAR13": "                                                            ",
        "MV_PAR14": 2,
        "title": "",
        "printFormat": 1,
        "fileMail": "",
        "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 ;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": "MATR110",
    "status": "active"
}

Exemplo DIARIO (Body Parameters)

Bloco de código

language	js
theme	Midnight
title	Body Parameters
collapse	true

{
    "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

language	js
theme	RDark
title	200 - Success
collapse	true

{
    "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

isNewScheduleBooleanjobscheduleidprocessIDrecurrentstatusmanageable

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Objetivo:

post

Parâmetros body

Parâmetros body: executionParameter

Parâmetros body: daily

Parâmetros body: weekly

Parâmetros body: montly

Parâmetros body: rangeExecutions

Parâmetros rangeExecutions: frequency

Parâmetros rangeExecutions: rangeLimit

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Formatos de Resposta (Response Formats)