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

1.1 - GET

...



Informações
iconfalse
title1.1.1 GetAllObservaçã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


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": [
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": "17/11/2008 17:16:01", "executionDate": "17/11/2008 17:16:05",
        {
    
"executionID
        "jobScheduleID": "1",
            "
scheduleID
status": "
100001
completed",
            "
user
lastModified": "2018-12-06T14:41:52",
            
"
recurrent
processID": 
false
"GlbCopyPermisUsrProc",
            
"
executionParameter
firstExecution": 
{
"2018-12-06T14:41:52",
            
"Permissoes
"user": 
null
"mestre",
            
"Initialized
"recurrent": false,
            
"
PrimaryKeyList
executionParameter": 
[
{
                
"SourceUsuario": "mestre",
      
[
          "RemoveOldPermissions": false,
                "CopyToAllApplications": 
1
true,
                "CodSistema": "G",
             
0
   "NewUser": {
                    
]
"Usuario": null,
                    
]
"Nome": null,
                    "
PrimaryKeyNames
Senha": 
[
null,
                    
"
CODCOLIGADA
Email": null,
                    
"codAcesso": null,
  
"IDPRJ"
                  
],
"UsuariodeRede": null
                
"PrimaryKeyTableName": null
},
                "
OnlineMode
Initialized": 
false
true,
                
"
SyncExecution
PrimaryKeyList": 
false,
[
                    
"HideProgressDialog": false,
[
                        "
SaveParamsExecution": false,
Fabio.nunes"
                    
"CodUsuario": null,
]
                ],
    
"Context":
 
{
           "PrimaryKeyNames": [
            
"$id": "1",
        "CODUSUARIO"
                
"_params": {}
],
                "
Environment
PrimaryKeyTableName": 
0
"GUSUARIO",
                
}
"OnlineMode": false,
                
"
UserName
SyncExecution": 
"Breno"
false,
                
"
ConnectionId
HideProgressDialog": 
null
false,
                
"
ConnectionString
SaveParamsExecution": 
null
false,
                
"
DriverType
CodUsuario": 
null
"mestre",
                
"Ip": "10.31.7.80",
"Context": {
                    "
HostName
$id": "
RM0005748
1",
                    "
JobServerHostName
_params": 
"RM0005748",
{
                        "
ActionName
$EXERCICIOFISCAL": 
"PrjConcederPermissaoAcessoProjetoAction"
2,
                        "
MasterActionName
$CODLOCPRT": 
null
12,
                        "
ActionModule
$CODTIPOCURSO": 
null
-1,
                        "
JobID
$EDUTIPOUSR": 
{
"-1",
                        "
ID
$CODUNIDADEBIB": -1,
                        "
ExecID
$CODCOLIGADA": 
-
1,
                        "
IsPriorityJob
$RHTIPOUSR": 
false
"-1",
                        "
Children
$CODIGOEXTERNO": 
[]
"-1",
                     
}
   "$CODSISTEMA": "G",
                        "
ExecutionId
$CODUSUARIOSERVICO": "
1c19b022-c065-42d2-ae20-647259c2e2c0
",
                        "
ProcessName
$CODUSUARIO": "mestre"
Conceder
,
 
permissão
 
de
 
Acesso
 
a Projetos",
                    "
ServerName
$IDPRJ": 
"PrjConcederPermissaoAcessoProjetoProc"
-1,
                        "
ServiceInterface
$CHAPAFUNCIONARIO": 
null
"-1",
                        "
Scheduler
$CODFILIAL": 
2,
1
                    
"UseJobMonitor": false
},
                    "
ScheduleDateTime
Environment": 
"2008-11-17T17:15:54.1180698-02:00",
1
                },
                "
CanSendMail
UserName": 
false
"mestre",
                
"
CanWaitSchedule
ConnectionId": 
false
null,
                
"
SendMail
ConnectionString": 
false
null,
                "
FriendlyLogs
DriverType": null,
                
"
SuccessMessage
Ip": "
Processo executado com sucesso
10.31.4.57",
                
"
FailureMessage
HostName": "
Falha na execução do processo
BHD050100279",
                "
SaveLogInDatabase
JobServerHostName": 
false
"BHD050100279",
                
"
StatusMessage
ActionName": 
null
"GlbActionProcCopyPermisUsr",
                "
WaitSchedule
MasterActionName": 
false
"GlbUsuarioAction",
                
"
IsolateProcess
ActionModule": 
false
"G",
                
"
DisableIsolateProcess
JobID": 
false,
{
                    "
NetworkUser
ID": 
null
1,
                    "
CustomData
ExecID": 
null
1,
                    "
CanParallelize
IsPriorityJob": false,
                    "
ShouldParallelize
Children": 
false,
[]
                
"QuantityOfSplits": 0
},
                "ShowReExecuteButton": true,
                "
MinimumQuantityOfPrimaryKeysPerProcess
ExecutionId": 
0
"c5665069-1d2b-482f-854a-88f3e7649f1e",
                "ProcessName": "Cópia de Permissões 
"MaximumQuantityOfPrimaryKeysPerProcess": 0,
de Usuários",
                "ServerName": "GlbCopyPermisUsrProc",
         
"NotifyFluig
       "ServiceInterface": 
false
null,
                "Scheduler": 1,
                "
NotifyEmail
UseJobMonitor": 
false
true,
                "ScheduleDateTime": "2018-12-06T14:41:40.809678-02:00",
                "
NotifyEmailList
CanSendMail": 
null
false,
                "CanWaitSchedule": 
}
false,
                "
return
SendMail": 
""
false,
            
}
    "FriendlyLogs": null,
            
}
    
] }
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": [
"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,
        
