Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Sumário

...


Índice
excludeSumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

Para mais informações sobre consumo de Licença, Veja Aqui.


1 - Métodos

...

     Serão apresentados 4 métodos, os quais foram implementados na API de UsuáriosJobScheduler, são eles:

  • GET
  • POST
  • PUT
  • DELETE

Informações
iconfalse
titleObservação:

Caso o Job não seja recorrente o comportamento será o seguinte:

Ainda não executado:  "status": "active"

Executado com ou sem erro:  "status": "completed"

Cancelado ou Desativado: "status": "inactive"


Job recorrente:

Ainda não foi executado: "status": "active"

Todas as outras opções: "status": "inactive",


A Api de JobScheduler também realiza buscas pelo status do agendamento, são eles:

  • Sucess
  • Pending
  • Running
  • Failure

1.1 - GET

1.1.1 - Get All (Recuperar Todos os Agendamentos de Job)



Recorrência do Job:

Âncora
recurrencyType
recurrencyType

Um job pode ser criado para ser agendado e pode ser criado com alguma recorrência. 

São permitidos os seguintes tipos de recorrência: Diário (daily), semanal (weekly) e mensal (monthly).

No swagger é possível visualizar o schema desses itens. Veja a seguir um exemplo:

Bloco de código
languagejs
"daily": {
         "year": 0,
       "month": 0,
       "day": 0,
       "hour": 0,
       "minute": 0
}
"weekly": {
       "daysOfWeek": [
              "string"
       ],
       "hour": 0,
       "minute": 0
}
"monthly": {
       "day": 0,
       "hour": 0,
       "minute": 0
},
  • Para recorrências do tipo daily, a propriedade "firstExecution" enviada é usada apenas para identificar o fuso horário do cliente e são considerados os valores do objeto daily para criar a data de agendamento.
    Como o tipo é diário, ele continuará executando todos os dias nas horas definidas em hour e minute.

1.1 - GET

...

1.1.1 - Get All (Recuperar Todos os Agendamentos de Job)

...

Informações
iconfalse
titleGetAll
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
Informações
iconfalse
title1.1.1 GetAll
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
{ "hasNext": true, "items": [ { "scheduleID": "100001", "status": "success", "scheduleDate": "17/11/2008 17:16:01", "executionDate": "17/11/2008 17:16:05", "executionID": "1", "user": "", "recurrent": false, "execution": { "processID": "PrjConcederPermissaoAcessoProjetoProc", "status": "success",
            "
scheduleDate
jobScheduleID": "
17/11/2008 17:16:01
1",
            
"
executionDate
status": "
17/11/2008 17:16:05
completed",
            
"
executionID
lastModified": "
1
2018-12-06T14:41:52",
            
"
scheduleID
processID": "
100001
GlbCopyPermisUsrProc",
            
"firstExecution": "2018-12-06T14:41:52",
            "user": "mestre",
            
"recurrent": false,
            "executionParameter": {
                
"
Permissoes
SourceUsuario": 
null
"mestre",
                "
Initialized
RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "
PrimaryKeyList
CodSistema": 
[
"G",
                "NewUser": {
       
[
             "Usuario": null,
              
1,
      "Nome": null,
                    
0
"Senha": null,
                    "Email": null,
   
]
                 
]
"codAcesso": null,
                    "
PrimaryKeyNames
UsuariodeRede": 
[
null
                },
        
"CODCOLIGADA",
        "Initialized": true,
                "
IDPRJ
PrimaryKeyList": [
                    
],
[
                    
"PrimaryKeyTableName": null,
    "Fabio.nunes"
                    
"OnlineMode": false,
]
                
"SyncExecution": false
],
                "
HideProgressDialog
PrimaryKeyNames": 
false,
[
                    "
SaveParamsExecution
CODUSUARIO"
: false,

                ],
    
"CodUsuario":
 
null,
           "PrimaryKeyTableName": "GUSUARIO",
        
"Context":
 
{
       "OnlineMode": false,
                "
$id
SyncExecution": 
"1"
false,
                "HideProgressDialog": false,
        
"_params":
 
{},
       "SaveParamsExecution": false,
                "
Environment
CodUsuario": 
0
"mestre",
                
},
"Context": {
                    "
UserName
$id": "
Breno
1",
                    "
ConnectionId
_params": 
null,
{
                        "
ConnectionString
$EXERCICIOFISCAL": 
null
2,
                        "
DriverType
$CODLOCPRT": 
null
12,
                        "
Ip
$CODTIPOCURSO": 
"10.31.7.80"
-1,
                        "
HostName
$EDUTIPOUSR": "
RM0005748
-1",
                        "
JobServerHostName
$CODUNIDADEBIB": 
"RM0005748"
-1,
                        "
ActionName
$CODCOLIGADA": 
"PrjConcederPermissaoAcessoProjetoAction"
1,
                        "
MasterActionName
$RHTIPOUSR": 
null
"-1",
                        "
ActionModule
$CODIGOEXTERNO": 
null
"-1",
                        "
JobID
$CODSISTEMA": 
{
"G",
                        "
ID
$CODUSUARIOSERVICO": 
-1
"",
                        "
ExecID
$CODUSUARIO": 
-1
"mestre",
                        "
IsPriorityJob
$IDPRJ": 
false
-1,
                        "
Children
$CHAPAFUNCIONARIO": 
[]
"-1",
                        
},
"$CODFILIAL": 1
                    
"ExecutionId": "1c19b022-c065-42d2-ae20-647259c2e2c0"
},
                    "
ProcessName
Environment":
"Conceder permissão de Acesso a Projetos",
 1
                },
                "
ServerName
UserName": "
PrjConcederPermissaoAcessoProjetoProc
mestre",
                
"
ServiceInterface
ConnectionId": null,
                
"
Scheduler
ConnectionString": 
2
null,
                
"
UseJobMonitor
DriverType": 
false
null,
                
"
ScheduleDateTime
Ip": "
2008-11-17T17:15:54.1180698-02:00
10.31.4.57",
                "
CanSendMail
HostName": 
false
"BHD050100279",
                
"
CanWaitSchedule
JobServerHostName": 
false
"BHD050100279",
                
"
SendMail
ActionName": 
false
"GlbActionProcCopyPermisUsr",
                "
FriendlyLogs
MasterActionName": 
null
"GlbUsuarioAction",
                "
SuccessMessage
ActionModule": "
Processo executado com sucesso
G",
                
"
FailureMessage
JobID": 
"Falha na execução do processo",
{
                    "
SaveLogInDatabase
ID": 
false
1,
                    "
StatusMessage
ExecID": 
null
1,
                    "
WaitSchedule
IsPriorityJob": false,
                    "
IsolateProcess
Children": 
false,
[]
                
"DisableIsolateProcess": false
},
                
"
NetworkUser
ShowReExecuteButton": 
null
true,
                
"
CustomData
ExecutionId": 
null
"c5665069-1d2b-482f-854a-88f3e7649f1e",
                "
CanParallelize
ProcessName": 
false,
"Cópia de Permissões de Usuários",
                "
ShouldParallelize
ServerName": 
false
"GlbCopyPermisUsrProc",
                "
QuantityOfSplits
ServiceInterface": 
0
null,
                
"
MinimumQuantityOfPrimaryKeysPerProcess
Scheduler": 
0
1,
                
"
MaximumQuantityOfPrimaryKeysPerProcess
UseJobMonitor": 
0
true,
                "
NotifyFluig
ScheduleDateTime": 
false,
"2018-12-06T14:41:40.809678-02:00",
                "CanSendMail": false,
                "
NotifyEmail
CanWaitSchedule": false,
                "SendMail": false,
                "
NotifyEmailList
FriendlyLogs": null,
                "SuccessMessage": "Processo executado com 
}
sucesso",
                "
return
FailureMessage": "Falha na execução do processo",
            
}
    "SaveLogInDatabase": true,
            
}
    
] }
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

