Histórico da Página

...

Disponibilização de api para criar pedido de execução para execução através do Datasul Automação de Tarefas - Novo RPW.

02. CRIAÇÃO DE PEDIDOPOSTPOST

Estado

colour	Green
title	POST

/api/framework/v1.1/jobScheduler

...

Expandir

title	Body

Bloco de código

language	actionscript3
theme	RDark

{ 
    "processID": "string",
	"firstExecution": "dateTime"
    "executionParameter": {
        "parametros": [  
	        { 
                "chave": "rpwServer",    
                "valor": "stringserver" 
            },
	        { 
                "chave": "RPW_PROGRAM",  
                "valor": "stringprogram" 
            },
			{ 
                "chave": "RPW_PRG_EMS5", 
                "valor": "logicalisEMS5" 
            },
     		{
   
	     		"chave": "RPW_PRG_VERS",
  { 
     		"valor": "version"
      	    "chave": "arquivo", },
 	     
   { 
                "valorchave": "string" 
RPW_PED_EXEC_PAI",      
       },
	        { 
  "valor": "numPedExec" 
            }, 
 "chave": "RPW_PED_EXEC_PAI",                { 
                "valorchave": "integer" 
            },
	        { 
                "chave": "RPWRPW_SEND_EMAIL",      
                "valor": "booleansendEmail" 
            },
	        {
	        	"parametros_negocio": [
					{
                        "chave" :"string", 
                        "valor" : "string", 
                        "tipo": "string"
                    }      		
	        	]
	        }
	   ]  
	}
}

Expandir

title

Exemplo

Parâmetros do pedido

Campo	Descrição	Obrigatório
processID	Identificador do processo (rotina) que será executado	Sim
firstExecution	Data/hora para execução do primeiro pedido, exemplo: "2022-11-20T12:00:00-3:00",	Não
executionParameter	Objeto com parâmetros de execução	Sim
{ "chave": "rpwServer", "valor":"server" }	"server" deve conter o servidor RPW responsável pela execução do pedido	Sim
{ "chave": "RPW_PROGRAM", "valor": "program" },	"program" deve conter o nome externo do programa a ser executado	Sim
{ "chave":

Bloco de código

language	actionscript3
theme	RDark

{ "processID": "btr005aa", "executionParameter": { "parametros": [ { "chave": "rpwServer", "valor": "{{rpwServer}}" }, { "chave": "RPW_PROGRAM", "valor": "btb/btr00527.p" }, { "chave":

"RPW_PRG_EMS5",

"valor":

"isEMS5" }	"isEM5" deve ser "yes" caso seja um programa EMS5, e "no" para demais programas	Sim
{ "chave": "RPW_PRG_VERS", "valor": "version" }	"version" deve conter a versão do programa a ser executado	Sim
{ "chave": "RPW_PED_EXEC_PAI", "valor": "numPedExec" }	"numPedExec" deve ser preenchido com o número do pedido de execução pai, caso exista	Não
{ "chave": "RPW_SEND_EMAIL", "valor": "sendEmail" }	"sendEmail" deve ser "yes" caso o pedido deva enviar e-mail, "no" caso não deva'	Não
{ "parametros_negocio": [ parameters ] }	parameters deve ser preenchido com os parâmetros esperados pelo programa ser executado, os parâmetros devem ser inseridos no formato: { "chave": "nomeParametro", "valor": "valorParametro", "tipo":"tipoParametro" }	Sim

Não

Expandir

title	Exemplo

Bloco de código

language	actionscript3
theme	RDark

{
  "processID": "btr005aa",
  "executionParameter": {
    "parametros": [
      {
        "chave": "rpwServer",no"
      },
      {
        "chave": "RPW_PRG_VERS",
        "valor": "2.00.00.002"
      },
      {
        "chave": "arquivo",
        "valor": "btr00527.log"
      },
      {
        "parametros_negocio": [
          {
            "chave": "destino",
            "valor": 2,
            "tipo": "integer"
          },
          {
            "chave": "arquivo",
            "valor": "BTR005AA.LST",
            "tipo": "character"
          },
          {
            "chave": "usuario",
            "valor": "super",
            "tipo": "character"
          },"valor": "{{rpwServer}}"
      },
      {
            "chave": "data-execRPW_PROGRAM",
            "valor": "08/03/19",btb/btr00527.p"
      },
      {
        "tipochave": "dateRPW_PRG_EMS5",
        "valor":  },
"no"
      },
      {
            "chave": "hora-execRPW_PRG_VERS",
            "valor": 55030,"2.00.00.002"
      },
      "tipo": "integer"{
          },"parametros_negocio": [
          {
            "chave": "parametrodestino",
            "valor": "false"2,
            "tipo": "logicalinteger"
          },
          {
            "chave": "formatoarquivo",
            "valor": 2"BTR005AA.LST",
            "tipo": "integercharacter"
          },
          {
            "chave": "v_num_tip_aces_usuarusuario",
            "valor": 0"super",
            "tipo": "integercharacter"
          },
          {
            "chave": "epdata-codigoexec",
            "valor": "FND08/03/19",
            "tipo": "characterdate"
          },
          {
            "chave": "chora-classificacaoexec",
            "valor": "Aplicativo"55030,
            "tipo": "characterinteger"
          },
          {
            "chave": "c-cod_catal_img-iniparametro",
            "valor": "false",
            "tipo": "characterlogical"
          },
          {
            "chave": "c-cod_catal_img-fimformato",
            "valor": "ZZZZZZZZ"2,
            "tipo": "characterinteger"
          },
          {
            "chave": "c-des_catal_img-iniv_num_tip_aces_usuar",
            "valor": ""0,
            "tipo": "characterinteger"
          },
          {
            "chave": "c-des_catal_img-fimep-codigo",
            "valor": "ZZZZZZZZFND",
            "tipo": "character"
          },
          {
            "chave": "c-cod_aplicat_dtsul-iniclassificacao",
            "valor": "Aplicativo",
            "tipo": "character"
          },
          {
            "chave": "c-cod_aplicatcatal_dtsulimg-fimini",
            "valor": "ZZZZZZZZ",
            "tipo": "character"
          },
        ]  {
      }
    ]
  }
}

Expandir

title	Parâmetros do pedido

Campo

Tipo

Descrição

Obrigatório

processID

string

Identificador do processo (rotina) que será executado

Sim

executionParameter

Json Object

Parâmetros para execução do processo

Sim

firstExecution

string(dateTime)

Data/hora para execução do primeiro pedido

"chave": "c-cod_catal_img-fim",
            "valor": "ZZZZZZZZ",
            "tipo": "character"
          },
          {
            "chave": "c-des_catal_img-ini",
            "valor": "",
            "tipo": "character"
          },
          {
            "chave": "c-des_catal_img-fim",
            "valor": "ZZZZZZZZ",
            "tipo": "character"
          },
          {
            "chave": "c-cod_aplicat_dtsul-ini",
            "valor": "",
            "tipo": "character"
          },
          {
            "chave": "c-cod_aplicat_dtsul-fim",
            "valor": "ZZZZZZZZ",
            "tipo": "character"
          }
        ]
      }
    ]
  }
}

