Sumário

...

Índice

exclude	Sumário

Objetivo

...

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

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

1 - Métodos

...

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

GET
POST
PUT
DELETE

Informações

icon	false
title	Observação:

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

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

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

Cancelado ou Desativado: "status": "inactive"

Job recorrente:

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

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

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

Sucess
Pending
Running
Failure

1.1 - GET

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

Recorrência do Job:

Âncora

	recurrencyType
	recurrencyType

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

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

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

Bloco de código

language	js

"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

icon	false
title	GetAll

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo 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

jobScheduleID": "

17/11/2008 17:16:05

1",
            "status": "completed",

"executionID

         "lastModified": "

1

2018-12-06T14:41:52",
            "processID": "GlbCopyPermisUsrProc",
            "

scheduleID

firstExecution": "

100001

2018-12-06T14:41:52",

"user": "mestre",

"recurrent": false,

"executionParameter": {

Permissoes

SourceUsuario":

null

"mestre",

Initialized

RemoveOldPermissions": false,

PrimaryKeyList

CopyToAllApplications":

[

true,
                "CodSistema": "G",

[

        "NewUser": {
                    "Usuario":

1

null,
                    "Nome": null,

0

             "Senha": null,

]

          "Email": null,

],

           "codAcesso": null,

"PrimaryKeyNames":

[

           "UsuariodeRede": null

"CODCOLIGADA",

},

IDPRJ

Initialized": true,
                "PrimaryKeyList": [

],

"PrimaryKeyTableName":

null,

OnlineMode": false,

Fabio.nunes"

"SyncExecution": false,

"HideProgressDialog": false

],

SaveParamsExecution

PrimaryKeyNames":

false,

[
                    "

CodUsuario

CODUSUARIO"

: null,

"Context": {

],

$id

PrimaryKeyTableName": "

1

GUSUARIO",
                "OnlineMode": false,

"_params":

{},

       "SyncExecution": false,
                "

Environment

HideProgressDialog":

0

false,

}

"SaveParamsExecution": false,

UserName

CodUsuario": "

Breno

mestre",

"ConnectionId": null,

"Context": {
                    "

ConnectionString

$id":

null

"1",
                    "

DriverType

_params":

null,

{
                        "

Ip

$EXERCICIOFISCAL":

"10.31.7.80"

2,
                        "

HostName

$CODLOCPRT":

"RM0005748"

12,
                        "

JobServerHostName

$CODTIPOCURSO":

"RM0005748"

-1,
                        "

ActionName

$EDUTIPOUSR": "

PrjConcederPermissaoAcessoProjetoAction

-1",
                        "

MasterActionName

$CODUNIDADEBIB":

null

-1,
                        "

ActionModule

$CODCOLIGADA":

null

1,
                        "

JobID

$RHTIPOUSR":

{

"-1",
                        "

ID

$CODIGOEXTERNO": "-1",
                        "

ExecID

$CODSISTEMA":

-1

"G",
                        "

IsPriorityJob

$CODUSUARIOSERVICO":

false

"",
                        "

Children

$CODUSUARIO":

[]

"mestre",

}

 "$IDPRJ": -1,
                        "

ExecutionId

$CHAPAFUNCIONARIO": "

1c19b022-c065-42d2-ae20-647259c2e2c0

-1",
                        "

ProcessName

$CODFILIAL":

"Conceder

permissão

de

Acesso

a

Projetos",

},

"ServerName": "PrjConcederPermissaoAcessoProjetoProc",

              "Environment": 1

"ServiceInterface":

null,

    },
                "

Scheduler

UserName":

2

"mestre",

UseJobMonitor

ConnectionId":

false

null,

ScheduleDateTime

ConnectionString":

"2008-11-17T17:15:54.1180698-02:00"

null,

CanSendMail

DriverType":

false

null,

CanWaitSchedule

Ip":

false

"10.31.4.57",

SendMail

HostName":

false

"BHD050100279",

FriendlyLogs

JobServerHostName":

null

"BHD050100279",

SuccessMessage

ActionName": "

Processo executado com sucesso

GlbActionProcCopyPermisUsr",

FailureMessage

MasterActionName": "

Falha na execução do processo

GlbUsuarioAction",

SaveLogInDatabase

ActionModule":

false

"G",

StatusMessage

JobID":

null,

{
                    "

WaitSchedule

ID":

false

1,
                    "

IsolateProcess

ExecID":

false

1,
                    "

DisableIsolateProcess

IsPriorityJob": false,
                    "

NetworkUser

Children":

null,

[]
                },
                "

CustomData

ShowReExecuteButton":

null

true,
                "ExecutionId": "c5665069-1d2b-482f-854a-88f3e7649f1e",
                "

CanParallelize

ProcessName":

false,

"Cópia de Permissões de Usuários",
                "

ShouldParallelize

ServerName":

false

"GlbCopyPermisUsrProc",

QuantityOfSplits

ServiceInterface":

0

null,

MinimumQuantityOfPrimaryKeysPerProcess

Scheduler":

0

1,

MaximumQuantityOfPrimaryKeysPerProcess

UseJobMonitor":

0

true,

NotifyFluig

ScheduleDateTime":

false

"2018-12-06T14:41:40.809678-02:00",

NotifyEmail

CanSendMail": false,

NotifyEmailList

CanWaitSchedule":

null

false,

}