1.1.2 - Order(Resultado Ordenado)

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações
iconfalse
title1.1.2 Order (Asc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?order=scheduleID

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
{ "hasNext": true, "items": [ {
"StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "fabio.nunes",
                "CustomData": null,
                "CanParallelize": true,
                "
scheduleID
ShouldParallelize": 
"100001"
false,
                "
status
QuantityOfSplits": 
"success"
0,
                "
scheduleDate
MinimumQuantityOfPrimaryKeysPerProcess": 
"17/11/2008 17:16:01"
1,
                "
executionDate
MaximumQuantityOfPrimaryKeysPerProcess": 
"17/11/2008 17:16:05"
1000,
                "
executionID
NotifyFluig": 
"1"
false,
                "
user
NotifyEmail": 
""
false,
                "
recurrent
NotifyEmailList": 
false,
null
            
"execution": {
}
        },
        
"processID": "PrjConcederPermissaoAcessoProjetoProc",
{
            
"
status
jobScheduleID": "
success
2",
            "
scheduleDate
status": "
17/11/2008 17:16:01
active",
            
"
executionDate
lastModified": "
17/11/2008 17:16:05
2018-12-06T14:43:36",
            
"
executionID
processID": "
1
GlbWorkflowExecProc",
            
"
scheduleID
firstExecution": "
100001
2018-12-06T14:50:00",
            
"
"user": "mestre",
            
"recurrent": 
false
true,
            "executionParameter": {
                
"
Permissoes
CodColigada": 
null
1,
                
"
Initialized
IdWorkflow": 
false
45,
                
"
PrimaryKeyList
DataSet": 
[
null,
                "Parameters": null,
       
[
         "OwnerData": null,
                
1
"Initialized": true,
                "PrimaryKeyList": [],
           
0
     "PrimaryKeyNames": null,
                
]
"PrimaryKeyTableName": null,
                
]
"OnlineMode": false,
                
"
PrimaryKeyNames
SyncExecution": 
[
false,
                "HideProgressDialog": false,
          
"CODCOLIGADA",
      "SaveParamsExecution": false,
                "CodUsuario": "
IDPRJ
mestre",
                
],
"Context": {
                    "
PrimaryKeyTableName
$id": 
null
"1",
                    "
OnlineMode
_params": 
false,
{
                        "
SyncExecution
$EXERCICIOFISCAL": 
false
2,
                        "
HideProgressDialog
$CODLOCPRT": 
false
12,
                    
"SaveParamsExecution
    "$CODTIPOCURSO": 
false
-1,
                        "
CodUsuario
$EDUTIPOUSR": 
null
"-1",
                        "
Context
$CODUNIDADEBIB": 
{
-1,
                        "
$id
$CODCOLIGADA": 
"
1
"
,
                        "
_params
$RHTIPOUSR": 
{}
"-1",
                        "
Environment
$CODIGOEXTERNO": 
0
"-1",
                        
}
"$CODSISTEMA": "G",
                        "
UserName
$CODUSUARIOSERVICO": "
Breno
",
                        "
ConnectionId
$CODUSUARIO": 
null
"mestre",
                        "
ConnectionString
$IDPRJ": 
null
-1,
                        "
DriverType
$CHAPAFUNCIONARIO": 
null
"-1",
                        "
Ip
$CODFILIAL": 
"10.31.7.80",
1
                    
"HostName": "RM0005748"
},
                    "
JobServerHostName
Environment": 
"RM0005748",
1
                },
                "
ActionName
UserName": "
PrjConcederPermissaoAcessoProjetoAction
mestre",
                
"
MasterActionName
ConnectionId": null,
                
"
ActionModule
ConnectionString": null,
                
"
JobID
DriverType": 
{
null,
                "Ip": "10.31.4.57",
        
"ID":
 
-1,
       "HostName": "BHD050100279",
                "
ExecID
JobServerHostName": 
-1
"BHD050100279",
                "ActionName": "GlbWorkflowExecAction",
        
"IsPriorityJob":
 
false,
       "MasterActionName": null,
                "
Children
ActionModule": 
[]
"G",
                
},
"JobID": {
                    "
ExecutionId
ID": 
"1c19b022-c065-42d2-ae20-647259c2e2c0"
2,
                    "
ProcessName
ExecID": 
"Conceder permissão de Acesso a Projetos"
1,
                    "
ServerName
IsPriorityJob": 
"PrjConcederPermissaoAcessoProjetoProc"
false,
                    "
ServiceInterface
Children": 
null,
[]
                
"Scheduler": 2
},
                
"
UseJobMonitor
ShowReExecuteButton": 
false
true,
                "
ScheduleDateTime
ExecutionId": "
2008
a6bad34f-2946-
11-17T17:15:54.1180698-02:00
46ca-b69b-7434004fc0f6",
                "
CanSendMail
ProcessName": 
false
"Executar Fórmula Visual",
                
"
CanWaitSchedule
ServerName": 
false
"GlbWorkflowExecProc",
                
"
SendMail
ServiceInterface": 
false
null,
                
"
FriendlyLogs
Scheduler": 
null
1,
                
"
SuccessMessage
UseJobMonitor": 
"Processo executado com sucesso"
true,
                
"
FailureMessage
ScheduleDateTime": "
Falha na execução do processo
2018-12-06T14:43:26.9732933-02:00",
                "
SaveLogInDatabase
CanSendMail": false,
                
"
StatusMessage
CanWaitSchedule": 
null
false,
                
"
WaitSchedule
SendMail": false,
                
"
IsolateProcess
FriendlyLogs": 
false
null,
                "SuccessMessage": "Processo executado com sucesso"
DisableIsolateProcess": false
,
                
"
NetworkUser
FailureMessage": 
null,
"Falha na execução do processo",
                "
CustomData
SaveLogInDatabase": 
null
true,
                
"
CanParallelize
StatusMessage": 
false
null,
                
"
ShouldParallelize
WaitSchedule": false,
                
"
QuantityOfSplits
IsolateProcess": 
0
false,
                
"
MinimumQuantityOfPrimaryKeysPerProcess
DisableIsolateProcess": 
0
false,
                "NetworkUser": "fabio.nunes",
                "
MaximumQuantityOfPrimaryKeysPerProcess
CustomData": 
0
null,
                "CanParallelize": true,
                "
NotifyFluig
ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "
NotifyEmail
MinimumQuantityOfPrimaryKeysPerProcess": 
false
1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
          
"NotifyEmailList
      "NotifyFluig": 
null
false,
                "NotifyEmail": 
}
false,
                "
return
NotifyEmailList": 
""
null
            },
           
}
 "weekly": {
          
] }
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?order=-scheduleID

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
{ "hasNext": true, "items": [
      "daysOfWeek": [
                    "Monday",
        
{
            "
scheduleID
Tuesday"
: "102776",
,
                   
"status":
 "
success
Thursday"
,

            
"scheduleDate": "26/10/2018 10:37:51",
    ],
                "
executionDate
hour": 
"26/10/2018 10:38:00"
14,
                "
executionID
minute": 
"1",
50
            }
  
"user":
 
"rm",
     },
       
"recurrent": false,
 {
            "
execution
jobScheduleID": 
{
"3",
            
"
processID
status": "
RMSSendCriticalLogProc
active",
            
"
status
lastModified": "
success
2018-12-06T14:43:50",
            "
scheduleDate
processID": "
26/10/2018 10:37:51
GlbWorkflowExecProc",
            "
executionDate
firstExecution": "
26/10/2018 10:38
2018-12-06T17:00:00",
            
"
executionID
user": "
1
mestre",
            
"
scheduleID
recurrent": 
"102776"
true,
            "executionParameter": {
                "
user
CodColigada": 
"rm"
1,
                "
recurrent
IdWorkflow": 
false
45,
                "
executionParameter
DataSet": 
{
null,
                "Parameters": null,
                "
LastErrorSent
OwnerData": 
"0001-01-01T00:00:00-02:00"
null,
                
"Initialized": true,
                "PrimaryKeyList": [],
                
"PrimaryKeyNames": null,
                
"PrimaryKeyTableName": null,
                
"OnlineMode": false,
                
"SyncExecution": false,
                "HideProgressDialog": false,
                
"SaveParamsExecution": false,
                
"CodUsuario": 
null
"mestre",
                
"Context": {
                    
"$id": "1",
                    "_params": {
                        
"
$CODCOLIGADA
$EXERCICIOFISCAL": 
0
2,
                        
"
$CODSISTEMA
$CODLOCPRT": 
"G"
12,
                        
}
"$CODTIPOCURSO": -1,
                        "
Environment
$EDUTIPOUSR": 
0
"-1",
                    
}
    "$CODUNIDADEBIB": -1,
                        "
UserName
$CODCOLIGADA": 
"rm"
1,
                        "
ConnectionId
$RHTIPOUSR": 
null
"-1",
                        "
ConnectionString
$CODIGOEXTERNO": 
null
"-1",
                        "
DriverType
$CODSISTEMA": 
null
"G",
                        "
Ip
$CODUSUARIOSERVICO": "
127.0.0.1
",
                        "
HostName
$CODUSUARIO": "
localhost
mestre",
                        "
JobServerHostName
$IDPRJ": 
"BHD050102417"
-1,
                        "
ActionName
$CHAPAFUNCIONARIO": 
null
"-1",
                        "
MasterActionName
$CODFILIAL": 
null,
1
                    
"ActionModule": null
},
                    "
JobID
Environment": 
{
1
                },
        
"ID":
 
102776,
       "UserName": "mestre",
                "
ExecID
ConnectionId": 
1
null,
                "ConnectionString": null,
       
"IsPriorityJob": false,
         "DriverType": null,
                "
Children
Ip": 
[]
"10.31.4.57",
                
}
"HostName": "BHD050100279",
                
"ShowReExecuteButton": true,
"JobServerHostName": "BHD050100279",
                "
ExecutionId
ActionName": "
a88518a8-56c4-43d7-b8f0-c97eda42e5d9
GlbWorkflowExecAction",
                
"
ProcessName
MasterActionName": null,
                "
ServerName
ActionModule": 
null
"G",
                "
ServiceInterface
JobID": 
null,
{
                    "
Scheduler
ID": 
1
3,
                    "
UseJobMonitor
ExecID": 
true
1,
                    "
ScheduleDateTime
IsPriorityJob": 
"2018-10-26T10:37:51.4185986-02:00"
false,
                    "
CanSendMail
Children": 
false,
[]
                
"CanWaitSchedule": false
},
                
"
SendMail
ShowReExecuteButton": 
false
true,
                
"
FriendlyLogs
ExecutionId": 
null
"ef13b977-7293-4d52-91a6-44694cbeddc9",
                "
SuccessMessage
ProcessName": "
Processo
Executar 
executado
Fórmula 
com sucesso
Visual",
                
"
FailureMessage
ServerName": "
Falha na execução do processo
GlbWorkflowExecProc",
                
"
SaveLogInDatabase
ServiceInterface": 
true
null,
                
"
StatusMessage
Scheduler": 
null
1,
                "
WaitSchedule
UseJobMonitor": 
false
true,
                "ScheduleDateTime": "2018-12-06T14:43:40.8536812-02:00",
                "
IsolateProcess
CanSendMail": false,
                
"
DisableIsolateProcess
CanWaitSchedule": false,
                "
NetworkUser
SendMail": 
null
false,
                "
CustomData
FriendlyLogs": null,
                "SuccessMessage": "Processo executado com 
"CanParallelize
sucesso"
: false
,
                
"
ShouldParallelize
FailureMessage": 
false,
"Falha na execução do processo",
                "
QuantityOfSplits
SaveLogInDatabase": 
0
true,
                
"
MinimumQuantityOfPrimaryKeysPerProcess
StatusMessage": 
1
null,
                
"
MaximumQuantityOfPrimaryKeysPerProcess
WaitSchedule": 
1000
false,
                "
NotifyFluig
IsolateProcess": false,
                
"
NotifyEmail
DisableIsolateProcess": false,
                "NetworkUser": "fabio.nunes",
   
"NotifyEmailList
             "CustomData": null,
                
}
"CanParallelize": true,
                "
return
ShouldParallelize": 
""
false,
            
}
    "QuantityOfSplits": 0,
        
}
    
] }
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