{
        
"
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": null,
"CodColigada": 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": "PrjConcederPermissaoAcessoProjetoAction"
},
                
"
MasterActionName
UserName": 
null
"mestre",
                "
ActionModule
ConnectionId": null,
                
"
JobID
ConnectionString": 
{
null,
                
"ID
"DriverType": 
-1
null,
                "Ip": "10.31.4.57",
        
"ExecID":
 
-1,
       "HostName": "BHD050100279",
                "
IsPriorityJob
JobServerHostName": 
false
"BHD050100279",
                
"Children
"ActionName": 
[]
"GlbWorkflowExecAction",
                
}
"MasterActionName": null,
                
"
ExecutionId
ActionModule": "
1c19b022-c065-42d2-ae20-647259c2e2c0
G",
                
"
ProcessName
JobID": 
"Conceder permissão de Acesso a Projetos",
{
                    "
ServerName
ID": 
"PrjConcederPermissaoAcessoProjetoProc"
2,
                    "
ServiceInterface
ExecID": 
null
1,
                    "
Scheduler
IsPriorityJob": 
2
false,
                    "
UseJobMonitor
Children": 
false,
[]
                
"ScheduleDateTime": "2008-11-17T17:15:54.1180698-02:00",
},
                
"
CanSendMail
ShowReExecuteButton": 
false
true,
                
"
CanWaitSchedule
ExecutionId": 
false
"a6bad34f-2946-46ca-b69b-7434004fc0f6",
                "ProcessName": "Executar Fórmula 
Visual"
SendMail": false
,
                "
FriendlyLogs
ServerName": 
null
"GlbWorkflowExecProc",
                
"
SuccessMessage
ServiceInterface": 
"Processo executado com sucesso"
null,
                
"
FailureMessage
Scheduler": 
"Falha na execução do processo"
1,
                "
SaveLogInDatabase
UseJobMonitor": 
false
true,
                
"
StatusMessage
ScheduleDateTime": 
null,
"2018-12-06T14:43:26.9732933-02:00",
                "
WaitSchedule
CanSendMail": false,
                
"
IsolateProcess
CanWaitSchedule": false,
                "
DisableIsolateProcess
SendMail": false,
                
"
NetworkUser
FriendlyLogs": null,
                "SuccessMessage": "Processo executado com 
"CustomData
sucesso"
: null
,
                
"
CanParallelize
FailureMessage": 
false,
"Falha na execução do processo",
                "
ShouldParallelize
SaveLogInDatabase": 
false
true,
                
"
QuantityOfSplits
StatusMessage": 
0
null,
                
"
MinimumQuantityOfPrimaryKeysPerProcess
WaitSchedule": 
0
false,
                
"
MaximumQuantityOfPrimaryKeysPerProcess
IsolateProcess": 
0
false,
                "DisableIsolateProcess": false,
                "NetworkUser": "fabio.nunes",
         
