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/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

{ "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",
            "user": "mestre",
            "

Permissoes

recurrent":

null

false,

Initialized

executionParameter":

false,

{
                "

PrimaryKeyList

SourceUsuario":

[

"mestre",
                "RemoveOldPermissions": false,

[

         "CopyToAllApplications": true,

1

"CodSistema": "G",
                "NewUser": {

0

       "Usuario": null,

]

"Nome": null,

]

"Senha": null,
                    "

PrimaryKeyNames

Email":

[

null,

CODCOLIGADA

codAcesso": null,

IDPRJ

UsuariodeRede": null

]

},

PrimaryKeyTableName

Initialized":

null

true,

OnlineMode

PrimaryKeyList":

false,

"SyncExecution": false,

[
                        "

HideProgressDialog": false,

Fabio.nunes"

"SaveParamsExecution": false,

"CodUsuario": null

],

Context

PrimaryKeyNames":

{

"$id": "1",

"CODUSUARIO"
                ],

"_params":

{},

       "PrimaryKeyTableName": "GUSUARIO",
                "

Environment

OnlineMode":

0

false,

}

"SyncExecution": false,

UserName

HideProgressDialog":

"Breno"

false,

ConnectionId

SaveParamsExecution":

null

false,

ConnectionString

CodUsuario":

null

"mestre",

DriverType

Context":

null,

{
                    "

Ip

$id": "

10.31.7.80

1",
                    "

HostName

_params":

"RM0005748",

{
                        "

JobServerHostName

$EXERCICIOFISCAL":

"RM0005748"

2,
                        "

ActionName

$CODLOCPRT":

"PrjConcederPermissaoAcessoProjetoAction"

12,
                        "

MasterActionName

$CODTIPOCURSO":

null

-1,
                        "

ActionModule

$EDUTIPOUSR":

null

"-1",
                        "

JobID

$CODUNIDADEBIB":

{

-1,
                        "

ID

$CODCOLIGADA":

-

1,
                        "

ExecID

$RHTIPOUSR": "-1",
                        "

IsPriorityJob

$CODIGOEXTERNO":

false

"-1",
                        "

Children

$CODSISTEMA":

[]

"G",

}

    "$CODUSUARIOSERVICO": "",
                        "

ExecutionId

$CODUSUARIO": "

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

mestre",
                        "

ProcessName

$IDPRJ":

"Conceder permissão de Acesso a Projetos",

-1,
                        "

ServerName

$CHAPAFUNCIONARIO": "

PrjConcederPermissaoAcessoProjetoProc

-1",
                        "

ServiceInterface

$CODFILIAL":

null,

"Scheduler": 2

},
                    "

UseJobMonitor

Environment":

false,

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

},
                "

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

},

MinimumQuantityOfPrimaryKeysPerProcess

ShowReExecuteButton":

0

true,

MaximumQuantityOfPrimaryKeysPerProcess

ExecutionId":

0

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

NotifyFluig

ProcessName":

false,

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

NotifyEmail

ServerName":

false

"GlbCopyPermisUsrProc",

NotifyEmailList

ServiceInterface": null,

}

"Scheduler": 1,
                "

return

UseJobMonitor":

""

true,

}

} ] }

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/framework/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/framework/v1/jobscheduler?order=scheduleID

Informações

icon	false
title	Exemplo de Resultado

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

"ScheduleDateTime": "2018-12-06T14:41:40.809678-02:00",
                "CanSendMail": false,
                "CanWaitSchedule": false,
                "SendMail": false,
                "FriendlyLogs": null,
                "SuccessMessage": "Processo executado com sucesso",
                "

scheduleID

FailureMessage": "

100001",

Falha na execução

do processo",

"status":

"success",

scheduleDate

SaveLogInDatabase":

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

true,
                "

executionDate

StatusMessage":

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

null,
                "

executionID

WaitSchedule":

"1"

false,
                "

user

IsolateProcess":

""

false,
                "

recurrent

DisableIsolateProcess": false,
                "

execution

NetworkUser":