1.1.3 - Filter (Resultado filtrado)

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: pending

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?status=pending

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
{ "hasNext": false, "items": [
    "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            
{
},
            "
scheduleID
monthly": 
"100360",
{
                "
status
day": 
"pending"
7,
                "
scheduleDate
hour": 
"26/10/2018 11:00:00"
17,
                "
executionDate
minute": 
"",
0
            }
  
"executionID":
 
"868",
     },
       
"user": "",
 {
            "
recurrent
jobScheduleID": 
true
"4",
            "
weekly
status": 
{
"active",
            
"
daysOfWeek
lastModified": 
[
"2018-12-06T14:44:06",
            "processID": "GlbWorkflowExecProc",
       
"Sunday",
     "firstExecution": "2018-12-07T18:00:00",
            "user": 
"
Monday
mestre",
            "recurrent": true,
        
"Tuesday",
    "executionParameter": {
                "
Wednesday
CodColigada": 1,
                "
Thursday
IdWorkflow": 45,
                
"
Friday
DataSet": null,
                
"
Saturday
Parameters": null,
                "OwnerData": 
]
null,
                "
hour
Initialized": 
11
true,
                "
minute
PrimaryKeyList": 
0
[],
               
}
 "PrimaryKeyNames": null,
                "
execution
PrimaryKeyTableName": 
{
null,
                "
processID
OnlineMode": 
"MntCalcularMediaDiariaIndicadorUsoProc"
false,
                "
status
SyncExecution": 
"success"
false,
                "
scheduleDate
HideProgressDialog": 
"11/06/2009 11:00:00"
false,
                "
executionDate
SaveParamsExecution": 
"04/04/2011 13:56:05"
false,
                "
executionID
CodUsuario": "
1
mestre",
                "
scheduleID
Context": 
"100360",
{
                    "
user
$id": "1",
                    "
recurrent
_params": 
true,
{
                        "
executionParameter
$EXERCICIOFISCAL": 
{
2,
                        "
CodColigada
$CODLOCPRT": 
1
12,
                        "
DataInicial
$CODTIPOCURSO": 
"2008-01-01T00:00:00-02:00"
-1,
                        "
DataFinal
$EDUTIPOUSR": "
2009-06-04T00:00:00-03:00
-1",
                        "
Initialized
$CODUNIDADEBIB": 
false
-1,
                        "
PrimaryKeyList
$CODCOLIGADA": 
[
1,
                        
[
"$RHTIPOUSR": "-1",
                        
1
"$CODIGOEXTERNO": "-1",
                        
"$CODSISTEMA": "
Z000Y0011
G",
                       
]
 "$CODUSUARIOSERVICO": "",
                   
],
     "$CODUSUARIO": "mestre",
                        "
PrimaryKeyNames
$IDPRJ": 
[
-1,
                        "$CHAPAFUNCIONARIO": "
CODCOLIGADA
-1",
                        "
IDOBJOF
$CODFILIAL": 1
                    
]
},
                    "
PrimaryKeyTableName
Environment": 
null,
1
                
"OnlineMode": false
},
                
"
SyncExecution
UserName": 
false
"mestre",
                
"
HideProgressDialog
ConnectionId": 
false
null,
                
"
SaveParamsExecution
ConnectionString": 
false
null,
                "
CodUsuario
DriverType": null,
                
"
Context
Ip": 
{
"10.31.4.57",
                
"
$id
HostName": "
1
BHD050100279",
                "JobServerHostName": "BHD050100279",
       
"_params":
 
{},
        "ActionName": "GlbWorkflowExecAction",
                "
Environment
MasterActionName": 
0
null,
                
}
"ActionModule": "G",
                
"
UserName
JobID": 
"Sara",
{
                    "
ConnectionId
ID": 
null
4,
                    "
ConnectionString
ExecID": 
null
1,
                    "
DriverType
IsPriorityJob": 
null
false,
                    "
Ip
Children": 
"10.31.5.226",
[]
                
"HostName": "RM005762"
},
                
"
JobServerHostName
ShowReExecuteButton": 
"RM005762"
true,
                
"
ActionName
ExecutionId": "
MntCalcularMediaDiariaIndicadorUsoAction
c496de16-b989-4292-9c10-1991d87f83a8",
                "ProcessName": "Executar Fórmula 
Visual"
MasterActionName": null
,
                
"
ActionModule
ServerName": "
N
GlbWorkflowExecProc",
                "
JobID
ServiceInterface": 
{
null,
                "Scheduler": 1,
        
"ID":
 
-1,
       "UseJobMonitor": true,
                "
ExecID
ScheduleDateTime": 
-1
"2018-12-06T14:43:54.1360093-02:00",
                
"IsPriorityJob
"CanSendMail": false,
                
"Children
"CanWaitSchedule": 
[]
false,
                
}
"SendMail": false,
                "
ExecutionId
FriendlyLogs": 
"30cda7ed-fa9d-4593-be95-a590f4661b51"
null,
                
"
ProcessName
SuccessMessage": "
Calcular
Processo 
Média
executado 
Diária de Indicador de Uso
com sucesso",
                
"
ServerName
FailureMessage": "
MntCalcularMediaDiariaIndicadorUsoProc",
Falha na execução do processo",
                "
ServiceInterface
SaveLogInDatabase": 
null
true,
                
"
Scheduler
StatusMessage": 
1
null,
                
"
UseJobMonitor
WaitSchedule": 
true
false,
                
"
ScheduleDateTime
IsolateProcess": 
"2009-06-04T15:31:52.7944738-03:00",
false,
                "
CanSendMail
DisableIsolateProcess": false,
                
"
CanWaitSchedule
NetworkUser": 
false
"fabio.nunes",
                
"
SendMail
CustomData": 
false
null,
                
"
FriendlyLogs
CanParallelize": 
null
true,
                
"
SuccessMessage
ShouldParallelize": 
"Processo executado com sucesso"
false,
                
"
FailureMessage
QuantityOfSplits": 
"Falha na execução do processo"
0,
                
"
SaveLogInDatabase
MinimumQuantityOfPrimaryKeysPerProcess": 
false
1,
                "
StatusMessage
MaximumQuantityOfPrimaryKeysPerProcess": 
null
1000,
                
"
WaitSchedule
NotifyFluig": false,
                "
IsolateProcess
NotifyEmail": false,
                
"
DisableIsolateProcess
NotifyEmailList": 
false,
null
            
"NetworkUser": null,
},
            
"
CustomData
daily": 
null,
{
                "
CanParallelize
hour": 
false
1,
                "
ShouldParallelize
minute": 
false,
25
            }
        
"QuantityOfSplits": 0,
}
    
"MinimumQuantityOfPrimaryKeysPerProcess": 0, "MaximumQuantityOfPrimaryKeysPerProcess": 0, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null }, "return": "" } } ] }
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

1.1.4 - Paginação

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

]
}