"SendMail": false,
                "

return

FriendlyLogs":

""

null,

}

    "SuccessMessage": "Processo executado com

}

sucesso",

] }

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâ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

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{ "hasNext": true, "items": [ {

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

scheduleID

QuantityOfSplits":

"100001"

0,
                "

status

MinimumQuantityOfPrimaryKeysPerProcess":

"success"

1,
                "

scheduleDate

MaximumQuantityOfPrimaryKeysPerProcess":

"17/11/2008 17:16:01"

1000,
                "

executionDate

NotifyFluig":

"17/11/2008 17:16:05"

false,
                "

executionID

NotifyEmail":

"1"

false,
                "

user

NotifyEmailList":

"",

null

"recurrent": false,

}
        },

"execution":

{

{
            "

processID

jobScheduleID": "

PrjConcederPermissaoAcessoProjetoProc

2",

"status": "

success

active",

scheduleDate

lastModified": "

17/11/2008 17:16:01

2018-12-06T14:43:36",

executionDate

processID": "

17/11/2008 17:16:05

GlbWorkflowExecProc",

executionID

firstExecution": "

1

2018-12-06T14:50:00",

scheduleID

user": "

100001

mestre",

user

recurrent":

""

true,
            "executionParameter": {

"recurrent": false,

executionParameter

CodColigada":

{

1,

Permissoes

IdWorkflow":

null

45,

Initialized

DataSet":

false

null,

PrimaryKeyList

Parameters":

[

null,
                "OwnerData": null,

[

         "Initialized": true,

1

"PrimaryKeyList": [],
                "PrimaryKeyNames": null,

0

     "PrimaryKeyTableName": null,

]

"OnlineMode": false,

]

"SyncExecution": false,

PrimaryKeyNames

HideProgressDialog":

[

false,
                "SaveParamsExecution": false,

"CODCOLIGADA",

         "CodUsuario": "mestre",
                "

IDPRJ

Context": {

]

"$id": "1",
                    "

PrimaryKeyTableName

_params":

null,

{
                        "

OnlineMode

$EXERCICIOFISCAL":

false

2,
                        "

SyncExecution

$CODLOCPRT":

false

12,
                        "

HideProgressDialog

$CODTIPOCURSO":

false

-1,
                        "

SaveParamsExecution

$EDUTIPOUSR":

false

"-1",
                        "

CodUsuario

$CODUNIDADEBIB":

null

-1,
                        "

Context

$CODCOLIGADA":

{

1,
                        "

$id

$RHTIPOUSR": "-1",
                        "

_params

$CODIGOEXTERNO":

{}

"-1",
                        "

Environment

$CODSISTEMA":

0

"G",

}

 "$CODUSUARIOSERVICO": "",
                        "

UserName

$CODUSUARIO": "

Breno

mestre",
                        "

ConnectionId

$IDPRJ":

null

-1,
                        "

ConnectionString

$CHAPAFUNCIONARIO":

null

"-1",
                        "

DriverType

$CODFILIAL":

null,

"Ip": "10.31.7.80"

},
                    "

HostName

Environment":

"RM0005748",

"JobServerHostName": "RM0005748"

},

ActionName

UserName": "

PrjConcederPermissaoAcessoProjetoAction

mestre",

MasterActionName

ConnectionId": null,

ActionModule

ConnectionString": null,

JobID

DriverType":

{

null,

"Ip": "10.31.4.57",

"ID":

-1,

         "HostName": "BHD050100279",
                "

ExecID

JobServerHostName":

-1

"BHD050100279",
                "ActionName": "GlbWorkflowExecAction",

"IsPriorityJob":

false,

       "MasterActionName": null,
                "

Children

ActionModule":

[]

"G",

},

"JobID": {
                    "

ExecutionId

ID":

"1c19b022-c065-42d2-ae20-647259c2e2c0"

2,
                    "

ProcessName

ExecID":

"Conceder permissão de Acesso a Projetos"

1,
                    "

ServerName

IsPriorityJob":

"PrjConcederPermissaoAcessoProjetoProc"

false,
                    "

ServiceInterface

Children":

null,

[]

"Scheduler": 2

},

UseJobMonitor

ShowReExecuteButton":

false

true,

ScheduleDateTime

ExecutionId": "

2008

a6bad34f-2946-

11-17T17:15:54.1180698-02:00

46ca-b69b-7434004fc0f6",

CanSendMail

ProcessName":

false

"Executar Fórmula Visual",

CanWaitSchedule

ServerName":

false

"GlbWorkflowExecProc",

SendMail

ServiceInterface":

false

null,

FriendlyLogs

Scheduler":

null

1,

SuccessMessage

UseJobMonitor":

"Processo executado com sucesso"

true,

FailureMessage

ScheduleDateTime": "

Falha na execução do processo

2018-12-06T14:43:26.9732933-02:00",

SaveLogInDatabase

CanSendMail": false,

StatusMessage

CanWaitSchedule":

null

false,

WaitSchedule

SendMail": false,

IsolateProcess

FriendlyLogs":

false

null,
                "SuccessMessage": "Processo executado com sucesso"

DisableIsolateProcess": false

NetworkUser

FailureMessage":

null,

"Falha na execução do processo",
                "

CustomData

SaveLogInDatabase":

null

true,

CanParallelize

StatusMessage":

false

null,

ShouldParallelize

WaitSchedule": false,

QuantityOfSplits

IsolateProcess":

0

false,

MinimumQuantityOfPrimaryKeysPerProcess

DisableIsolateProcess":

0

false,
                "NetworkUser": "fabio.nunes",
                "

MaximumQuantityOfPrimaryKeysPerProcess

CustomData":

0

null,
                "CanParallelize": true,
                "

NotifyFluig

ShouldParallelize": false,
                "QuantityOfSplits": 0,

"NotifyEmail

          "MinimumQuantityOfPrimaryKeysPerProcess":

false

1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,

"NotifyEmailList

            "NotifyFluig":

null

false,

}

"NotifyEmail": false,
                "

return

NotifyEmailList":

""

null
            },

}

    "weekly": {

] }

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{ "hasNext": true, "items": [

           "daysOfWeek": [
                    "Monday",

{

scheduleID": "102776

Tuesday",

"status":

"success",

       "Thursday"

"scheduleDate":

"26/10/2018 10:37:51",

],

"executionDate":

"26/10/2018

10:38:00",

executionID

hour":

"1"

14,
                "

user

minute":

"rm",

"recurrent": false,

}
        },

"execution":

{

    {
            "

processID

jobScheduleID": "

RMSSendCriticalLogProc

3",

"status": "

success

active",

scheduleDate

lastModified": "

26/10/2018 10:37:51

2018-12-06T14:43:50",

executionDate

processID": "

26/10/2018 10:38:00

GlbWorkflowExecProc",

executionID

firstExecution": "

1

2018-12-06T17:00:00",

"user": "mestre",
            "

scheduleID

recurrent":

"102776",

true,
            "executionParameter": {
                "

user

CodColigada":

"rm"

1,
                "

recurrent

IdWorkflow":

false

45,
                "

executionParameter

DataSet":

{

null,
                "Parameters": null,

"LastErrorSent

             "OwnerData":

"0001-01-01T00:00:00-02:00"

null,

                "Initialized": true,

                "PrimaryKeyList": [],

"PrimaryKeyNames": null,

"PrimaryKeyTableName": null,

"OnlineMode": false,

"SyncExecution": false,

"HideProgressDialog": false,

                "SaveParamsExecution": false,

"CodUsuario":

null

"mestre",

"Context": {

"$id": "1",

                    "_params": {

$CODCOLIGADA

$EXERCICIOFISCAL":

0

2,

$CODSISTEMA

$CODLOCPRT":

"G"

12,

},

"$CODTIPOCURSO": -1,
                        "

Environment

$EDUTIPOUSR":

0

"-1",

}

  "$CODUNIDADEBIB": -1,
                        "

UserName

$CODCOLIGADA":

"rm"

1,
                        "

ConnectionId

$RHTIPOUSR":

null

"-1",
                        "

ConnectionString

$CODIGOEXTERNO":

null

"-1",
                        "

DriverType

$CODSISTEMA":

null

"G",
                        "

Ip

$CODUSUARIOSERVICO": "

127.0.0.1

",
                        "

HostName

$CODUSUARIO": "

localhost

mestre",
                        "

JobServerHostName

$IDPRJ":

"BHD050102417"

-1,
                        "

ActionName

$CHAPAFUNCIONARIO":

null

"-1",
                        "

MasterActionName

$CODFILIAL":

null,

"ActionModule": null

},
                    "

JobID

Environment":

{

1
                },

"ID":

102776,

       "UserName": "mestre",
                "

ExecID

ConnectionId":

1

null,

"IsPriorityJob

"ConnectionString":

false

null,

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

ShouldParallelize": 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

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo 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",

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

"Z000Y0011"

"$CODIGOEXTERNO": "-1",

]

 "$CODSISTEMA": "G",

]

    "$CODUSUARIOSERVICO": "",
                        "

PrimaryKeyNames

$CODUSUARIO":

[

"mestre",
                        "

CODCOLIGADA

$IDPRJ": -1,
                        "

IDOBJOF"

$CHAPAFUNCIONARIO": "-1",

],

    "$CODFILIAL": 1

"PrimaryKeyTableName": null

},
                    "

OnlineMode

Environment":

false,

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

JobID

ServerName":

{

"GlbWorkflowExecProc",
                "ServiceInterface": null,

"ID":

-1,

        "Scheduler": 1,
                "

ExecID

UseJobMonitor":

-1

true,
                "ScheduleDateTime": "2018-12-06T14:43:54.1360093-02:00",

"IsPriorityJob":

false,

        "CanSendMail": false,
                "

Children

CanWaitSchedule":

[]

false,

}

"SendMail": false,

ExecutionId

FriendlyLogs":

"30cda7ed-fa9d-4593-be95-a590f4661b51"

null,

ProcessName

SuccessMessage": "

Calcular

Processo

Média

executado

Diária de Indicador de Uso

com sucesso",

ServerName

FailureMessage": "

MntCalcularMediaDiariaIndicadorUsoProc",

Falha na execução do processo",
                "

ServiceInterface

SaveLogInDatabase":

null

true,

Scheduler

StatusMessage":

1

null,

"UseJobMonitor": true,

"WaitSchedule": false,

ScheduleDateTime

IsolateProcess":

"2009-06-04T15:31:52.7944738-03:00"

false,

CanSendMail

DisableIsolateProcess": false,

CanWaitSchedule

NetworkUser":

false

"fabio.nunes",

SendMail

CustomData":

false

null,

FriendlyLogs

CanParallelize":

null

true,

SuccessMessage

ShouldParallelize":

"Processo executado com sucesso"

false,

FailureMessage

QuantityOfSplits":

"Falha na execução do processo"

0,

SaveLogInDatabase

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

StatusMessage

MaximumQuantityOfPrimaryKeysPerProcess":

null

1000,

WaitSchedule

NotifyFluig": false,

IsolateProcess

NotifyEmail": false,
                "NotifyEmailList": 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

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.4 - Paginação

Informações

title	Parâ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

title	Parâ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

icon	false
title	Order (Asc)

Informações

Expandir

Informações

icon

false

title

title
icon	false

1.1.4 Paginacao

Configuração

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

glb

framework/v1/jobscheduler?

page

order=[-]{

valor1}&pageSize={valor2}

campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1

Campo:

1Valor2: 1

jobScheduleID

Tipo de Ordenação: Ascendente

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

glb

framework/v1/jobscheduler?

page=1&pageSize=1

order=jobScheduleID

PostmanExemplo

Informações

icon	false
title	Exemplo

Image Removed

Informações

icon

false

title

de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

PrimaryKeyNames

SaveParamsExecution":

[

false,

"CODCOLIGADA

"CodUsuario": "mestre",

"IDPRJ"

"Context": {

]

 "$id": "1",
                    "

PrimaryKeyTableName

_params":

null,

{
                        "

OnlineMode

$EXERCICIOFISCAL":

false

2,
                        "

SyncExecution

$CODLOCPRT":

false

12,
                        "

HideProgressDialog

$CODTIPOCURSO":

false

-1,
                        "

SaveParamsExecution

$EDUTIPOUSR":

false

"-1",
                        "

CodUsuario

$CODUNIDADEBIB":

null

-1,
                        "

Context

$CODCOLIGADA":

{

1,
                        "

$id

$RHTIPOUSR": "-1",
                        "

_params

$CODIGOEXTERNO":

{}

"-1",
                        "

Environment

$CODSISTEMA":

0

"G",

}

 "$CODUSUARIOSERVICO": "",
                        "

UserName

$CODUSUARIO": "

Breno

mestre",
                        "

ConnectionId

$IDPRJ":

null

-1,
                        "

ConnectionString

$CHAPAFUNCIONARIO":

null

"-1",
                        "

DriverType

$CODFILIAL":

null,

"Ip": "10.31.7.80"

},
                    "

HostName

Environment":

"RM0005748",

"JobServerHostName": "RM0005748"

},

ActionName

UserName": "

PrjConcederPermissaoAcessoProjetoAction

mestre",

MasterActionName

ConnectionId": null,

ActionModule

ConnectionString": null,

JobID

DriverType":

{

null,
                "Ip": "10.31.4.57",

"ID": -1,

         "HostName": "BHD050100279",
                "

ExecID

JobServerHostName":

-1

"BHD050100279",

"ActionName": "GlbActionProcCopyPermisUsr",

"IsPriorityJob": false,

          "MasterActionName": "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,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "

return

NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            }
        }
    ]
}