{

"fabio.nunes",
                "

processID

CustomData":

"PrjConcederPermissaoAcessoProjetoProc"

null,
                "

status

CanParallelize":

"success"

true,
                "

scheduleDate

ShouldParallelize":

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

false,
                "

executionDate

QuantityOfSplits":

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

0,
                "

executionID

MinimumQuantityOfPrimaryKeysPerProcess":

"

,
                "

scheduleID

MaximumQuantityOfPrimaryKeysPerProcess":

"100001"

1000,
                "

user

NotifyFluig":

""

false,
                "

recurrent

NotifyEmail": false,
                "

executionParameter

NotifyEmailList":

{

null
            }

"Permissoes": null

},
        {
            "

Initialized

jobScheduleID":

false

"2",

PrimaryKeyList

status":

[

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

[

 "processID": "GlbWorkflowExecProc",
            "firstExecution": "2018-12-06T14:50:00",

1

"user": "mestre",
            "recurrent": true,
            "executionParameter": {

0

              "CodColigada": 1,

]

      "IdWorkflow": 45,

],

   "DataSet": null,
                "

PrimaryKeyNames

Parameters":

[

null,
                "OwnerData": null,

"CODCOLIGADA",

       "Initialized": true,
                "

IDPRJ

PrimaryKeyList": [],

]

"PrimaryKeyNames": null,

                "PrimaryKeyTableName": null,

"OnlineMode": false,

"SyncExecution": false,

"HideProgressDialog": false,

"SaveParamsExecution": false,

"CodUsuario":

null

"mestre",

                "Context": {

"$id": "1",

                    "_params": {

},

Environment

$EXERCICIOFISCAL":

0

2,

}

  "$CODLOCPRT": 12,
                        "

UserName

$CODTIPOCURSO":

"Breno"

-1,
                        "

ConnectionId

$EDUTIPOUSR":

null

"-1",
                        "

ConnectionString

$CODUNIDADEBIB":

null

-1,
                        "

DriverType

$CODCOLIGADA":

null

1,
                        "

Ip

$RHTIPOUSR": "

10.31.7.80

-1",
                        "

HostName

$CODIGOEXTERNO": "

RM0005748

-1",
                        "

JobServerHostName

$CODSISTEMA": "

RM0005748

G",
                        "

ActionName

$CODUSUARIOSERVICO": "

PrjConcederPermissaoAcessoProjetoAction

",
                        "

MasterActionName

$CODUSUARIO":

null

"mestre",
                        "

ActionModule

$IDPRJ":

null

-1,
                        "

JobID

$CHAPAFUNCIONARIO":

{

"-1",
                        "

ID

$CODFILIAL":

-

,

},

"ExecID":

-1,

                "Environment": 1

"IsPriorityJob":

false,

        },
                "

Children

UserName":

[]

"mestre",

}

"ConnectionId": null,

ExecutionId

ConnectionString":

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

null,
                "DriverType": null,

"ProcessName":

"Conceder

permissão

de

Acesso

a

Projetos",

       "Ip": "10.31.4.57",
                "

ServerName

HostName": "

PrjConcederPermissaoAcessoProjetoProc

BHD050100279",

ServiceInterface

JobServerHostName":

null

"BHD050100279",

Scheduler

ActionName":

2

"GlbWorkflowExecAction",

UseJobMonitor

MasterActionName":

false

null,

ScheduleDateTime

ActionModule": "

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

G",

CanSendMail

JobID":

false,

{
                    "

CanWaitSchedule

ID":

false

2,
                    "

SendMail

ExecID":

false

1,
                    "

FriendlyLogs

IsPriorityJob":

null

false,
                    "

SuccessMessage

Children":

"Processo

[]

executado

com

sucesso",

},

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

         "ShowReExecuteButton": true,
                "

SaveLogInDatabase

ExecutionId":

false

"a6bad34f-2946-46ca-b69b-7434004fc0f6",
                "ProcessName": "Executar Fórmula

Visual"

StatusMessage": null

WaitSchedule

ServerName":

false

"GlbWorkflowExecProc",

IsolateProcess

ServiceInterface":

false

null,

DisableIsolateProcess

Scheduler":

false

1,

NetworkUser

UseJobMonitor":

null

true,

CustomData

ScheduleDateTime":

null,

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

CanParallelize

CanSendMail": false,

ShouldParallelize

CanWaitSchedule": false,

QuantityOfSplits

SendMail":

0

false,

MinimumQuantityOfPrimaryKeysPerProcess

FriendlyLogs":

0

null,
                "SuccessMessage": "Processo executado com

"MaximumQuantityOfPrimaryKeysPerProcess

sucesso"

: 0

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

NotifyFluig": false

,
                "SaveLogInDatabase": true,

"NotifyEmail

         "StatusMessage": null,
                "WaitSchedule": false,
                "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

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/framework/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/framework/v1/jobscheduler?order=-scheduleID