Expandir

title	Parâmetros de agenda

Campo	Tipo	Descrição	Obrigatório
recurrent	logical	Indica se a execução do job deve ocorrer mais de uma vez	Não
daily	Json Object	Para criação de agenda diária	Não
daily.hour	integer	Hora da execução da agenda	Não
daily.minute	integer	Minuto da execução da agenda	Não
weekly	Json Object	Para criação de agenda semanal	Não
weekly.daysOfWeek	Json Array	Lista com os dias da semana de execução da agenda	Não
weekly.hour	integer	Hora de execução da agenda	Não
weekly.minute	integer	Minuto de execução da agenda	Não
monthly	Json Object	Para criação de agenda semanal	Não
monthly.day	integer	Dia de execução da agenda	Não
monthly.hour	integer	Hora de execução da agenda	Não
monthly.minute	integer	Minuto de execução da agenda	Não
rangeExecutions	Json Object	Objeto com as informações do range de execuções	Não
rangeExecutions.frequency	Json Object	Objeto com as informações de frequência	Não
rangeExecutions.frequency.type	string	Indica qual o tipo de repetição para os horários a serem gerados. Se 'day', gerará horários incrementando dias; se 'hour', gerará horários incrementando horas; se 'minute', gerará horários incrementando minutos	Não
rangeExecutions.frequency.value	integer	Frequência do tipo do intervalo	Não
rangeExecutions.rangeLimit	Json Object	Objeto com as informações do limtie de range da agenda	Não
rangeExecutions.rangeLimit.day	integer	Dia limite para término da agenda (válido somente para Monthly)	Não
rangeExecutions.rangeLimit.hour	integer	Hora limite para término da agenda	Não
rangeExecutions.rangeLimit.minute	integer	Minuto limite, pertencente à hora, para término da agenda	Não

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

02. CRIAÇÃO DE PEDIDOPOSTPOST