Informações

icon	false
title	1.1.

...

2 Order (Desc)

Expandir

Informações

title
icon	false

Parâ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 ...

Configuração

Máscara de Url: http:/

Informações

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": truefalse,
    "items": [
        {
            "scheduleIDjobScheduleID": "1001472",
        },
        {"status": "active",
            "scheduleIDlastModified": "100149"2018-12-06T15:34:53",
        },
        {"processID": "GlbCopyPermisUsrProc",
            "scheduleIDfirstExecution": "100157"2018-12-06T15:30:00",
        },
        {"user": "mestre",
            "scheduleIDrecurrent": "100229"false,
        },
    "executionParameter": {
    {
            "scheduleIDSourceUsuario": "100302mestre",
         },
        {"RemoveOldPermissions": false,
                "scheduleIDCopyToAllApplications": "100310"true,
        },
         {
"CodSistema": "G",
                "scheduleIDNewUser": "100326"
{
           },
         {"Usuario": null,
            "scheduleID": "100360"
       "Nome": }null,
        {
            "scheduleIDSenha": "100362"
null,
            },
        {"Email": null,
            "scheduleID": "101341"
       "codAcesso": }null,
        {
            "scheduleIDUsuariodeRede": "102083"null
        },
        {},
                "scheduleIDInitialized": "102473"true,
        },
        "PrimaryKeyList": {[
            "scheduleID": "102474"
        },[
        {
            "scheduleID":    "102767Fabio.nunes"
            },
        {]
            "scheduleID": "102769"    ],
        },
        "PrimaryKeyNames": {[
                 "scheduleID":   "102771CODUSUARIO"
        },
        {],
                "scheduleIDPrimaryKeyTableName": "102772GUSUARIO",
        }        "OnlineMode": false,
        {        "SyncExecution": false,
                "scheduleIDHideProgressDialog": "102777"false,
        },
        {
"SaveParamsExecution": false,
                "scheduleIDCodUsuario": "102764mestre",
         },
       "Context": {
            "scheduleID        "$id": "1003601",
         }
           "_params": ]
}

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