Informações

icon	false
title	Exemplo de Resultado

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

            "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "

scheduleID

NotifyFluig":

"102776"

false,
                "

status

NotifyEmail":

"success"

false,
                "

scheduleDate

NotifyEmailList":

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

null

"executionDate": "26/10/2018 10:38:00"

},
            "

executionID

weekly":

"1",

{
                "

user

daysOfWeek":

"rm",

"recurrent":

false,

       "Monday",

"execution":

{

"processID":

RMSSendCriticalLogProc

Tuesday",

"status":

success

Thursday"

,

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

],
                "

executionDate

hour":

"26/10/2018 10:38:00"

14,
                "

executionID

minute":

"1",

50
            }

"scheduleID": "102776"

 },
        {
            "

user

jobScheduleID": "

rm

3",

recurrent

status":

false

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

"executionParameter":

{

        "processID": "GlbWorkflowExecProc",
            "

LastErrorSent

firstExecution": "

0001

2018-

01

12-

01T00

06T17:00:00

-02:00

",
            "user": "mestre",
            "

Initialized

recurrent": true,

"PrimaryKeyList

"executionParameter":

[],

PrimaryKeyNames

CodColigada":

null

1,

PrimaryKeyTableName

IdWorkflow":

null

45,

OnlineMode

DataSet":

false

null,

SyncExecution

Parameters":

false

null,

HideProgressDialog

OwnerData":

false

null,

SaveParamsExecution

Initialized":

false

true,

CodUsuario

PrimaryKeyList":

null

[],

Context

PrimaryKeyNames":

{

null,

"$id

"PrimaryKeyTableName":

"1"

null,
                "OnlineMode": false,

"_params":

{

        "SyncExecution": false,

$CODCOLIGADA

HideProgressDialog":

0

false,
                "SaveParamsExecution": false,
                "

$CODSISTEMA

CodUsuario": "

G

mestre",

},

"Context": {
                    "

Environment

$id":

0

"1",

},

 "_params": {
                        "

UserName

$EXERCICIOFISCAL":

"rm"

2,
                        "

ConnectionId

$CODLOCPRT":

null

12,
                        "

ConnectionString

$CODTIPOCURSO":

null

-1,
                        "

DriverType

$EDUTIPOUSR":

null

"-1",
                        "

Ip

$CODUNIDADEBIB":

"127.0.0.1"

-1,
                        "

HostName

$CODCOLIGADA":

"localhost"

1,
                        "

JobServerHostName

$RHTIPOUSR": "

BHD050102417

-1",
                        "

ActionName

$CODIGOEXTERNO":

null

"-1",
                        "

MasterActionName

$CODSISTEMA":

null

"G",
                        "

ActionModule

$CODUSUARIOSERVICO":

null

"",
                        "

JobID

$CODUSUARIO":

{

"mestre",
                        "

ID

$IDPRJ":

102776

-1,
                        "

ExecID

$CHAPAFUNCIONARIO": "-1",
                        "

IsPriorityJob

$CODFILIAL":

false,

1
                    },

"Children":

[]

},

"Environment": 1

"ShowReExecuteButton": true

},

ExecutionId

UserName": "

a88518a8-56c4-43d7-b8f0-c97eda42e5d9

mestre",

ProcessName

ConnectionId": null,

ServerName

ConnectionString": null,

ServiceInterface

DriverType": null,

Scheduler

Ip":

1

"10.31.4.57",

UseJobMonitor

HostName":

true

"BHD050100279",

ScheduleDateTime

JobServerHostName": "

2018-10-26T10:37:51.4185986-02:00

BHD050100279",

CanSendMail

ActionName":

false

"GlbWorkflowExecAction",

CanWaitSchedule

MasterActionName":

false

null,

SendMail

ActionModule":

false

"G",

FriendlyLogs

JobID":

null,

{
                    "

SuccessMessage

ID":

"Processo executado com sucesso"

3,
                    "

FailureMessage

ExecID":

"Falha na execução do processo"

1,
                    "

SaveLogInDatabase

IsPriorityJob":

true

false,
                    "

StatusMessage

Children":

null,

[]

"WaitSchedule": false

},

IsolateProcess

ShowReExecuteButton":

false

true,

DisableIsolateProcess

ExecutionId":

false

"ef13b977-7293-4d52-91a6-44694cbeddc9",
                "ProcessName": "Executar Fórmula

"NetworkUser": null

Visual",

CustomData

ServerName":

null

"GlbWorkflowExecProc",

CanParallelize

ServiceInterface":

false

null,

ShouldParallelize

Scheduler":

false

1,

QuantityOfSplits

UseJobMonitor":

0

true,

MinimumQuantityOfPrimaryKeysPerProcess

ScheduleDateTime":

1

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

MaximumQuantityOfPrimaryKeysPerProcess

CanSendMail":

1000

false,

NotifyFluig

CanWaitSchedule": false,

NotifyEmail

SendMail": false,

NotifyEmailList

FriendlyLogs": null,
                "SuccessMessage":

}

"Processo executado com sucesso",
                "

return

FailureMessage": "

"

Falha na execução do processo",

}

} ] }

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/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

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