1.1.2 - Order(Resultado Ordenado)

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações
iconfalse
titleOrder (Asc)
Informações
Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
title
iconfalse
title
Configuração

Máscara de Url: http://{domínio}:{porta}/api/

glb

framework/v1/jobscheduler?

page

order=[-]{

valor1}&pageSize={valor2}

campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1

Campo:

1Valor2: 1

jobScheduleID

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/

glb

framework/v1/jobscheduler?

page=1&pageSize=1

order=jobScheduleID

PostmanExemplo
Informações
iconfalse
titleExemplo

Image Removed

Informações
iconfalse
title
de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "jobScheduleID": "1",
            "status": "completed",
            "lastModified": "2018-12-06T15:33:37",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
                "PrimaryKeyNames": [
                    "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
                "OnlineMode": false,
                "SyncExecution": false,
                "HideProgressDialog": false,
                "SaveParamsExecution": false,
                "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
                        "$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
                        "$CODSISTEMA": "G",
                        "$CODUSUARIOSERVICO": "",
                        "$CODUSUARIO": "mestre",
                        "$IDPRJ": -1,
                        "$CHAPAFUNCIONARIO": "-1",
                        "$CODFILIAL": 1
                    },
                    "Environment": 1
                },
                "UserName": "mestre",
                "ConnectionId": null,
                "ConnectionString": null,
                "DriverType": null,
                "Ip": "10.31.4.57",
                "HostName": "BHD050100279",
                "JobServerHostName": "BHD050100279",
                "ActionName": "GlbActionProcCopyPermisUsr",
                "MasterActionName": "GlbUsuarioAction",
                "ActionModule": "G",
                "JobID": {
                    "ID": 1,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
                "ProcessName": "Cópia de Permissões de Usuários",
                "ServerName": "GlbCopyPermisUsrProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
                "CanSendMail": false,
                "CanWaitSchedule": false,
                "SendMail": false,
                "FriendlyLogs": null,
                "SuccessMessage": "Processo executado com sucesso",
                "FailureMessage": "Falha na execução do processo",
                "SaveLogInDatabase": true,
                "StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "",
                "CustomData": null,
                "CanParallelize": true,
                "ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            }
        }
    ]
}
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleID

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?order=-jobScheduleID

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "jobScheduleID": "2",
            "status": "active",
            "lastModified": "2018-12-06T15:34:53",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
                "PrimaryKeyNames": [
                    "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
                "OnlineMode": false,
                "SyncExecution": false,
                "HideProgressDialog": false,
                "SaveParamsExecution": false,
                "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
                        "$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
                        "$CODSISTEMA": "G",
                        "$CODUSUARIOSERVICO": "",
                        "$CODUSUARIO": "mestre",
                        "$IDPRJ": -1,
                        "$CHAPAFUNCIONARIO": "-1",
                        "$CODFILIAL": 1
                    },
                    "Environment": 1
                },
                "UserName": "mestre",
                "ConnectionId": null,
                "ConnectionString": null,
                "DriverType": null,
                "Ip": "10.31.4.57",
                "HostName": "BHD050100279",
                "JobServerHostName": "BHD050100279",
                "ActionName": "GlbActionProcCopyPermisUsr",
                "MasterActionName": "GlbUsuarioAction",
                "ActionModule": "G",
                "JobID": {
                    "ID": 2,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
                "ProcessName": "Cópia de Permissões de Usuários",
                "ServerName": "GlbCopyPermisUsrProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
                "CanSendMail": false,
                "CanWaitSchedule": false,
                "SendMail": false,
                "FriendlyLogs": null,
                "SuccessMessage": "Processo executado com sucesso",
                "FailureMessage": "Falha na execução do processo",
                "SaveLogInDatabase": true,
                "StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "",
                "CustomData": null,
                "CanParallelize": true,
                "ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            }
        },
        {
            "jobScheduleID": "1",
            "status": "completed",
            "lastModified": "2018-12-06T15:33:37",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
                "PrimaryKeyNames": [
                    "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
                "OnlineMode": false,
                "SyncExecution": false,
                "HideProgressDialog": false,
                "SaveParamsExecution": false,
                "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
                        "$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
                        "$CODSISTEMA": "G",
                        "$CODUSUARIOSERVICO": "",
                        "$CODUSUARIO": "mestre",
                        "$IDPRJ": -1,
                        "$CHAPAFUNCIONARIO": "-1",
                        "$CODFILIAL": 1
                    },
                    "Environment": 1
                },
                "UserName": "mestre",
                "ConnectionId": null,
                "ConnectionString": null,
                "DriverType": null,
                "Ip": "10.31.4.57",
                "HostName": "BHD050100279",
                "JobServerHostName": "BHD050100279",
                "ActionName": "GlbActionProcCopyPermisUsr",
                "MasterActionName": "GlbUsuarioAction",
                "ActionModule": "G",
                "JobID": {
                    "ID": 1,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
                "ProcessName": "Cópia de Permissões de Usuários",
                "ServerName": "GlbCopyPermisUsrProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
                "CanSendMail": false,
                "CanWaitSchedule": false,
                "SendMail": false,
                "FriendlyLogs": null,
                "SuccessMessage": "Processo executado com sucesso",
                "FailureMessage": "Falha na execução do processo",
                "SaveLogInDatabase": true,
                "StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "",
                "CustomData": null,
                "CanParallelize": true,
                "ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            }
        }
    ]
}

1.1.3 - Filter (Resultado filtrado)

...

Informações
iconfalse
titleFilter
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: pending

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?status=pending

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "jobScheduleID": "3",
            "status": "active",
            "lastModified": "2018-12-06T15:36:53",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": true,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
                "PrimaryKeyNames": [
                    "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
                "OnlineMode": false,
                "SyncExecution": false,
                "HideProgressDialog": false,
                "SaveParamsExecution": false,
                "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
                        "$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
                        "$CODSISTEMA": "G",
                        "$CODUSUARIOSERVICO": "",
                        "$CODUSUARIO": "mestre",
                        "$IDPRJ": -1,
                        "$CHAPAFUNCIONARIO": "-1",
                        "$CODFILIAL": 1
                    },
                    "Environment": 1
                },
                "UserName": "mestre",
                "ConnectionId": null,
                "ConnectionString": null,
                "DriverType": null,
                "Ip": "10.31.4.57",
                "HostName": "BHD050100279",
                "JobServerHostName": "BHD050100279",
                "ActionName": "GlbActionProcCopyPermisUsr",
                "MasterActionName": "GlbUsuarioAction",
                "ActionModule": "G",
                "JobID": {
                    "ID": 3,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
                "ProcessName": "Cópia de Permissões de Usuários",
                "ServerName": "GlbCopyPermisUsrProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
                "CanSendMail": false,
                "CanWaitSchedule": false,
                "SendMail": false,
                "FriendlyLogs": null,
                "SuccessMessage": "Processo executado com sucesso",
                "FailureMessage": "Falha na execução do processo",
                "SaveLogInDatabase": true,
                "StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "",
                "CustomData": null,
                "CanParallelize": true,
                "ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            },
            "daily": {
                "hour": 0,
                "minute": 1
            }
        }
    ]
}

1.1.4 - Paginação

...

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações
iconfalse
titlePaginação
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler?page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?page=1&pageSize=1

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
{ "hasNext": true, "items": [ {
              "
scheduleID
$RHTIPOUSR": "
100001
-1",
                
"status
        "$CODIGOEXTERNO": "
success
-1",
                        "
scheduleDate
$CODSISTEMA": "
17/11/2008 17:16:01",
G",
                        "
executionDate
$CODUSUARIOSERVICO": "
17/11/2008 17:16:05
",
           
"executionID":
 
"1",
            "
user
$CODUSUARIO": "mestre",
           
"recurrent":
 
false,
            "
single
$IDPRJ": 
{
-1,
                        "
year
$CHAPAFUNCIONARIO": 
2008
"-1",
                        "
month
$CODFILIAL": 
11,
1
                
"day": 17
    },
                    "
hour
Environment": 
17,
1
                
"minute": 16
},
                
}
"UserName": "mestre",
                "
execution
ConnectionId": 
{
null,
                "
processID
ConnectionString": 
"PrjConcederPermissaoAcessoProjetoProc"
null,
                "
status
DriverType": 
"success"
null,
                "
scheduleDate
Ip": "
17/11/2008 17:16:01
10.31.4.57",
                "
executionDate
HostName": "
17/11/2008 17:16:05
BHD050100279",
                "
executionID
JobServerHostName": "
1
BHD050100279",
                "
scheduleID
ActionName": "
100001
GlbActionProcCopyPermisUsr",
                "
user
MasterActionName": "GlbUsuarioAction",
                "
recurrent
ActionModule": 
false
"G",
                "
executionParameter
JobID": {
                    "
Permissoes
ID": 
null
1,
                    "
Initialized
ExecID": 
false
1,
                    "
PrimaryKeyList
IsPriorityJob": 
[
false,
                    
[
"Children": []
                },
            
1,
    "ShowReExecuteButton": true,
                
0
"ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
                "ProcessName": "Cópia de Permissões 
]
de Usuários",
                
],
"ServerName": "GlbCopyPermisUsrProc",
                "
PrimaryKeyNames
ServiceInterface": 
[
null,
                
"
CODCOLIGADA
Scheduler": 1,
                "
IDPRJ
UseJobMonitor": true,
                
],
"ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
                
"
PrimaryKeyTableName
CanSendMail": 
null
false,
                
"
OnlineMode
CanWaitSchedule": false,
                
"
SyncExecution
SendMail": false,
                
"
HideProgressDialog
FriendlyLogs": 
false
null,
                "SuccessMessage": "Processo executado com sucesso"
SaveParamsExecution": false
,
                
"
CodUsuario
FailureMessage": 
null,
"Falha na execução do processo",
                "
Context
SaveLogInDatabase": 
{
true,
                "StatusMessage": null,
       
"$id": "1",
         "WaitSchedule": false,
                "
_params
IsolateProcess": 
{}
false,
                
"
Environment
DisableIsolateProcess": 
0
false,
                
},
"NetworkUser": "",
                "
UserName
CustomData": 
"Breno"
null,
                "
ConnectionId
CanParallelize": 
null
true,
                "
ConnectionString
ShouldParallelize": 
null
false,
                
"
DriverType
QuantityOfSplits": 
null
0,
                
"
Ip
MinimumQuantityOfPrimaryKeysPerProcess": 
"10.31.7.80"
1,
                
"
HostName
MaximumQuantityOfPrimaryKeysPerProcess": 
"RM0005748"
1000,
                
"
JobServerHostName
NotifyFluig": 
"RM0005748"
false,
                
"
ActionName
NotifyEmail": 
"PrjConcederPermissaoAcessoProjetoAction"
false,
                
"
MasterActionName
NotifyEmailList": null
,

            }
        