"NotifyFluig
       "CustomData": 
false
null,
                "CanParallelize": true,
          
"NotifyEmail
      "ShouldParallelize": false,
                "QuantityOfSplits": 0,
                "
NotifyEmailList
MinimumQuantityOfPrimaryKeysPerProcess": 
null
1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 
}
1000,
                "
return
NotifyFluig": false,
                "NotifyEmail": false,
            
}
    "NotifyEmailList": null
            },
      
] }
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
      "weekly": {
                "daysOfWeek": [
        
{
            "
scheduleID
Monday"
: "102776"
,
            
"status": "success",
        "Tuesday",
      
"scheduleDate":
 
"26/10/2018
 
10:37:51",
            "
executionDate
Thursday"
: "26/10/2018 10:38:00",

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

Image Removedorder=jobScheduleID

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": 
true
false,
    "items": [
        {
            "
scheduleID
jobScheduleID": "
100001
1",
            "status": "
success
completed",
            "
scheduleDate
lastModified": "
17/11/2008 17:16:01
2018-12-06T15:33:37",
            "
executionDate
processID": "
17/11/2008 17:16:05
GlbCopyPermisUsrProc",
            "
executionID
firstExecution": "
1
2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "
single
executionParameter": {
                "
year
SourceUsuario": 
2008
"mestre",
                "
month
RemoveOldPermissions": 
11
false,
                "
day
CopyToAllApplications": 
17
true,
                "
hour
CodSistema": 
17
"G",
                "
minute
NewUser": 
16
{
            
},
        "Usuario": null,
   
"execution":
 
{
                "
processID
Nome": 
"PrjConcederPermissaoAcessoProjetoProc"
null,
                    "
status
Senha": 
"success"
null,
                    "
scheduleDate
Email": 
"17/11/2008 17:16:01"
null,
                    "
executionDate
codAcesso": 
"17/11/2008 17:16:05"
null,
                    "
executionID
UsuariodeRede": 
"1",
null
                
"scheduleID": "100001"
},
                "
user
Initialized": 
""
true,
                "
recurrent
PrimaryKeyList": 
false,
[
                
"executionParameter":
 
{
   [
                 
"Permissoes":
 
null,
      "Fabio.nunes"
              
"Initialized":
 
false,
     ]
               
"PrimaryKeyList": [
 ],
                "PrimaryKeyNames": [
       
[
             "CODUSUARIO"
               
1
 ],
                "PrimaryKeyTableName": "GUSUARIO",
            
0
    "OnlineMode": false,
                "SyncExecution": false,
  
]
              "HideProgressDialog": false,
     
],
           "SaveParamsExecution": false,
        
"PrimaryKeyNames":
 
[
       "CodUsuario": "mestre",
                "
CODCOLIGADA
Context"
,
: {
                    
"IDPRJ"
"$id": "1",
                   
],
 "_params": {
                        "
PrimaryKeyTableName
$EXERCICIOFISCAL": 
null
2,
                        "
OnlineMode
$CODLOCPRT": 
false
12,
                        "
SyncExecution
$CODTIPOCURSO": 
false
-1,
                        "
HideProgressDialog
$EDUTIPOUSR": 
false
"-1",
                        "
SaveParamsExecution
$CODUNIDADEBIB": 
false
-1,
                        "
CodUsuario
$CODCOLIGADA": 
null
1,
                        "
Context
$RHTIPOUSR": 
{
"-1",
                        "
$id
$CODIGOEXTERNO": "-1",
                        "
_params
$CODSISTEMA": 
{}
"G",
                        "
Environment
$CODUSUARIOSERVICO": 
0
"",
                    
}
    "$CODUSUARIO": "mestre",
                        "
UserName
$IDPRJ": 
"Breno"
-1,
                        "
ConnectionId
$CHAPAFUNCIONARIO": 
null
"-1",
                        "
ConnectionString
$CODFILIAL": 
null,
1
                    
"DriverType": null
},
                    "
Ip
Environment": 
"10.31.7.80",
1
                
"HostName": "RM0005748"
},
                
"
JobServerHostName
UserName": "
RM0005748
mestre",
                
"
ActionName
ConnectionId": 
"PrjConcederPermissaoAcessoProjetoAction"
null,
                "
MasterActionName
ConnectionString": null,
                
"
ActionModule
DriverType": null,
                
"
JobID
Ip": 
{
"10.31.4.57",
                "HostName": "BHD050100279",
        
"ID":
 
-1,
       "JobServerHostName": "BHD050100279",
                "
ExecID
ActionName": 
-1
"GlbActionProcCopyPermisUsr",
                
"IsPriorityJob
"MasterActionName": 
false
"GlbUsuarioAction",
                
"Children": []
"ActionModule": "G",
                
},
"JobID": {
                    "
ExecutionId
ID": 
"1c19b022-c065-42d2-ae20-647259c2e2c0"
1,
                    "
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
2b72d443-e6f6-
11-17T17:15:54.1180698-02:00
4693-bd83-318f67585a79",
                
"
CanSendMail
ProcessName": 
false,
"Cópia de Permissões de Usuários",
                "
CanWaitSchedule
ServerName": 
false
"GlbCopyPermisUsrProc",
                
"
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-06T10:39:57.5233678-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,
                "
MaximumQuantityOfPrimaryKeysPerProcess
NetworkUser": 
0
"",
                
"
NotifyFluig
CustomData": 
false
null,
                
"
NotifyEmail
CanParallelize": 
false
true,
                "
NotifyEmailList
ShouldParallelize": 
null
false,
                
}
"QuantityOfSplits": 0,
                "
return
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://{

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
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID: jobScheduleID

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glbframework/v1/jobscheduler?fieldsorder=scheduleID-jobScheduleID

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
{
    "hasNext": truefalse,
    "items": [
        {
            "userNamejobScheduleID": "000012",
        },
        {"status": "active",
            "userNamelastModified": "000012018-02-98"12-06T15:34:53",
        },
        {"processID": "GlbCopyPermisUsrProc",
            "userNamefirstExecution": "0000125"2018-12-06T15:30:00",
        },
        {"user": "mestre",
            "userNamerecurrent": "00002"false,
        },
        "executionParameter": {
                "userNameSourceUsuario": "00003mestre",
        },
         {
  "RemoveOldPermissions": false,
          "userName": "00004"
        }"CopyToAllApplications": true,
        {
            "userNameCodSistema": "00005G",
        },
        "NewUser": {
            "userName": "00006"
       "Usuario": }null,
        {
            "userNameNome": "00007"
null,
           },
          {"Senha": null,
            "userName": "00008"
       "Email": }null,
        {
            "userNamecodAcesso": "00009"null,
        },
        {
    "UsuariodeRede": null
       "userName": "00010"
        },
        {
            "userNameInitialized": "00011"true,
        },
        "PrimaryKeyList": {[
            "userName": "00012"
        },[
        {
            "userName":    "00013Fabio.nunes"
                    },
]
                {],
                "userNamePrimaryKeyNames": "00014[
                    "CODUSUARIO"
        },
        {],
                "userNamePrimaryKeyTableName": "00015GUSUARIO",
                }"OnlineMode": false,
             {    "SyncExecution": false,
                "userNameHideProgressDialog": "00038-02-105"false,
        },
         {
"SaveParamsExecution": false,
                "userNameCodUsuario": "00039mestre",
        },
        "Context": {
             "userName       "$id": "000471",
         }
     ]
}

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": "      "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "-1",
                        "$CODUNIDADEBIB": -1,
                        "$CODCOLIGADA": 1,
                        "$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
    "user": "mestre",
      "recurrent": false,
    "single": {
        "year$CODSISTEMA": 2070"G",
        "month": 10,
        "day": 24,
        "hour$CODUSUARIOSERVICO": 23"",
        "minute": 0
    },
    "execution": {
        "processID$CODUSUARIO": "RptProcGenerateReportmestre",
         "status               "$IDPRJ": "pending"-1,
              "scheduleDate": "24/10/2070 23:00:00",
        "executionDate$CHAPAFUNCIONARIO": "-1",
            "executionID": "1",
            "scheduleID$CODFILIAL": "102771",
1
          "user": "mestre",
        "recurrent": false},
        "executionParameter": ""
          }
}

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

Informações
iconfalse
title1.2.1 Post
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:8099/api/glb/v1/jobscheduler

Informações
iconfalse
titleExemplo de Entrada Postman

Image Removed

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
  "id": "testeapiusuario",
  "meta": {
    "resourceType": "User",
    "created": "2018-09-21T16:49:57.336Z",
    "lastModified": "2018-09-21T16:49:57.336Z"
  },
  "externalId": "0001e",
  "name": {
    "givenName": "TesteAPI",
    "familyName": "Usuário"
  },
  "userName": "testeapiusuario",
  "phoneNumbers": [
    {
  "Environment": 1
                },
                "UserName": "mestre",
                "ConnectionId": null,
                "ConnectionString": null,
                "DriverType": null,
                "Ip": "10.31.4.57",
                "HostName": "BHD050100279",
                "JobServerHostName": "BHD050100279",
                "ActionName": "GlbActionProcCopyPermisUsr",
                "valueMasterActionName": "31974964158GlbUsuarioAction",
    }
  ],
  "emails": [
    {
      "valueActionModule": "[email protected]G",
         "type": "string",
      "primaryJobID": true{
    }
  ],
  "active": true,
  "groups": [
    {
      "valueID": "01"2,
          "display": "geral"
      }
  ],
  "titleExecID": "Mr"1,
  "manager": [
    {
      "managerId": "01",
      "displayNameIsPriorityJob": "Geral"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
{
           "id": "testeapiusuario",
    "metaChildren": {[]
        "resourceType": "User",
        "created": "2018-09-21T16:49:57.336Z" },
        "lastModified": "2018-09-21T16:49:57.336Z"
    },
    "externalIdShowReExecuteButton": "0001e"true,
    "name": {
            "givenNameExecutionId": "TesteAPI2b72d443-e6f6-4693-bd83-318f67585a79",
        "familyName": "Usuário"
    },
    "userNameProcessName": "testeapiusuario",
Cópia de Permissões de Usuários"phoneNumbers": [,
        {
            "valueServerName": "31974964158GlbCopyPermisUsrProc",
        }
    ],
    "emailsServiceInterface": [null,
        {
            "valueScheduler": "[email protected]"1,
                "typeUseJobMonitor": "string"true,
                "primaryScheduleDateTime": true"2018-12-06T10:39:57.5233678-02:00",
        }
    ],
    "activeCanSendMail": truefalse,
       "groups": [
        {"CanWaitSchedule": false,
                "valueSendMail": "01"false,
                "displayFriendlyLogs": "geral"null,
        }
    ],
    "titleSuccessMessage": "MrProcesso executado com sucesso",
    "manager            "FailureMessage": [
"Falha na execução do processo",
    {
            "managerIdSaveLogInDatabase": "01"true,
                "displayNameStatusMessage": "Geral"null,
        }
    ]
}
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
{
    "CodeWaitSchedule": "RMSDbKeyException"false,
     "Message": "Chave duplicada\r\n\r\nPossíveis causas:\r\n  - inclusão de registro cujo valor da chave primária já existe\r\n  - inclusão de registro cujo valor do índice único já existe",
    "DetailMessage": "   em RM.Lib.Data.DbServices.UpdateTable(DataTable table, UpdateMode mode, Boolean logOperation, String userName, Int32 batchSize) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Data\\RMSData.cs:linha 897\r\n   em RM.Lib.Data.DbServices.UpdateTable(DataTable table, UpdateMode mode, String userName, Int32 batchSize) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Data\\RMSData.cs:linha 865\r\n   em RM.Lib.Data.DbServices.QueryUpdate(DataSet dataSet, String tableName, String codUsuario) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Data\\RMSData.cs:linha 3429\r\n   em RM.Lib.Data.DbServices.QueryUpdate(DataSet dataSet, String tableName) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Data\\RMSData.cs:linha 3423\r\n   em RM.Glb.Seguranca.GlbUsuarioData.DoSaveRecord(DataSet dataSet, Int32& rowsAffected, Object ownerData) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Seguranca.Data\\GlbUsuarioData.cs:linha 473\r\n   em RM.Lib.Server.RMSDataServer.InternalSaveRecord(RMSContext context, DataSet& dataSet, Object ownerData, Boolean skipSecurity, Boolean skipSecurityCollumns) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 1477\r\n   em RM.Lib.Server.RMSDataServer.SaveRecord(RMSContext context, DataSet& dataSet, Object ownerData) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 651\r\n   em RM.Glb.Api.UserControllerServer.Save(String id, User record) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Api\\UserController.Server.cs:linha 336\r\n   em RM.Glb.Api.UserControllerServer.OnPost(User record) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Api\\UserController.Server.cs:linha 269\r\n   em RM.Lib.Server.RMSCrudServer`1.Post(T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\Api\\RMSCrudServer.cs:linha 80\r\n   em RM.Lib.Api.RMSCrudController`1.OnPost(T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api\\Controllers\\RMSCrudController.cs:linha 135\r\n   em RM.Lib.Api.RMSCrudController`1.Post(T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api\\Controllers\\RMSCrudController.cs:linha 125\r\n   em lambda_method(Closure , Object , Object[] )\r\n   em System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.<>c__DisplayClass10.<GetExecutor>b__9(Object instance, Object[] methodParameters)\r\n   em System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ApiControllerActionInvoker.<InvokeActionAsyncCore>d__0.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__2.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Runtime.CompilerServices.TaskAwaiter`1.GetResult()\r\n   em RM.Lib.Api.Server.ApiAuthenticationFilter.ResultWithChallenge.<ExecuteAsync>d__2.MoveNext() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api.Server\\Filters\\Api.AuthenticationFilter.cs:linha 193\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.AuthenticationFilterResult.<ExecuteAsync>d__0.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ExceptionFilterResult.<ExecuteAsync>d__0.MoveNext()",
    "HelpUrl": null,
    "Details": [
        {
"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,
                "CodeCodSistema": "ExceptionG",
                "MessageNewUser": "Violation{
 of PRIMARY KEY constraint 'PKGUSUARIO'. Cannot insert duplicate key in object 'dbo.GUSUARIO'. The duplicate key value is (testeapiusuario).\r\nThe statement has been terminated.""Usuario": null,
            "DetailMessage        "Nome": null,
                    "HelpUrlSenha": null,
                    "DetailsEmail": [
null,
                    { "codAcesso": null,
                    "CodeUsuariodeRede": "Exception",null
                },
    "Message": "INSERT INTO [GUSUARIO] ([CODUSUARIO], [NOME], [STATUS], [DATAINICIO], [IGNORARAUTENTICACAOLDAP], [DATAEXPIRACAO], [CONFIRMABTNOK], [SENHA], [CONTROLE], [ULTIMACOLIGADA], [CODACESSO], [DTAEXPSENHA], [DIASEXPSENHA], [OBRIGAALTERARSENHA], [NUMLOGININVALIDO], [DATALOGININVALIDO], [EMAIL], [ACESSONET], [INTERNO1], [DATAULTIMOACESSO], [CODUSUARIOREDE], [DOMINIOREDE], [DATAULTIMOACESSOVALIDO], [USUARIOTWITTER], [SENHATWITTER], [USUARIOFACEBOOK], [SENHAFACEBOOK], [USUARIOLINKEDIN], [SENHALINKEDIN], [USERIDFLUIGIDENTITY], [NOMESOCIAL], [USERID], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON]) VALUES ('testeapiusuario', null, 1, '08/10/2018 00:00:00', 'F', null, 1, 'jcmaAAAA', -17702, , 'Acesso01', null, , 'T', , null, '[email protected]', 'F', null, null, null, null, null, null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, null, '9b69c210-8d20-45b6-afae-534ce10fd4b7', 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ), 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ))", "Initialized": true,
                "PrimaryKeyList": [
                    [
                        "Fabio.nunes"
                    ]
                ],
    "DetailMessage": null,
           "PrimaryKeyNames": [
        "HelpUrl": null            "CODUSUARIO"
                ],
                "PrimaryKeyTableName": "GUSUARIO",
   "Details             "OnlineMode": nullfalse,
                }
"SyncExecution": false,
              ]  "HideProgressDialog": false,
        },
         {"SaveParamsExecution": false,
                "CodeCodUsuario": "Exceptionmestre",
                "MessageContext": "INSERT{
 INTO [GUSUARIO] ([CODUSUARIO], [NOME], [STATUS], [DATAINICIO], [IGNORARAUTENTICACAOLDAP], [DATAEXPIRACAO], [CONFIRMABTNOK], [SENHA], [CONTROLE], [ULTIMACOLIGADA], [CODACESSO], [DTAEXPSENHA], [DIASEXPSENHA], [OBRIGAALTERARSENHA], [NUMLOGININVALIDO], [DATALOGININVALIDO], [EMAIL], [ACESSONET], [INTERNO1], [DATAULTIMOACESSO], [CODUSUARIOREDE], [DOMINIOREDE], [DATAULTIMOACESSOVALIDO], [USUARIOTWITTER], [SENHATWITTER], [USUARIOFACEBOOK], [SENHAFACEBOOK], [USUARIOLINKEDIN], [SENHALINKEDIN], [USERIDFLUIGIDENTITY], [NOMESOCIAL], [USERID], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON]) VALUES ('testeapiusuario', null, 1, '08/10/2018 00:00:00', 'F', null, 1, 'jcmaAAAA', -17702, , 'Acesso01', null, , 'T', , null, '[email protected]', 'F', null, null, null, null, null, null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, '\\FEz\\1B\\7F1\\18\\B7\\27', null, null, '9b69c210-8d20-45b6-afae-534ce10fd4b7', 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ), 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ))",
   "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "DetailMessage$CODTIPOCURSO": null-1,
            "HelpUrl": null,
            "Details$EDUTIPOUSR": null"-1",
        }
    ]
}