"SaveLogInDatabase": true,
                "StatusMessage": null,
                "WaitSchedule": false,
                "IsolateProcess": false,
                "DisableIsolateProcess": false,
                "NetworkUser": "fabio.nunes",
                "CustomData": null,

scheduleID

CanParallelize":

"100360"

true,
                "

status

ShouldParallelize":

"pending"

false,
                "

scheduleDate

QuantityOfSplits":

"26/10/2018 11:00:00"

0,
                "

executionDate

MinimumQuantityOfPrimaryKeysPerProcess":

""

1,
                "

executionID

MaximumQuantityOfPrimaryKeysPerProcess":

"868"

1000,
                "

user

NotifyFluig":

""

false,

"recurrent":

true,

"weekly

"NotifyEmail":

{

false,
                "

daysOfWeek

NotifyEmailList":

[

null
            },

"Sunday",

    "monthly": {
                "

Monday

day": 7,

Tuesday

hour": 17,

Wednesday

minute"

,

: 0
            }

"Thursday"

},
        {
            "

Friday

jobScheduleID": "4",
            "status": "active",

"Saturday"

     "lastModified": "2018-12-06T14:44:06",

],

  "processID": "GlbWorkflowExecProc",

hour

firstExecution":

11

"2018-12-07T18:00:00",

minute

user":

0

"mestre",

}

"recurrent": true,
            "

execution

executionParameter": {
                "

processID

CodColigada":

"MntCalcularMediaDiariaIndicadorUsoProc"

1,
                "

status

IdWorkflow":

"success"

45,
                "

scheduleDate

DataSet":

"11/06/2009 11:00:00"

null,
                "

executionDate

Parameters":

"04/04/2011 13:56:05"

null,
                "

executionID

OwnerData":

"1"

null,
                "

scheduleID

Initialized":

"100360"

true,
                "

user

PrimaryKeyList":

""

[],
                "

recurrent

PrimaryKeyNames":

true

null,
                "

executionParameter

PrimaryKeyTableName":