"ActionModule": null, "JobID": { "ID": -1, "ExecID": -1, "IsPriorityJob
}
    ]
}
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
        {
            "jobScheduleID": "1",
            "status": "completed",
            "lastModified": "2018-12-06T15:33:37",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
                "PrimaryKeyNames": [
                    "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
                "OnlineMode": false,
                "SyncExecution": false,
                "HideProgressDialog": false,
                "SaveParamsExecution": false,
                "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
          
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

1.1.5 - Fields (Retorno de campos específicos no resultado)

...

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações
iconfalse
titleFields
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler?fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleId

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?fields=jobScheduleId,firstExecution

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "
Children
jobScheduleID": 
[]
"1",
            
}
"lastModified": "0001-01-01T00:00:00",
            "firstExecution": "0001-01-01T00:00:00"
       
"ExecutionId": "1c19b022-c065-42d2-ae20-647259c2e2c0"
 },
        {
            "
ProcessName
jobScheduleID": "
Conceder permissão de Acesso a Projetos
2",
            "
ServerName
lastModified": "
PrjConcederPermissaoAcessoProjetoProc
0001-01-01T00:00:00",
            "firstExecution": "0001-01-01T00:00:00"
       
"ServiceInterface":
 
null
},
        {
            "
Scheduler
jobScheduleID": 
2
"3",
            "lastModified": "0001-01-01T00:00:00",
            "
UseJobMonitor
firstExecution": 
false,
"0001-01-01T00:00:00"
        }
    
"ScheduleDateTime": "2008-11-17T17:15:54.1180698-02:00", "CanSendMail": false, "CanWaitSchedule": false, "SendMail": false, "FriendlyLogs": null, "SuccessMessage": "Processo executado com sucesso", "FailureMessage": "Falha na execução do processo", "SaveLogInDatabase": false, "StatusMessage": null, "WaitSchedule": false, "IsolateProcess": false, "DisableIsolateProcess": false, "NetworkUser": null, "CustomData": null, "CanParallelize": false, "ShouldParallelize": false, "QuantityOfSplits": 0, "MinimumQuantityOfPrimaryKeysPerProcess": 0, "MaximumQuantityOfPrimaryKeysPerProcess": 0, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null }, "return": "" } } ] }

1.1.5 - Fields (Retorno de campos específicos no resultado)

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

]
}

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

...

Informações
titleParâmetros

Expand: Parâmetro opcional, usado para determinar a(s) propriedade(s) expandables que devem ser retornadas expandidas.

Exemplo: ?expand=roles - Nesse exemplo, os perfis associados ao usuário serão retornados na resposta da requisição.

Valores padrão: Caso não sejam preenchidos todas as propriedades expandables serão retornadas sem serem expandidas.

Informações
iconfalse
titleGetOne
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler/{jobId}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 1

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler/1

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
 "hasNext": false,
 "items": [
 {
 "jobScheduleID": "1",
 "status": "inactive",
 "lastModified": "2018-12-06T15:13:22",
 "processID": "GlbWorkflowExecProc",
 "firstExecution": "2018-12-06T15:14:00",
 "user": "mestre",
 "recurrent": true,
 "executionParameter": {
 "CodColigada": 1,
 "IdWorkflow": 45,
 "DataSet": null,
 "Parameters": null,
 "OwnerData": null,
 "Initialized": true,
 "PrimaryKeyList": [],
 "PrimaryKeyNames": null,
 "PrimaryKeyTableName": null,
 "OnlineMode": false,
 "SyncExecution": false,
 "HideProgressDialog": false,
 "SaveParamsExecution": false,
 "CodUsuario": "mestre",
 "Context": {
 "$id": "1",
 "_params": {
 "$EXERCICIOFISCAL": 2,
 "$CODLOCPRT": 12,
 "$CODTIPOCURSO": -1,
 "$EDUTIPOUSR": "-1",
 "$CODUNIDADEBIB": -1,
 "$CODCOLIGADA": 1,
 "$RHTIPOUSR": "-1",
 "$CODIGOEXTERNO": "-1",
 "$CODSISTEMA": "G",
 "$CODUSUARIOSERVICO": "",
 "$CODUSUARIO": "mestre",
 "$IDPRJ": -1,
 "$CHAPAFUNCIONARIO": "-1",
 "$CODFILIAL": 1
 },
 "Environment": 1
 },
 "UserName": "mestre",
 "ConnectionId": null,
 "ConnectionString": null,
 "DriverType": null,
 "Ip": "10.31.4.57",
 "HostName": "BHD050100279",
 "JobServerHostName": "BHD050100279",
 "ActionName": "GlbWorkflowExecAction",
 "MasterActionName": null,
 "ActionModule": "G",
 "JobID": {
 "ID": 1,
 "ExecID": 1,
 "IsPriorityJob": false,
 "Children": []
 },
 "ShowReExecuteButton": true,
 "ExecutionId": "33cf5d79-cf20-447f-bc0d-dfa1f5259dae",
 "ProcessName": "Executar Fórmula Visual",
 "ServerName": "GlbWorkflowExecProc",
 "ServiceInterface": null,
 "Scheduler": 1,
 "UseJobMonitor": true,
 "ScheduleDateTime": "2018-12-06T15:13:15.9381719-02:00",
 "CanSendMail": false,
 "CanWaitSchedule": false,
 "SendMail": false,
 "FriendlyLogs": null,
 "SuccessMessage": "Processo executado com sucesso",
 "FailureMessage": "Falha na execução do processo",
 "SaveLogInDatabase": true,
 "StatusMessage": null,
 "WaitSchedule": false,
 "IsolateProcess": false,
 "DisableIsolateProcess": false,
 "NetworkUser": "fabio.nunes",
 "CustomData": null,
 "CanParallelize": true,
 "ShouldParallelize": false,
 "QuantityOfSplits": 0,
 "MinimumQuantityOfPrimaryKeysPerProcess": 1,
 "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
 "NotifyFluig": false,
 "NotifyEmail": false,
 "NotifyEmailList": null
 },
 "daily": {
 "hour": 0,
 "minute": 1
 }
 }
 ]
}

1.2 - POST

...

1.2.1 - Post (Inserir um agendamento de job)

...

expand
Informações
iconfalse
titlePost
Informações
iconfalse
title1.1.5 Fields
Informações
iconfalse
title1.2.1 Post
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/

glb

framework/v1/jobscheduler

?fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Url Utilizada: http://localhost:8051/api/

glb/v1/jobscheduler?fields=scheduleID
Informações
iconfalse
titleExemplo Postman

Image Removed

framework/v1/jobscheduler

Obs.: Se o Host estiver executando local (3camadas = false) não é possível criar um agendamento de job. Neste cenário, para executar o job imediatamente, é preciso que no Body da requisição a recorrência esteja como 'false' e não sejam enviadas as propriedades "ScheduleDateTime" e Tipo de Recorrência.