1.3 - PUT

1.3.1 - Put (Atualizar um usuário)

            "$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...
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,
                        "$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.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": [
        {
            "jobScheduleID": "1",
            "lastModified": "0001-01-01T00:00:00",
            "firstExecution": "0001-01-01T00:00:00"
        },
        {
            "jobScheduleID": "2",
            "lastModified": "0001-01-01T00:00:00",
            "firstExecution": "0001-01-01T00:00:00"
        },
        {
            "jobScheduleID": "3",
            "lastModified": "0001-01-01T00:00:00",
            "firstExecution": "0001-01-01T00:00:00"
        }
    ]
}

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)

...

Informações
iconfalse
titlePost
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

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.

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"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

Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "jobScheduleID": "1",
    "status": "active",
    "lastModified": "2018-12-06T14:18:42",
    "processID": "GlbCopyPermisUsrProc",
    "firstExecution": "2018-12-05T01:00: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
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE016",
    "Message": "O corpo da mensagem contém valores inválidos.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "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",
    "status": "inactive",
    "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
    }
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
   "Code": "FE011",
   "Message": "Não foi encontrada nenhuma tarefa pendente com o id 0.",
   "DetailMessage": "",
   "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
   "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
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": "FE019",
    "Message": "Não é possível reiniciar o Job 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)