{

null,

CodColigada

OnlineMode":

1

false,

DataInicial

SyncExecution":

"2008-01-01T00:00:00-02:00"

false,

DataFinal

HideProgressDialog":

"2009-06-04T00:00:00-03:00"

false,

Initialized

SaveParamsExecution": false,

PrimaryKeyList

CodUsuario":

[

"mestre",
                "Context": {

[

            "$id": "1",

1,

   "_params": {
                        "

Z000Y0011

$EXERCICIOFISCAL": 2,

]

"$CODLOCPRT": 12,

],

"PrimaryKeyNames

"$CODTIPOCURSO":

[

-1,
                        "

CODCOLIGADA

$EDUTIPOUSR": "-1",
                        "

IDOBJOF

$CODUNIDADEBIB": -1,

]

    "$CODCOLIGADA": 1,
                        "

PrimaryKeyTableName

$RHTIPOUSR":

null

"-1",
                        "

OnlineMode

$CODIGOEXTERNO":

false

"-1",
                        "

SyncExecution

$CODSISTEMA":

false

"G",
                        "

HideProgressDialog

$CODUSUARIOSERVICO":

false

"",
                        "

SaveParamsExecution

$CODUSUARIO":

false

"mestre",
                        "

CodUsuario

$IDPRJ":

null

-1,
                        "

Context

$CHAPAFUNCIONARIO":

{

"-1",
                        "

$id

$CODFILIAL":

"

",

"_params": {

},

"Environment":

0

},

                "UserName": "

Sara

mestre",

"ConnectionId": null,

                "ConnectionString": null,

"DriverType": null,

                "Ip": "10.31.

5

4.

226

57",

"HostName": "

RM005762

BHD050100279",

"

"JobServerHostName": "

RM005762

BHD050100279",

"ActionName": "

MntCalcularMediaDiariaIndicadorUsoAction

GlbWorkflowExecAction",

"MasterActionName": null,

"ActionModule": "

N

G",

"JobID": {

"ID":

-1

4,

                    "ExecID":

-

1,

"IsPriorityJob": false,

"Children": []
                },

},

     "ShowReExecuteButton": true,
                "ExecutionId": "

30cda7ed

c496de16-

fa9d

b989-

4593

4292-

be95

9c10-

a590f4661b51

1991d87f83a8",

                "ProcessName": "

Calcular

Executar

Média Diária de Indicador de Uso

Fórmula Visual",

"ServerName": "

MntCalcularMediaDiariaIndicadorUsoProc

GlbWorkflowExecProc",

"ServiceInterface": null,

"Scheduler": 1,

"UseJobMonitor": true,

"ScheduleDateTime": "

2009

2018-

06

12-

04T15

06T14:

31

43:

52

54.

7944738

1360093-

03

02:00",

"CanSendMail": false,

"CanWaitSchedule": false,

"SendMail": false,

                "FriendlyLogs": null,

"SuccessMessage": "Processo executado com sucesso",

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

                "SaveLogInDatabase":

false

true,

"StatusMessage": null,

                "WaitSchedule": false,

"IsolateProcess": false,

"DisableIsolateProcess": false,

"NetworkUser":

null

"fabio.nunes",

"CustomData": null,

"CanParallelize":

false

true,

"ShouldParallelize": false,

"QuantityOfSplits": 0,

"MinimumQuantityOfPrimaryKeysPerProcess":

0

1,

                "MaximumQuantityOfPrimaryKeysPerProcess":

0

1000,

"NotifyFluig": false,
                "NotifyEmail": false,

"NotifyEmail

       "NotifyEmailList":

false,

null
            },
            "

NotifyEmailList

daily":

null

{
                "hour":

}

1,
                "

return

minute":

""

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

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

expand

Informações

icon	false
title	1.1.4 Paginacao

Order (Asc)

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/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/framework/v1/jobscheduler?

page=1&pageSize=1

order=jobScheduleID

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

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,

"CodUsuario": "

CODCOLIGADA

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

"IsPriorityJob

"ActionName":

false

"GlbActionProcCopyPermisUsr",

"Children

"MasterActionName":

[]

"GlbUsuarioAction",

}

"ActionModule": "G",

ExecutionId

JobID":

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

{
                    "

ProcessName

ID":

"Conceder permissão de Acesso a Projetos"

1,
                    "

ServerName

ExecID":

"PrjConcederPermissaoAcessoProjetoProc"

1,
                    "

ServiceInterface

IsPriorityJob":

null

false,
                    "

Scheduler

Children":

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

"DisableIsolateProcess

sucesso"

: false

NetworkUser

FailureMessage":

null,

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

CustomData

SaveLogInDatabase":

null

true,
                "StatusMessage": null,

"CanParallelize

             "WaitSchedule": false,
                "IsolateProcess": false,
                "

ShouldParallelize

DisableIsolateProcess": false,
                "NetworkUser": "",

"QuantityOfSplits

             "CustomData":

0

null,
                "CanParallelize": true,

"MinimumQuantityOfPrimaryKeysPerProcess

             "ShouldParallelize":

0

false,

MaximumQuantityOfPrimaryKeysPerProcess

QuantityOfSplits": 0,

NotifyFluig

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

NotifyEmail

MaximumQuantityOfPrimaryKeysPerProcess":

false

1000,

NotifyEmailList

NotifyFluig":

null

false,

}

"NotifyEmail": false,
                "

return

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

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/framework/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/framework/v1/jobscheduler?fieldsorder=scheduleID-jobScheduleID

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,
           {
      "CopyToAllApplications": true,
                "scheduleIDCodSistema": "100310G",
         },
       "NewUser": {
            "scheduleID": "100326"
       "Usuario": }null,
        {
            "scheduleIDNome": "100360"
null,
                 }   "Senha": null,
        {
            "scheduleIDEmail": "100362"
null,
                 }   "codAcesso": null,
        {
            "scheduleIDUsuariodeRede": "101341"null
        },
        {},
                "scheduleIDInitialized": "102083"true,
        },
        "PrimaryKeyList": {[
            "scheduleID": "102473"
        },
        {
            "scheduleID": "102474"
        },
        {
            "scheduleID": "102767"
        },
        {
            "scheduleID": "102769"
        },
        {
            "scheduleID": "102771"
        },
        {
            "scheduleID": "102772"
        },
        {
            "scheduleID": "102777"
        },
        {
            "scheduleID": "102764"
        },
        {
            "scheduleID": "100360"
        }
    ]
}

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