Resultado
Informações
iconfalse
titleExemplo de
Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
"hasNext": true, "items": [ { "scheduleID": "100147" }, { "scheduleID": "100149" }, { "scheduleID": "100157" }, { "scheduleID": "100229" }, { "scheduleID": "100302" }, { "scheduleID": "100310" }, { "scheduleID": "100326" }, { "scheduleID": "100360" }, { "scheduleID": "100362" }, { "scheduleID": "101341" }, { "scheduleID": "102083" }, { "scheduleID": "102473" }, { "scheduleID": "102474" }, { "scheduleID": "102767" }, { "scheduleID": "102769" }, { "scheduleID": "102771" }, { "scheduleID": "102772" }, { "scheduleID": "102777" }, { "scheduleID": "102764" }, { "scheduleID": "100360" } ] }

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

Informações
titleParâmetros

Expand: Parâmetro opcional, usado para determinar a(s) propriedade(s) expandables que devem ser retornadas expandidas.

Exemplo: ?expand=roles - Nesse exemplo, os perfis associados ao usuário serão retornados na resposta da requisição.

Valores padrão: Caso não sejam preenchidos todas as propriedades expandables serão retornadas sem serem expandidas.

Informações
iconfalse
title1.1.6 GetOne
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler/{jobId}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 102771

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler/102771

Informações
iconfalse
titleExemplo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "scheduleID": "102771",
    "status": "pending",
    "scheduleDate": "24/10/2070 23:00:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": false,
    "single": {
        "year": 2070,
        "month": 10,
        "day": 24,
        "hour": 23,
        "minute": 0
    },
    "execution": {
        "processID": "RptProcGenerateReport",
        "status": "pending",
        "scheduleDate": "24/10/2070 23:00:00",
        "executionDate": "",
        "executionID": "1",
        "scheduleID": "102771",
        "user": "mestre",
        "recurrent": false,
        "executionParameter": ""
    }
}

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

Entrada
	"firstExecution": "2018-12-05 01:00:00",
	"processID": "GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": false,
	"executionParameter": {
		"SourceUsuario": "mestre",
		"RemoveOldPermissions": false,
		"CopyToAllApplications": true,
		"CodSistema": "G",
		"NewUser": {
			"Usuario": null,
			"Nome": null,
			"Senha": null,
			"Email": null,
			"codAcesso": null,
			"UsuariodeRede": null
		},
		"Initialized": true,
		"PrimaryKeyList": [
			[
				"Fabio.nunes"
			]
		],
		"PrimaryKeyNames": [
			"CODUSUARIO"
		],
		"PrimaryKeyTableName": "GUSUARIO",
		"OnlineMode": false,
		"SyncExecution": false,
		"HideProgressDialog": false,
		"SaveParamsExecution": false,
		"CodUsuario": "mestre",
		"Context": {
			"$id": "1",
			"_params": {
				"$EXERCICIOFISCAL": 2,
				"$CODLOCPRT": 12,
				"$CODTIPOCURSO": -1,
				"$EDUTIPOUSR": "-1",
				"$CODUNIDADEBIB": -1,
				"$CODCOLIGADA": 1,
				"$RHTIPOUSR": "-1",
				"$CODIGOEXTERNO": "-1",
				"$CODSISTEMA": "G",
				"$CODUSUARIOSERVICO": "",
				"$CODUSUARIO": "mestre",
				"$IDPRJ": -1,
				"$CHAPAFUNCIONARIO": "-1",
				"$CODFILIAL": 1
			},
			"Environment": 1
		},
		"UserName": "mestre",
		"ConnectionId": null,
		"ConnectionString": null,
		"DriverType": null,
		"Ip": "10.31.4.57",
		"HostName": "BHD050100279",
		"JobServerHostName": "BHD050100279",
		"ActionName": "GlbActionProcCopyPermisUsr",
		"MasterActionName": "GlbUsuarioAction",
		"ActionModule": "G",
		"JobID": {
			"ID": 1,
			"ExecID": 1,
			"IsPriorityJob": false,
			"Children": []
		},
		"ShowReExecuteButton": true,
		"ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
		"ProcessName": "Cópia de Permissões de Usuários",
		"ServerName": "GlbCopyPermisUsrProc",
		"ServiceInterface": null,
		"Scheduler": 1,
		"UseJobMonitor": true,
		"ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
		"CanSendMail": false,
		"CanWaitSchedule": false,
		"SendMail": false,
		"FriendlyLogs": null,
		"SuccessMessage": "Processo executado com sucesso",
		"FailureMessage": "Falha na execução do processo",
		"SaveLogInDatabase": true,
		"StatusMessage": null,
		"WaitSchedule": false,
		"IsolateProcess": false,
		"DisableIsolateProcess": false,
		"NetworkUser": "fabio.nunes",
		"CustomData": null,
		"CanParallelize": true,
		"ShouldParallelize": false,
		"QuantityOfSplits": 0,
		"MinimumQuantityOfPrimaryKeysPerProcess": 1,
		"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
		"NotifyFluig": false,
		"NotifyEmail": false,
		"NotifyEmailList": null
	}
}


Propriedades obrigatórias:

firstExecution, processID, recurrent, executionParameter

executionParameter: UserName, Context, ProcessName, PrimaryKeyList, PrimaryKeyNames, processStartDate, processEndDate, completeInvoicing

Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobscheduler

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler

Informações
iconfalse
titleExemplo de Entrada Postman

Image Removed

Informações
iconfalse
titleExemplo de
Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
  
"scheduleDate":
 
"2018-10-26
 
23:05:00", "recurrent": true, "daily": {
"jobScheduleID": "1",
    "
hour
status":
10,
 "
minute": 15 }
active",
  
"execution":
 
{
 
"
processID
lastModified": "
GlbCopyPermisUsrProc", "scheduleDate": "string", "executionDate": "string
2018-12-06T14:18:42",
    "
executionID
processID": "
string
GlbCopyPermisUsrProc",
    "
scheduleID
firstExecution": "
string
2018-12-05T01:00:00",
    "user": "
string
mestre",
    "recurrent": 
true
false,
    "executionParameter": {
        "SourceUsuario": "mestre",
        "RemoveOldPermissions": false,
        "CopyToAllApplications": true,
        "CodSistema": "G",
        "NewUser": {
            "Usuario": 
"testepost",
null,
            "Nome": 
"testepost",
null,
            "Senha": 
"totvs",
null,
            "Email": 
"testepost",
null,
            "codAcesso": 
"Acesso01",
null,
            "UsuariodeRede": 
"" },
null
        },
        "Initialized": true,
        "PrimaryKeyList": [
            [
],

                "Fabio.nunes"
            ]
        ],
        "PrimaryKeyNames":
null,
 [
            "CODUSUARIO"
        ],
        "PrimaryKeyTableName":
null,
 "GUSUARIO",
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "1",
            "_params": {
                "$EXERCICIOFISCAL": 
-1,
2,
                "$CODLOCPRT": 
-1,
12,
                "$CODTIPOCURSO": -1,
                "$EDUTIPOUSR": "-1",
                "$CODUNIDADEBIB": -1,
                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
                "$CODIGOEXTERNO": "-1",
                "$CODSISTEMA": "G",
                "$CODUSUARIOSERVICO": "",
                "$CODUSUARIO": "mestre",
                "$IDPRJ": -1,
                "$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 
-
1
},
            },
            "Environment": 1
        },
        "UserName": "mestre",
        "ConnectionId": null,
        "ConnectionString": null,
        "DriverType": null,
        "Ip": "10.31.4.57",
        "HostName": "BHD050100279",
        "JobServerHostName": "BHD050100279",
        "ActionName": "GlbActionProcCopyPermisUsr",
        "MasterActionName": "GlbUsuarioAction",
        "ActionModule": "G",
        "JobID": {
            "ID": 1,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "
7dba5874
2b72d443-
a296
e6f6-
43bc
4693-
89fd
bd83-
ab853121feec
318f67585a79",
        "ProcessName": "Cópia de Permissões de Usuários",
        "ServerName"
: "GlbCopyPermisUsrProc", "
: "GlbCopyPermisUsrProc",
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2018-
10
12-
25T12
06T10:
04
39:
31
57.
8719316
5233678-
03
02:00",
        "CanSendMail": false,
        "CanWaitSchedule": false,
        "SendMail": false,
        "FriendlyLogs": null,
        "SuccessMessage": "Processo executado com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "SaveLogInDatabase": true,
        "StatusMessage": null,
        "WaitSchedule": false,
        "IsolateProcess": false,
        "DisableIsolateProcess": false,
        "NetworkUser": "
fabio.nunes
",
        "CustomData": null,
        "CanParallelize": true,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
}
    }
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Positivo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "
scheduleID
Code": "
17
FE016",
    "
status
Message": "
pending",
O corpo 
"scheduleDate": "26/10/2018 23:05:00", "executionDate": ""
da mensagem contém valores inválidos.",
    "
executionID
DetailMessage": "
1
",
    "
user
HelpUrl": "
mestre
http://tdn.totvs.com/x/e0F0GQ",
    "
recurrent
Details": null
}

1.2.2 - Post {IdJob}/Trigger

...

Informações
iconfalse
titlePost
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler/{jobID}/trigger

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

JobID: 3

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler/3/trigger