Informações

title	Parâ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.

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

1.1.3 - Filter (Resultado filtrado)

...

Informações

icon	false
title	Filter

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	Paginação

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	Fields

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleId

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

title	Parâ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

icon	false
title	GetOne

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 1

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	Post

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	Post

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 102771

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

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{ "scheduleID": "102771", "status": "pending", "scheduleDate": "24/10/2070 23:00:00", "executionDate": "", "executionID": "1", "user": "mestre", "recurrent": false, "single": { "year": 2070, "month": 10, "day": 24, "hour": 23, "minute": 0 }, "execution": { "processID": "RptProcGenerateReport

",

"status":

"pending",

scheduleDate

$CODUNIDADEBIB":

"24/10/2070 23:00:00"

-1,

"executionDate":

"",

executionID

$CODCOLIGADA":

"

"scheduleID":

"102771",

user

$RHTIPOUSR": "

mestre

-1",

"recurrent":

false,

executionParameter

$CODIGOEXTERNO": "-1",

} }

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada Postman

Image Removed

Informações

icon	false
title	Exemplo de Entrada

{ "scheduleDate": "2018-10-26 23:05:00", "recurrent": true

           "$CODSISTEMA": "G",
                "$CODUSUARIOSERVICO": "",
                "$CODUSUARIO": "mestre",
                "$IDPRJ": -1,
                "$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 1
            },
            "Environment": 1
        },
        "