Informações

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.

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

1.1.3 - Filter (Resultado filtrado)

...

Informações

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
 }
 }
 ]

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/framework/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/framework/v1/jobscheduler/102771

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": "24/10/2070 23:00:00", "executionDate": "", "executionID": "1", "scheduleID": "102771", "user": "mestre", "recurrent": false, "executionParameter": "" }

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/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

envidas

enviadas as propriedades "

scheduleDate

ScheduleDateTime" e

tipo

Tipo de

recorrência

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,

			"_params": {
				"$EXERCICIOFISCAL": 2,
				"$CODLOCPRT": 12,

				"$CODTIPOCURSO": -1,

				"$EDUTIPOUSR": "-1",

				"$CODUNIDADEBIB": -1,

				"$CODCOLIGADA": 1,

				"$RHTIPOUSR": "-1",

				"$CODIGOEXTERNO": "-1",

"$CODSISTEMA": "G",

				"$CODSISTEMA": "G",
				"$CODUSUARIOSERVICO": "",

				"$CODUSUARIO": "mestre",

				"$IDPRJ": -1,

				"$CHAPAFUNCIONARIO": "-1",

				"$CODFILIAL": 1

},

			},
			"Environment": 1

},

		"UserName": "mestre",

		"ConnectionId": null,

"ConnectionString": 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	1.2.1 Post

Expandir

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:

1

3

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

1

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