Obs.: Se o Host estiver executando local (3camadas = false) não é possível criar um agendamento de job. Neste cenário, para executar o job imediatamente, é preciso que no Body da requisição a recorrência esteja como 'false' e não sejam envidas as propriedades "scheduleDate" e tipo de recorrência.

Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "jobScheduleID": "3
true, "daily": { "hour": 10, "minute": 15 }, "execution": { "processID": "GlbCopyPermisUsrProc
",
    
"status": "
pending
inactive",
    
"
scheduleDate
lastModified": "
26/10/2018 23:05:00", "executionDate": "",
2018-12-06T15:36:53",
    "
executionID
processID": "
1
GlbCopyPermisUsrProc",
    "
scheduleID
firstExecution": "
17
2018-12-06T15:30:00",
    
"user": "mestre",
    
"recurrent": true,
    "executionParameter": {
        
"SourceUsuario": "mestre",
        "RemoveOldPermissions": false,
        "CopyToAllApplications": true,
        
"CodSistema": "G",
        "NewUser": {
            
"Usuario": 
"testepost"
null,
            
"Nome": 
"testepost"
null,
            
"Senha": 
"totvs"
null,
            
"Email": 
"testepost"
null,
            "codAcesso": null,
            "
codAcesso
UsuariodeRede": 
"Acesso01",
null
        },
        "
UsuariodeRede
Initialized": true,
        "PrimaryKeyList": [
            
},
[
                "
Initialized": true,
Fabio.nunes"
            ]
        ],
        "
PrimaryKeyList
PrimaryKeyNames": [
],

            "
PrimaryKeyNames
CODUSUARIO"
: null,

        ],
        "PrimaryKeyTableName": 
null
"GUSUARIO",
        "OnlineMode": false,
        
"SyncExecution": false,
        "HideProgressDialog": false,
        
"SaveParamsExecution": false,
        
"CodUsuario": "mestre",
        
"Context": {
            
"$id": "1",
            
"_params": {
                "$EXERCICIOFISCAL": 
-1
2,
                
"$CODLOCPRT": 
-1
12,
                
"$CODTIPOCURSO": -1,
                
"$EDUTIPOUSR": "-1",
                "$CODUNIDADEBIB": -1,
                
"$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
                "$CODIGOEXTERNO": "-1",
                
"$CODSISTEMA": "G",
                
"$CODUSUARIOSERVICO": "",
                
"$CODUSUARIO": "mestre",
                "$IDPRJ": -1,
                "
$IDPRJ
$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 1
      
"$CHAPAFUNCIONARIO
      },
            "Environment": 
"-
1
",

        },
        "UserName": "mestre",
        "
$CODFILIAL
ConnectionId": 
-1
null,
        "ConnectionString": null,
        "DriverType": 
}
null,
        "Ip": "10.31.4.57",
        "
Environment
HostName": 
1
"BHD050100279",
        
},
"JobServerHostName": "BHD050100279",
        "
UserName
ActionName": "
mestre
GlbActionProcCopyPermisUsr",
        
"
ConnectionId
MasterActionName": 
null
"GlbUsuarioAction",
        
"
ConnectionString
ActionModule": 
null
"G",
        
"
DriverType
JobID": 
null,
{
            "
Ip
ID": 
"10.31.4.57"
3,
            "
HostName
ExecID": 
"BHD050100279"
1,
            "
JobServerHostName
IsPriorityJob": 
"BHD050100279"
false,
            "
ActionName
Children": 
"GlbActionProcCopyPermisUsr",
[]
        },
        "
MasterActionName
ShowReExecuteButton": 
"GlbUsuarioAction"
true,
        
"
ActionModule
ExecutionId": "
G
2b72d443-e6f6-4693-bd83-318f67585a79",
        
"
JobID
ProcessName": 
{
"Cópia de Permissões de Usuários",
        
"ID": 17
"ServerName": "GlbCopyPermisUsrProc",
        "ServiceInterface": null,
        "
ExecID
Scheduler": 1,
        "UseJobMonitor": true,
        "
IsPriorityJob
ScheduleDateTime": 
false
"2018-12-06T10:39:57.5233678-02:00",
        "CanSendMail": false,
        "
Children
CanWaitSchedule": 
[]
false,
        
}
"SendMail": false,
        
"
ShowReExecuteButton
FriendlyLogs": 
true
null,
        
"
ExecutionId
SuccessMessage": "
7dba5874-a296-43bc-89fd-ab853121feec
Processo executado com sucesso",
        
"
ProcessName
FailureMessage": "
Cópia
Falha 
de
na 
Permissões
execução 
de
do 
Usuários
processo",
        "
ServerName
SaveLogInDatabase": 
"GlbCopyPermisUsrProc"
true,
        "
ServiceInterface
StatusMessage": null,
        "WaitSchedule": false,
        "
Scheduler
IsolateProcess": 
1
false,
        "
UseJobMonitor
DisableIsolateProcess": 
true
false,
        
"
ScheduleDateTime
NetworkUser": "
2018-10-25T12:04:31.8719316-03:00
",
        "
CanSendMail
CustomData": 
false
null,
        
"
CanWaitSchedule
CanParallelize": 
false
true,
        
"
SendMail
ShouldParallelize": false,
        "
FriendlyLogs
QuantityOfSplits": 
null
0,
        
"
SuccessMessage
MinimumQuantityOfPrimaryKeysPerProcess": 
"Processo executado com sucesso"
1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
   
"FailureMessage":
 
"Falha
 
na
 
execução
 
do
 
processo
"NotifyFluig": false,
        
"
SaveLogInDatabase
NotifyEmail": 
true
false,
        
"
StatusMessage
NotifyEmailList": null
,

    },
    
"
WaitSchedule
daily": 
false,
{
        
"
IsolateProcess
hour": 
false
0,
        "
DisableIsolateProcess
minute": 
false,
1
    }
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
   
"
NetworkUser
Code": "FE011",

   "
CustomData
Message": 
null,
"Não foi encontrada nenhuma tarefa pendente com o id 0.",
   "
CanParallelize
DetailMessage": 
true
"",
   "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
   
"ShouldParallelize": false, "QuantityOfSplits": 0, "MinimumQuantityOfPrimaryKeysPerProcess": 1, "MaximumQuantityOfPrimaryKeysPerProcess": 1000, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null } } }
"Details": null
}

1.2.3 - Post {IdJob}/Restart

...

Informações
iconfalse
titlePost

Funcionalidade para reiniciar um Job.
• Não é permitido executar o restart em Jobs que não foram executados.
• Todos os outros tipos de Job´s podem ser reiniciados.
• Após a reinicialização o Job é executado pelo JobServer independente da data de agendamento.
• Após a execução, caso o Job seja agendado, o mesmo é reprogramado para a próxima recorrência.

Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler/{jobID}/restart

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

JobID: 1

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler/1/restart

Obs.: Se o Host estiver executando local (3camadas = false) não é possível criar um agendamento de job. Neste cenário, para executar o job imediatamente, é preciso que no Body da requisição a recorrência esteja como 'false' e não sejam envidas as propriedades "scheduleDate" e tipo de recorrência.

Informações
iconfalse
titleExemplo de Resultado Positivo
Negativo Postman Image Removed
Expandir
titleVer resultado JSON...



Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "
FE016
FE019",
    "Message": "Não 
foi
é possível 
recuperar
reiniciar o 
corpo
Job 
da mensagem.\r\nFavor verificar se o corpore está preenchido corretamente
1 pois o mesmo está pendente ou em execução.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}


1.3 - PUT

...

1.3.1 - Put (Atualizar um Job)

...

...

titleAtenção

...

Ao executar a requisição de

...

PUT, informando um JobID, esse processo será desabilitado e um novo será criado.

Importante: Existem casos em que o Job não será desabilitado, por exemplo: Jobs já executados ou já desabilitados. Nesses casos, um novo Job será criado normalmente.

será desabilitado e um novo será criado.
Informações
iconfalse
title1.3.1 Put
Expandir
Exemplo de Entrada Postman
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glbframework/v1/jobscheduler/{jobid}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1

Url Utilizada: http://localhost:8051/api/glbframework/v1/jobscheduler/1

Informações
iconfalse
title