daily

UserName":

{

"mestre",
        "

hour

ConnectionId":

10

null,
        "

minute

ConnectionString":

15

null,

}

      "DriverType": null,
        "

execution

Ip":

{

"10.31.4.57",
        "

processID

HostName": "

GlbCopyPermisUsrProc

BHD050100279",
        "

scheduleDate

JobServerHostName": "

string",

BHD050100279",
        "

executionDate

ActionName": "

string

GlbActionProcCopyPermisUsr",
        "

executionID

MasterActionName": "

string

GlbUsuarioAction",
        "

scheduleID

ActionModule": "

string

G",
        "

user

JobID":

"string",

"recurrent

        "ID":

true

3,

"executionParameter": { "SourceUsuario

      "ExecID":

"mestre", "RemoveOldPermissions

1,
            "IsPriorityJob": false,

"CopyToAllApplications

            "Children":

true, "CodSistema": "G", "NewUser": { "Usuario": "testepost", "Nome": "testepost", "Senha": "totvs", "Email": "testepost", "codAcesso": "Acesso01", "UsuariodeRede": "" }, "Initialized": true, "PrimaryKeyList": [], "PrimaryKeyNames": null, "PrimaryKeyTableName": null, "OnlineMode": false, "SyncExecution": false, "HideProgressDialog": false, "SaveParamsExecution": false, "CodUsuario": "mestre", "Context": { "$id": "1", "_params": { "$EXERCICIOFISCAL": -1, "$CODLOCPRT": -1, "$CODTIPOCURSO": -1, "$EDUTIPOUSR": "-1", "$CODUNIDADEBIB": -1, "$CODCOLIGADA": 1, "$RHTIPOUSR": "-1", "$CODIGOEXTERNO": "-1", "$CODSISTEMA": "G", "$CODUSUARIOSERVICO": "", "$CODUSUARIO": "mestre", "$IDPRJ": -1, "$CHAPAFUNCIONARIO": "-1", "$CODFILIAL": -1 }, "Environment": 1 }, "UserName": "mestre", "ConnectionId": null, "ConnectionString": null, "DriverType": null, "Ip": "10.31.4.57", "HostName": "BHD050100279", "JobServerHostName": "BHD050100279", "ActionName": "GlbActionProcCopyPermisUsr", "MasterActionName": "GlbUsuarioAction", "ActionModule": "G", "JobID": { "ID": 1, "ExecID": 1, "IsPriorityJob": false, "Children": [] }, "ShowReExecuteButton": true, "ExecutionId": "7dba5874-a296-43bc-89fd-ab853121feec", "ProcessName": "Cópia de Permissões de Usuários", "ServerName": "GlbCopyPermisUsrProc", "ServiceInterface": null, "Scheduler": 1, "UseJobMonitor": true, "ScheduleDateTime": "2018-10-25T12:04:31.8719316-03: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 } }

[]
        },
        "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
    }
}

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	Post

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

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