{ "scheduleID": "6", "status": "pending", "scheduleDate": "26/10/2018 23:05:00",

executionDate

jobScheduleID": "3",
    "

executionID

status": "

1

inactive",
    "

user

lastModified": "

mestre

2018-12-06T15:36:53",
    "

recurrent": true, "daily

processID":

{

"hour": 23

"GlbCopyPermisUsrProc",

minute

firstExecution":

1 },

"execution": { "processID": "GlbCopyPermisUsrProc"

"2018-12-06T15:30:00",

status

user": "

pending

mestre",

scheduleDate

recurrent":

"26/10/2018 23:05:00"

true,

executionDate

executionParameter":

"",

{
        "

executionID

SourceUsuario": "

1

mestre",
        "

scheduleID

RemoveOldPermissions":

"6"

false,
        "

user

CopyToAllApplications":

"mestre"

true,
        "

recurrent

CodSistema":

true

"G",
        "

executionParameter

NewUser": {
            "

SourceUsuario

Usuario":

"mestre"

null,
            "

RemoveOldPermissions

Nome":

false

null,
            "

CopyToAllApplications

Senha":

true

null,
            "

CodSistema

Email":

"G"

null,
            "

NewUser

codAcesso":

{

null,

Usuario

UsuariodeRede":

"testepost",

null
        },
        "

Nome

Initialized":

"testepost"

true,
        "PrimaryKeyList": [

"Senha": "totvs",

 [
                "

Email": "testepost",

Fabio.nunes"

"codAcesso": "Acesso01",

]
        ],
        "

UsuariodeRede

PrimaryKeyNames":

""

},

"CODUSUARIO"
        ],
        "

Initialized

PrimaryKeyTableName":

true

"GUSUARIO",

PrimaryKeyList

OnlineMode":

[]

false,

PrimaryKeyNames

SyncExecution":

null

false,

PrimaryKeyTableName

HideProgressDialog":

null

false,

OnlineMode

SaveParamsExecution": false,

SyncExecution

CodUsuario":

false

"mestre",

HideProgressDialog

Context":

false,

{
            "

SaveParamsExecution

$id":

false

"1",
            "

CodUsuario

_params":

"mestre",

{
                "

Context

$EXERCICIOFISCAL":

{

2,
                "

$id

$CODLOCPRT":

"1"

12,
                "

_params

$CODTIPOCURSO":

{

-1,

$EXERCICIOFISCAL

$EDUTIPOUSR": "-1",

$CODLOCPRT

$CODUNIDADEBIB": -1,

$CODTIPOCURSO

$CODCOLIGADA":

-

1,

$EDUTIPOUSR

$RHTIPOUSR": "-1",

$CODUNIDADEBIB

$CODIGOEXTERNO": "-1",

$CODCOLIGADA

$CODSISTEMA":

1

"G",

$RHTIPOUSR

$CODUSUARIOSERVICO": "

-1

",

$CODIGOEXTERNO

$CODUSUARIO": "

-1

mestre",

$CODSISTEMA

$IDPRJ":

"G"

-1,

$CODUSUARIOSERVICO

$CHAPAFUNCIONARIO": "-1",

$CODUSUARIO

$CODFILIAL":

"mestre",

1
            },
            "

$IDPRJ

Environment":

-

,

},
        "

$CHAPAFUNCIONARIO

UserName": "

-1

mestre",

"ConnectionId": null,

$CODFILIAL

ConnectionString":

-1

null,
        "DriverType": null,

}

  "Ip": "10.31.4.57",
        "HostName": "BHD050100279",
        "

Environment

JobServerHostName":

1

"BHD050100279",

}

"ActionName": "GlbActionProcCopyPermisUsr",

UserName

MasterActionName": "

mestre

GlbUsuarioAction",

ConnectionId

ActionModule":

null

"G",

ConnectionString

JobID":

null,

{
            "

DriverType

ID":

null

3,
            "

Ip

ExecID":

"10.31.4.57"

1,
            "

HostName

IsPriorityJob":

"BHD050100279"

false,
            "

JobServerHostName

Children":

"BHD050100279",

[]
        },
        "

ActionName

ShowReExecuteButton":

"GlbActionProcCopyPermisUsr"

true,

MasterActionName

ExecutionId": "

GlbUsuarioAction

2b72d443-e6f6-4693-bd83-318f67585a79",

ActionModule

ProcessName": "

G",

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

JobID

ServerName":

{

"GlbCopyPermisUsrProc",

"ID

"ServiceInterface":

6

null,

ExecID

Scheduler": 1,
        "UseJobMonitor": true,
        "

IsPriorityJob

ScheduleDateTime":

false

"2018-12-06T10:39:57.5233678-02:00",
        "CanSendMail": false,
        "

Children

CanWaitSchedule":

[]

false,

}

"SendMail": false,

ShowReExecuteButton

FriendlyLogs":

true

null,

ExecutionId

SuccessMessage": "

7dba5874-a296-43bc-89fd-ab853121feec

Processo executado com sucesso",

ProcessName

FailureMessage": "

Cópia

Falha

de

na

Permissões

execução

de

do

Usuários

processo",

ServerName

SaveLogInDatabase":

"GlbCopyPermisUsrProc"

true,

ServiceInterface

StatusMessage": null,

Scheduler

WaitSchedule":

1

false,

UseJobMonitor

IsolateProcess":

true

false,

ScheduleDateTime

DisableIsolateProcess":

"2018-10-25T12:04:31.8719316-03:00"

false,

CanSendMail

NetworkUser":

false

"",

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

true

1000,

StatusMessage

NotifyFluig":

null

false,

WaitSchedule

NotifyEmail": false,
        "NotifyEmailList": null

"IsolateProcess":

false

},
    "daily": {
        "

DisableIsolateProcess

hour":

false

0,
        "minute": 1

"NetworkUser

}
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

(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."

CustomData": null

"DetailMessage": "",
   "

CanParallelize

HelpUrl":

true,

"http://tdn.totvs.com/x/e0F0GQ",
   "

ShouldParallelize

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

, "QuantityOfSplits": 0, "MinimumQuantityOfPrimaryKeysPerProcess": 1, "MaximumQuantityOfPrimaryKeysPerProcess": 1000, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null } } }

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

FE011

FE019",
    "Message": "Não é

foi

possível

encontrada

reiniciar

nenhuma

tarefa

Job

pendente

com

pois o

id 0

 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.

...

Informações

icon	false
title	1.3.1 Put

Expandir

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

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