Image Removed

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
Resultado (JSON)
linenumberstrue
{
   	"firstExecution": "2018-12-06 15:30:00",
	"processID": "GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": true,
	"daily": {
                "hour": 0,
                "minute": 1
            },
    "executionParameter": {
        "SourceUsuario": "mestre",
        "RemoveOldPermissions": false{
  "scheduleDate": "2018-10-26 23:05:00",
  "recurrent": true,
        "dailyCopyToAllApplications": {true,
        "hourCodSistema": 10"G",
        "minuteNewUser": 15{
       },
     "Usuario": null,
            "executionNome": {
null,
            "processIDSenha": null,
    "GlbCopyPermisUsrProc",
        "Email": null,
            "scheduleDatecodAcesso": "string"null,
    "executionDate        "UsuariodeRede": "string",
null
        },
        "executionIDInitialized": "string"true,
        "scheduleIDPrimaryKeyList": "string",[
     "user": "string",
      "recurrent": true, [
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			            "Fabio.nunes"
            ]
        ],
        "PrimaryKeyNames": [
            "CODUSUARIO"
        ],
        "PrimaryKeyTableName": "GUSUARIO",
        "OnlineMode": false,
			        "SyncExecution": false,
			        "HideProgressDialog": false,
			        "SaveParamsExecution": false,
			        "CodUsuario": "mestre",
			        "Context": {
				: {
            "$id": "1",
				            "_params": {
					                "$EXERCICIOFISCAL": -1,
					2,
                "$CODLOCPRT": -1,
					12,
                "$CODTIPOCURSO": -1,
					                "$EDUTIPOUSR": "-1",
					                "$CODUNIDADEBIB": -1,
					"$CODCOLIGADA": 1,
					                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
					                "$CODIGOEXTERNO": "-1",
					                "$CODSISTEMA": "G",
					                "$CODUSUARIOSERVICO": "",
					                "$CODUSUARIO": "mestre",
					                "$IDPRJ": -1,
					                "$CHAPAFUNCIONARIO": "-1",
					"$CODFILIAL": -1
				},
				                "$CODFILIAL": 1
            },
            "Environment": 1
			        },
			        "UserName": "mestre",
			        "ConnectionId": null,
			        "ConnectionString": null,
			        "DriverType": null,
			        "Ip": "10.31.4.57",
			        "HostName": "BHD050100279",
			        "JobServerHostName": "BHD050100279",
			        "ActionName": "GlbActionProcCopyPermisUsr",
			        "MasterActionName": "GlbUsuarioAction",
			        "ActionModule": "G",
			        "JobID": {
				            "ID": 1,
				            "ExecID": 1,
				            "IsPriorityJob": false,
				            "Children": []
			        },
			        "ShowReExecuteButton": true,
			        "ExecutionId": "7dba58742b72d443-a296e6f6-43bc4693-89fdbd83-ab853121feec318f67585a79",
			        "ProcessName": "Cópia de Permissões de Usuários",
			        "ServerName": "GlbCopyPermisUsrProc",
			        "ServiceInterface": null,
			        "Scheduler": 1,
			        "UseJobMonitor": true,
			        "ScheduleDateTime": "2018-1012-25T1206T10:0439:3157.87193165233678-0302:00",
			
        "CanSendMail": false,
			        "CanWaitSchedule": false,
			        "SendMail": false,
			        "FriendlyLogs": null,
			        "SuccessMessage": "Processo executado com sucesso",
			        "FailureMessage": "Falha na execução do processo",
			        "SaveLogInDatabase": true,
			"StatusMessage": null,
			"WaitSchedule": false,
			"IsolateProcess": false,
			"DisableIsolateProcess": false,
			"NetworkUser": "fabio.nunes",
			"CustomData": null,
			"CanParallelize": true,
			"ShouldParallelize": false,
			"QuantityOfSplits"StatusMessage": 0,
			"MinimumQuantityOfPrimaryKeysPerProcess": 1,
			"MaximumQuantityOfPrimaryKeysPerProcessnull,
        "WaitSchedule": 1000false,
			"NotifyFluig        "IsolateProcess": false,
			"NotifyEmail        "DisableIsolateProcess": false,
		}
  }
}
Informações
iconfalse
titleExemplo de Resultado Positivo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
        "scheduleIDNetworkUser": "2fabio.nunes",
        "statusCustomData": "pending"null,
        "scheduleDateCanParallelize": "26/10/2018 23:05:00"true,
        "executionDateShouldParallelize": ""false,
        "executionIDQuantityOfSplits": "1",
0,
        "userMinimumQuantityOfPrimaryKeysPerProcess": "mestre"1,
    "recurrent": true,
    "dailyMaximumQuantityOfPrimaryKeysPerProcess": {1000,
        "hourNotifyFluig": 10false,
        "minuteNotifyEmail": 15false,
    },
    "executionNotifyEmailList": {null
    }
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "processIDjobScheduleID": "GlbCopyPermisUsrProc2",
        "status": "pendingactive",
        "scheduleDatelastModified": "26/10/2018 23:05:002018-12-06T15:29:47",
    "processID": "GlbCopyPermisUsrProc",
    "executionDatefirstExecution": "2018-12-06T15:30:00",
        "executionIDuser": "1mestre",
    "recurrent": true,
    "scheduleIDexecutionParameter": "2",{
        "userSourceUsuario": "mestre",
        "recurrentRemoveOldPermissions": truefalse,
        "executionParameterCopyToAllApplications": {
     true,
        "SourceUsuarioCodSistema": "mestreG",
            "RemoveOldPermissionsNewUser": false,{
            "CopyToAllApplicationsUsuario": truenull,
            "CodSistemaNome": "G"null,
            "NewUserSenha": {null,
                "UsuarioEmail": "testepost"null,
                "NomecodAcesso": "testepost"null,
                "SenhaUsuariodeRede": "totvs",null
        },
        "EmailInitialized": "testepost"true,
        "PrimaryKeyList": [
           "codAcesso": "Acesso01", [
                "UsuariodeRede": ""Fabio.nunes"
            },]
            "Initialized": true],
            "PrimaryKeyListPrimaryKeyNames": [],
            "PrimaryKeyNamesCODUSUARIO": null,

        ],
        "PrimaryKeyTableName": null"GUSUARIO",
            "OnlineMode": false,
            "SyncExecution": false,
            "HideProgressDialog": false,
            "SaveParamsExecution": false,
            "CodUsuario": "mestre",
            "Context": {
                "$id": "1",
                "_params": {
                    "$EXERCICIOFISCAL": -12,
                    "$CODLOCPRT": -112,
                    "$CODTIPOCURSO": -1,
                    "$EDUTIPOUSR": "-1",
                    "$CODUNIDADEBIB": -1,
                    "$CODCOLIGADA": 1,
                    "$RHTIPOUSR": "-1",
                    "$CODIGOEXTERNO": "-1",
                    "$CODSISTEMA": "G",
                    "$CODUSUARIOSERVICO": "",
                    "$CODUSUARIO": "mestre",
                    "$IDPRJ": -1,
                    "$CHAPAFUNCIONARIO": "-1",
                    "$CODFILIAL": -1
                },
                "Environment": 1
            },
            "UserName": "mestre",
            "ConnectionId": null,
            "ConnectionString": null,
            "DriverType": null,
            "Ip": "10.31.4.57",
            "HostName": "BHD050100279",
            "JobServerHostName": "BHD050100279",
            "ActionName": "GlbActionProcCopyPermisUsr",
            "MasterActionName": "GlbUsuarioAction",
            "ActionModule": "G",
            "JobID": {
                "ID": 2,
                "ExecID": 1,
                "IsPriorityJob": false,
                "Children": []
            },
            "ShowReExecuteButton": true,
            "ExecutionId": "7dba58742b72d443-a296e6f6-43bc4693-89fdbd83-ab853121feec318f67585a79",
            "ProcessName": "Cópia de Permissões de Usuários",
            "ServerName": "GlbCopyPermisUsrProc",
            "ServiceInterface": null,
            "Scheduler": 1,
            "UseJobMonitor": true,
            "ScheduleDateTime": "2018-1012-25T1206T10:0439:3157.87193165233678-0302:00",
            "CanSendMail": false,
            "CanWaitSchedule": false,
            "SendMail": false,
            "FriendlyLogs": null,
            "SuccessMessage": "Processo executado com sucesso",
            "FailureMessage": "Falha na execução do processo",
            "SaveLogInDatabase": true,
            "StatusMessage": null,
            "WaitSchedule": false,
            "IsolateProcess": false,
            "DisableIsolateProcess": false,
            "NetworkUser": "",
            "CustomData": null,
            "CanParallelize": true,
            "ShouldParallelize": false,
            "QuantityOfSplits": 0,
            "MinimumQuantityOfPrimaryKeysPerProcess": 1,
            "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyFluigNotifyEmail": false,
        "NotifyEmailList": null
   "NotifyEmail": false},
    "daily": {
        "NotifyEmailListhour": null0,
        "minute": }1
    }
}
Informações
iconfalse
titleExemplo de Resultado Negativo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE016",
    "Message": "O Job 10 não foi encontrado na base de dados!",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Deletar um Job)

...

Ao executar a requisição de Delete, informando um JobID, esse processo será desabilitado e não excluído da base de dados. 

...

Informações
iconfalse
title1.4.1 Delete
Expandir
titleClique aqui para expandir...
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glbframework/v1/jobSchedulerjobscheduler/{JobID}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8050

Idjob: 106124 2

Url Utilizada: http://localhost:8051/api/glbframework/v1/jobSchedulerjobscheduler/1061242

Informações
iconfalse
titleExemplo de Resultado Positivo Postman

Obs.: Em caso de sucesso, será retornado o respondeCode = 204 e a resposta em branco.

Image Removed

Informações
iconfalse
titleExemplo de Resultado Negativo Postman

Image Removed

Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE015",
    "Message": "Não foi possível desabilitar o job 106124  pois o mesmo já estava desabilitado.",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}