icon	false
title	1.3.1 Put

Expandir

Resultado Positivo Postman

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de

Configuração

Domínio: localhost

Porta: 8051

Id: 1

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

Image Removed

Informações

icon	false
title	Exemplo de Resultado PositivoEntrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true
)
linenumbers	true

{
   	"firstExecution": "2018-12-06 15:30:00",
	"processID": "GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": true,
	"daily": {
    "scheduleID            "hour": "17"0,
                "statusminute": "pending" 1
            },
    "scheduleDateexecutionParameter": "26/10/2018 23:05:00",
{
        "executionDateSourceUsuario": "mestre",
        "executionIDRemoveOldPermissions": "1"false,
        "userCopyToAllApplications": "mestre"true,
        "recurrentCodSistema": true"G",
        "dailyNewUser": {
            "hourUsuario": 10null,
            "minuteNome": 15null,
      },
      "executionSenha": {null,
            "processIDEmail": "GlbCopyPermisUsrProc",
 null,
            "statuscodAcesso": "pending"null,
            "scheduleDateUsuariodeRede": "26/10/2018 23:05:00",null
        "executionDate": ""},
        "executionIDInitialized": "1"true,
        "scheduleIDPrimaryKeyList": "17",
[
           "user": "mestre", [
        "recurrent": true,
        "executionParameter": {
Fabio.nunes"
            ]
   "SourceUsuario": "mestre",
    ],
        "RemoveOldPermissionsPrimaryKeyNames": false,[
            "CopyToAllApplications": true,
CODUSUARIO"
        ],
        "CodSistemaPrimaryKeyTableName": "GGUSUARIO",
            "NewUserOnlineMode": {false,
        "SyncExecution": false,
        "UsuarioHideProgressDialog": "testepost"false,
        "SaveParamsExecution": false,
        "NomeCodUsuario": "testepostmestre",
        "Context": {
            "Senha$id": "totvs1",
                "Email_params": "testepost",{
                "codAcesso$EXERCICIOFISCAL": "Acesso01"2,
                "UsuariodeRede$CODLOCPRT": ""12,
            },
            "Initialized$CODTIPOCURSO": true-1,
                "PrimaryKeyList$EDUTIPOUSR": []"-1",
                "PrimaryKeyNames$CODUNIDADEBIB": null-1,
                "PrimaryKeyTableName$CODCOLIGADA": null1,
                "OnlineMode$RHTIPOUSR": false"-1",
                "SyncExecution$CODIGOEXTERNO": false"-1",
                "HideProgressDialog$CODSISTEMA": false"G",
                "SaveParamsExecution$CODUSUARIOSERVICO": false"",
                "CodUsuario$CODUSUARIO": "mestre",
                "Context$IDPRJ": {-1,
                "$id$CHAPAFUNCIONARIO": "-1",
                "_params$CODFILIAL": {1
            },
            "$EXERCICIOFISCALEnvironment": -1,
        },
        "UserName": "mestre",
        "$CODLOCPRTConnectionId": -1null,
           "ConnectionString": null,
         "$CODTIPOCURSODriverType": -1null,
        "Ip": "10.31.4.57",
           "$EDUTIPOUSRHostName": "-1BHD050100279",
        "JobServerHostName": "BHD050100279",
           "$CODUNIDADEBIBActionName": -1"GlbActionProcCopyPermisUsr",
        "MasterActionName": "GlbUsuarioAction",
           "$CODCOLIGADAActionModule": 1"G",
        "JobID": {
            "$RHTIPOUSRID": "-1",
                    "$CODIGOEXTERNOExecID": "-1",
                    "$CODSISTEMAIsPriorityJob": "G"false,
            "Children": []
       "$CODUSUARIOSERVICO": "" },
        "ShowReExecuteButton": true,
           "$CODUSUARIOExecutionId": "mestre2b72d443-e6f6-4693-bd83-318f67585a79",
        "ProcessName": "Cópia de Permissões de Usuários",
        "$IDPRJServerName": -1"GlbCopyPermisUsrProc",
           "ServiceInterface": null,
         "$CHAPAFUNCIONARIOScheduler": "-1",
          "UseJobMonitor": true,
          "$CODFILIALScheduleDateTime": -1
"2018-12-06T10:39:57.5233678-02:00",
        "CanSendMail": false,
        "CanWaitSchedule": }false,
        "SendMail": false,
        "EnvironmentFriendlyLogs": 1null,
        "SuccessMessage": "Processo executado com }sucesso",
            "UserNameFailureMessage": "mestre",
Falha na execução do processo",
        "ConnectionIdSaveLogInDatabase": nulltrue,
            "ConnectionStringStatusMessage": null,
            "DriverTypeWaitSchedule": nullfalse,
            "IpIsolateProcess": "10.31.4.57"false,
            "HostNameDisableIsolateProcess": "BHD050100279"false,
            "JobServerHostNameNetworkUser": "BHD050100279fabio.nunes",
            "ActionNameCustomData": "GlbActionProcCopyPermisUsr"null,
            "MasterActionNameCanParallelize": "GlbUsuarioAction"true,
            "ActionModuleShouldParallelize": "G"false,
            "JobIDQuantityOfSplits": {0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "IDMaximumQuantityOfPrimaryKeysPerProcess": 171000,
        "NotifyFluig": false,
        "ExecIDNotifyEmail": 1false,
        "NotifyEmailList": null
    }
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "IsPriorityJobjobScheduleID": false"2",
    "status": "active",
       "lastModified": "2018-12-06T15:29:47",
    "ChildrenprocessID": []"GlbCopyPermisUsrProc",
            }"firstExecution": "2018-12-06T15:30:00",
        "user": "mestre",
    "ShowReExecuteButtonrecurrent": true,
    "executionParameter": {
        "ExecutionIdSourceUsuario": "7dba5874-a296-43bc-89fd-ab853121feecmestre",
            "ProcessNameRemoveOldPermissions": "Cópia de Permissões de Usuários"false,
            "ServerNameCopyToAllApplications": "GlbCopyPermisUsrProc"true,
            "ServiceInterfaceCodSistema": null"G",
            "SchedulerNewUser": 1,{
            "UseJobMonitorUsuario": truenull,
            "ScheduleDateTimeNome": "2018-10-25T12:04:31.8719316-03:00"null,
            "CanSendMailSenha": falsenull,
            "CanWaitScheduleEmail": falsenull,
            "SendMailcodAcesso": falsenull,
            "FriendlyLogsUsuariodeRede": null,
        },
    "SuccessMessage": "Processo executado com sucesso"Initialized": true,
            "FailureMessagePrimaryKeyList": "Falha[
 na execução do processo",
         [
   "SaveLogInDatabase": true,
            "StatusMessage": null,
Fabio.nunes"
            ]
  "WaitSchedule": false,
     ],
        "IsolateProcessPrimaryKeyNames": false,[
            "DisableIsolateProcessCODUSUARIO":
 false,
       ],
        "NetworkUserPrimaryKeyTableName": "GUSUARIO",
            "CustomDataOnlineMode": nullfalse,
            "CanParallelizeSyncExecution": truefalse,
            "ShouldParallelizeHideProgressDialog": false,
            "QuantityOfSplitsSaveParamsExecution": 0false,
            "MinimumQuantityOfPrimaryKeysPerProcessCodUsuario": 1"mestre",
            "MaximumQuantityOfPrimaryKeysPerProcessContext": 1000,{
            "NotifyFluig$id": false"1",
            "NotifyEmail_params": false,{
                "NotifyEmailList$EXERCICIOFISCAL": null2,
        }
    }
}

Informações

icon	false
title	Exemplo de Resultado Negativo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE016",
    "Message$CODLOCPRT": "Não12,
 foi possível recuperar o corpo da mensagem.\r\nFavor verificar se o corpore está preenchido corretamente.",
    "DetailMessage$CODTIPOCURSO": ""-1,
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
         "Details": null
}

1.3 - PUT

1.3.1 - Put (Atualizar um usuário)

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 102771

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

Informações

icon	false
title	Exemplo de Entrada Postman

Image Removed

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
  "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]   "$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",
        "typeHostName": "stringBHD050100279",
        "primaryJobServerHostName": true"BHD050100279",
    }
  ],
  "activeActionName": true"GlbActionProcCopyPermisUsr",
        "groupsMasterActionName": ["GlbUsuarioAction",
    {
      "valueActionModule": "01G",
        "displayJobID": "geral"{
     }
     ],
  "titleID": "Mr"2,
  "manager          "ExecID": [1,
    {
         "IsPriorityJob": false,
     "managerId": "01",
      "displayNameChildren": "Geral"[]
        },
  ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Image Removed

Exemplo de Resultado Negativo Postman

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
      "idShowReExecuteButton": "testeapiusuario"true,
        "metaExecutionId": {"2b72d443-e6f6-4693-bd83-318f67585a79",
        "resourceTypeProcessName": "UserCópia de Permissões de Usuários",
        "createdServerName": "2018-09-21T16:49:57.336ZGlbCopyPermisUsrProc",
        "lastModifiedServiceInterface": "2018-09-21T16:49:57.336Z"null,
    },
    "externalIdScheduler": "0001e"1,
        "nameUseJobMonitor": {true,
        "givenNameScheduleDateTime": "TesteAPI2018-12-06T10:39:57.5233678-02:00",
        "familyNameCanSendMail": "Usuário"false,
    },
    "userNameCanWaitSchedule": "testeapiusuario"false,
        "phoneNumbersSendMail": [false,
        {
  "FriendlyLogs": null,
          "valueSuccessMessage": "31974964158"
Processo executado       }com sucesso",
    ],
    "emailsFailureMessage": [
   "Falha na execução do processo",
     {
   "SaveLogInDatabase": true,
        "valueStatusMessage": "[email protected]"null,
            "typeWaitSchedule": "string"false,
            "primaryIsolateProcess": truefalse,
        }"DisableIsolateProcess": false,
    ],
    "activeNetworkUser": true"",
        "groupsCustomData": [null,
        {
    "CanParallelize": true,
        "valueShouldParallelize": "01"false,
            "displayQuantityOfSplits": "geral"0,
        }"MinimumQuantityOfPrimaryKeysPerProcess": 1,
    ],
    "titleMaximumQuantityOfPrimaryKeysPerProcess": "Mr"1000,
        "managerNotifyFluig": [false,
         {"NotifyEmail": false,
        "NotifyEmailList": null
   "managerId": "01" },
    "daily": {
        "displayNamehour": "Geral"0,
        "minute": }1
    ]}
}