{
   	"scheduleDatefirstExecution": "2018-1112-0106 2015:0530:00",
	"processID": "GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": true,
   	"weeklydaily": {
    "daysOfWeek            "hour": [0,
      "Sunday"
      ],
    "hourminute": 1,
         "minute": 0
  },
    "executionexecutionParameter": {
        "processIDSourceUsuario": "GlbCopyPermisUsrProcmestre",
    "executionParameter": {
			"SourceUsuario": "mestre",
			    "RemoveOldPermissions": false,
			        "CopyToAllApplications": true,
			        "CodSistema": "G",
			        "NewUser": {
				            "Usuario": "testepost",
				null,
            "Nome": "testepost",
				null,
            "Senha": "totvs",
				null,
            "Email": "testepost",
				null,
            "codAcesso": "Acesso01",
				null,
            "UsuariodeRede": ""
			},
			null
        },
        "Initialized": true,
			        "PrimaryKeyList": [
            [
                "Fabio.nunes"
            ],
			
        ],
        "PrimaryKeyNames": null,
			[
            "CODUSUARIO"
        ],
        "PrimaryKeyTableName": null,
			"GUSUARIO",
        "OnlineMode": false,
			        "SyncExecution": false,
			        "HideProgressDialog": false,
			        "SaveParamsExecution": false,
			        "CodUsuario": "mestre",
			        "Context": {
				            "$id": "1",
				            "_params": {
					                "$EXERCICIOFISCAL": -1,
					2,
                "$CODLOCPRT": -1,
					"$CODTIPOCURSO": -1,
					"$EDUTIPOUSR": "-1",
					"$CODUNIDADEBIB": -1,
					"$CODCOLIGADA": 1,
					"$RHTIPOUSR": "-1",
					"$CODIGOEXTERNO": "-1",
					"$CODSISTEMA": "G",
					"$CODUSUARIOSERVICO": "",
					"$CODUSUARIO": "mestre",
					"$IDPRJ": -1,
					"$CHAPAFUNCIONARIO12,
                "$CODTIPOCURSO": -1,
                "$EDUTIPOUSR": "-1",
                "$CODUNIDADEBIB": -1,
                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
					"$CODFILIAL                "$CODIGOEXTERNO": "-1
				},
				"Environment": 1
			},
			"UserName",
                "$CODSISTEMA": "mestreG",
			"ConnectionId                "$CODUSUARIOSERVICO": null,
			"ConnectionString": null,
			"DriverType": null,
			"Ip,
                "$CODUSUARIO": "10.31.4.57mestre",
			"HostName                "$IDPRJ": "BHD050100279",
			"JobServerHostName-1,
                "$CHAPAFUNCIONARIO": "BHD050100279-1",
			"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,
		}
  }
}

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

{
    "scheduleID": "2",
    "status": "pending",
    "scheduleDate": "01/11/2018 20:05:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": true,
    "weekly": {                "$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,
        "daysOfWeekShouldParallelize": [false,
        "QuantityOfSplits": 0,
        "SundayMinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": ]1000,
        "hourNotifyFluig": 1false,
        "minuteNotifyEmail": 0false,
    },
    "executionNotifyEmailList": {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

{
    "processIDjobScheduleID": "GlbCopyPermisUsrProc2",
    "status": "active",
    "statuslastModified": "pending2018-12-06T15:29:47",
    "processID": "GlbCopyPermisUsrProc",
    "scheduleDatefirstExecution": "01/11/2018 20:052018-12-06T15:30:00",
        "executionDateuser": "mestre",
    "recurrent": true,
    "executionIDexecutionParameter": "1",{
        "scheduleIDSourceUsuario": "2mestre",
        "userRemoveOldPermissions": "mestre"false,
        "recurrentCopyToAllApplications": true,
        "executionParameterCodSistema": {"G",
            "SourceUsuarioNewUser": "mestre",{
            "RemoveOldPermissionsUsuario": falsenull,
            "CopyToAllApplicationsNome": truenull,
            "CodSistemaSenha": "G"null,
            "NewUserEmail": {null,
                "UsuariocodAcesso": "testepost"null,
                "NomeUsuariodeRede": "testepost",null
        },
        "SenhaInitialized": "totvs"true,
                "Email"PrimaryKeyList": "testepost",[
                "codAcesso": "Acesso01",[
                "UsuariodeRede": ""Fabio.nunes"
            },]
            "Initialized": true],
            "PrimaryKeyListPrimaryKeyNames": [],
            "PrimaryKeyNamesCODUSUARIO": null,

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

Informações

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 Job 10 não foi encontrado na base de dados!",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Deletar um Job)

...

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

...

Informações

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/framework/v1/jobscheduler/{JobID}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8050

Idjob: 106124 2

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler/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.

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 42

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.

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.3 - Post {IdJob}/Restart

1.3 - PUT

1.3.1 - Put (Atualizar um Job)

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 42

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.

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.3 - Post {IdJob}/Restart

1.3 - PUT

1.3.1 - Put (Atualizar um Job)

1.4 - DELETE

1.4.1 - Delete (Deletar um Job)