...

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.

Informações
iconfalse
title1.3.1 Put
Expandir
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

Id: 1

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

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (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,
        "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
    }
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "jobScheduleID": "2",
    "status": "active",
    "lastModified": "2018-12-06T15:29:47",
    "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
Informações
iconfalse
title1.3.1 Post
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

Id: 102771

Url Utilizada: http://localhost:8099/api/rm/glb/v1/jobscheduler/testeapiusuario

Informações
iconfalse
titleExemplo de Entrada Postman

Image Removed

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
  "id": "testeapiusuario",
  "meta": {
    "resourceType": "User",
    "created": "2018-09-21T16:49:57.336Z",
    "lastModified": "2018-09-21T16:49:57.336Z"
  },
  "externalId": "0001e",
  "name": {
    "givenName": "TesteAPI",
    "familyName": "Usuário"
  },
  "userName": "testeapiusuario",
  "phoneNumbers": [
    {
      "value": "31974964158"
    }
  ],
  "emails": [
    {
      "value": "[email protected]",
      "type": "string",
      "primary": true
    }
  ],
  "active": true,
  "groups": [
    {
      "value": "01",
      "display": "geral"
    }
  ],
  "title": "Mr",
  "manager": [
    {
      "managerId": "01",
      "displayName": "Geral"
    }
  ]
}
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
{
    "id": "testeapiusuario",
    "meta": {
        "resourceType": "User",
        "created": "2018-09-21T16:49:57.336Z",
        "lastModified": "2018-09-21T16:49:57.336Z"
    },
    "externalId$CODSISTEMA": "0001eG",
     "name": {
           "givenName$CODUSUARIOSERVICO": "TesteAPI",
        "familyName": "Usuário"
    },
    "userName$CODUSUARIO": "testeapiusuariomestre",
    "phoneNumbers": [
        {
            "value$IDPRJ": "31974964158"-1,
        }
    ],
    "emails$CHAPAFUNCIONARIO": ["-1",
        {
            "value$CODFILIAL": "[email protected]",1
            "type": "string"},
            "primaryEnvironment": true1
        },
    ],
    "UserName": "mestre",
        "activeConnectionId": truenull,
        "groupsConnectionString": [null,
        {
   "DriverType": null,
         "valueIp": "0110.31.4.57",
            "displayHostName": "geralBHD050100279",
        }"JobServerHostName": "BHD050100279",
    ],
    "titleActionName": "MrGlbActionProcCopyPermisUsr",
        "managerMasterActionName": ["GlbUsuarioAction",
        {
    "ActionModule": "G",
        "managerIdJobID": "01",{
            "displayNameID": "Geral"2,
        }
     ]
}
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
{
"ExecID": 1,
            "CodeIsPriorityJob": "RMSApplicationException"false,
            "MessageChildren": "Já existe um usuário com esse e-mail"[]
        },
        "DetailMessageShowReExecuteButton": "true,
    em RM.Lib.RMSException.Throw(String message) na "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
    }
}
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": "C:\\RM\\Atual\\Release\\Lib\\RM.Lib\\Utils\\RMSException.cs:linha 131\r\n   em RM.Glb.Seguranca.GlbUsuarioData.ValidateRow(DataRow row) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Seguranca.Data\\GlbUsuarioData.cs:linha 759\r\n   em RM.Lib.Server.RMSDataServer.ValidateTableRows(DataTable masterTable) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 2509\r\n   em RM.Lib.Server.RMSDataServer.DoValidateRows(DataSet dataSet) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 2449\r\n   em RM.Lib.Server.RMSDataServer.InternalSaveRecord(RMSContext context, DataSet& dataSet, Object ownerData, Boolean skipSecurity, Boolean skipSecurityCollumns) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 1413\r\n   em RM.Lib.Server.RMSDataServer.SaveRecord(RMSContext context, DataSet& dataSet, Object ownerData) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\RMSDataServer.cs:linha 651\r\n   em RM.Glb.Api.UserControllerServer.Save(String id, User record) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Api\\UserController.Server.cs:linha 336\r\n   em RM.Glb.Api.UserControllerServer.OnPut(String id, User record) na C:\\RM\\Atual\\Release\\Glb-Globais\\RM.Glb.Api\\UserController.Server.cs:linha 274\r\n   em RM.Lib.Server.RMSCrudServer`1.Put(String id, T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Server\\Api\\RMSCrudServer.cs:linha 99\r\n   em RM.Lib.Api.RMSCrudController`1.OnPut(String id, T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api\\Controllers\\RMSCrudController.cs:linha 163\r\n   em RM.Lib.Api.RMSCrudController`1.Put(String id, T record) na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api\\Controllers\\RMSCrudController.cs:linha 152\r\n   em lambda_method(Closure , Object , Object[] )\r\n   em System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.<>c__DisplayClass10.<GetExecutor>b__9(Object instance, Object[] methodParameters)\r\n   em System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ApiControllerActionInvoker.<InvokeActionAsyncCore>d__0.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__2.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Runtime.CompilerServices.TaskAwaiter`1.GetResult()\r\n   em RM.Lib.Api.Server.ApiAuthenticationFilter.ResultWithChallenge.<ExecuteAsync>d__2.MoveNext() na C:\\RM\\Atual\\Release\\Lib\\RM.Lib.Api.Server\\Filters\\Api.AuthenticationFilter.cs:linha 193\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.AuthenticationFilterResult.<ExecuteAsync>d__0.MoveNext()\r\n--- Fim do rastreamento de pilha do local anterior onde a exceção foi gerada ---\r\n   em System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n   em System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n   em System.Web.Http.Controllers.ExceptionFilterResult.<ExecuteAsync>d__0.MoveNext()",
    "HelpUrl": null"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
}