Informações

icon

false

title

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE016",
    "Message": "NãoO foiJob possível10 recuperarnão ofoi corpoencontrado da mensagem.\r\nFavor verificar se o corpore está preenchido corretamente.na base de dados!",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Deletar um Job)

...

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

...

Informações

icon	false
title	1.4.1 Delete

Expandir

title	Clique aqui para expandir...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8050

Idjob: 106124 2

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

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

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

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE015",
    "Message": "Não foi possível desabilitar o job 106124  pois o mesmo já estava desabilitado.",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 24

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

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

1.1 - GET

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

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.2 - Order(Resultado Ordenado)

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

1.2.2 - Post {IdJob}/Trigger

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

1.2.3 - Post {IdJob}/Restart

1.3 - PUT

1.3.1 - Put (Atualizar um Job)

1.3 - PUT

1.3.1 - Put (Atualizar um usuário)

1.4 - DELETE

1.4.1 - Delete (Deletar um Job)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 24

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

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

1.1 - GET

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

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.2 - Order(Resultado Ordenado)

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

1.2.2 - Post {IdJob}/Trigger

1.2 - POST

1.2.1 - Post (Inserir um agendamento de job)

1.2.3 - Post {IdJob}/Restart

1.3 - PUT

1.3.1 - Put (Atualizar um Job)

1.3 - PUT

1.3.1 - Put (Atualizar um usuário)

1.4 - DELETE

1.4.1 - Delete (Deletar um Job)