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": "17/11/2008 17:16:05",

executionID

jobScheduleID": "1",

scheduleID

status": "

100001

completed",

user

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

recurrent

processID":

false

"GlbCopyPermisUsrProc",

executionParameter

firstExecution":

{

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

Permissoes

user":

null

"mestre",

Initialized

recurrent": false,

"PrimaryKeyList

"executionParameter":

[

{
                "SourceUsuario": "mestre",

[

         "RemoveOldPermissions": false,

1

"CopyToAllApplications": true,
                "CodSistema": "G",

0

     "NewUser": {

]

  "Usuario": null,

]

"Nome": null,
                    "

PrimaryKeyNames

Senha":

[

null,

CODCOLIGADA

Email": null,

IDPRJ

codAcesso": null,

],

 "UsuariodeRede": null

"PrimaryKeyTableName": null

},

OnlineMode

Initialized":

false

true,

SyncExecution

PrimaryKeyList":

false,

[
                    [

"HideProgressDialog":

false,

SaveParamsExecution": false,

Fabio.nunes"

"CodUsuario": null,

]
                ],

"Context":

{

            "PrimaryKeyNames": [

"$id":

"1",

        "CODUSUARIO"

"_params": {}

],

Environment

PrimaryKeyTableName":

0

"GUSUARIO",

}

"OnlineMode": false,

UserName

SyncExecution":

"Breno"

false,

ConnectionId

HideProgressDialog":

null

false,

ConnectionString

SaveParamsExecution":

null

false,

DriverType

CodUsuario":

null

"mestre",

Ip

Context":

"10.31.7.80",

{
                    "

HostName

$id": "

RM0005748

1",
                    "

JobServerHostName

_params":

"RM0005748",

{
                        "

ActionName

$EXERCICIOFISCAL":

"PrjConcederPermissaoAcessoProjetoAction"

2,
                        "

MasterActionName

$CODLOCPRT":

null

12,
                        "

ActionModule

$CODTIPOCURSO":

null

-1,
                        "

JobID

$EDUTIPOUSR":

{

"-1",
                        "

ID

$CODUNIDADEBIB": -1,
                        "

ExecID

$CODCOLIGADA":

-

1,
                        "

IsPriorityJob

$RHTIPOUSR":

false

"-1",
                        "

Children

$CODIGOEXTERNO":

[]

"-1",

}

"$CODSISTEMA": "G",
                        "

ExecutionId

$CODUSUARIOSERVICO": "

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

",
                        "

ProcessName

$CODUSUARIO": "mestre"

Conceder

permissão

de

Acesso

a

Projetos",

ServerName

$IDPRJ":

"PrjConcederPermissaoAcessoProjetoProc"

-1,
                        "

ServiceInterface

$CHAPAFUNCIONARIO":

null

"-1",
                        "

Scheduler

$CODFILIAL":

2,

"UseJobMonitor": false

},
                    "

ScheduleDateTime

Environment":

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

"CanSendMail": false

},

CanWaitSchedule

UserName":

false

"mestre",

SendMail

ConnectionId":

false

null,

FriendlyLogs

ConnectionString": null,

SuccessMessage

DriverType":

"Processo executado com sucesso"

null,

FailureMessage

Ip": "

Falha na execução do processo

10.31.4.57",

SaveLogInDatabase

HostName":

false

"BHD050100279",

StatusMessage

JobServerHostName":

null

"BHD050100279",

WaitSchedule

ActionName":

false

"GlbActionProcCopyPermisUsr",

IsolateProcess

MasterActionName":

false

"GlbUsuarioAction",

DisableIsolateProcess

ActionModule":

false

"G",

NetworkUser

JobID":

null,

{
                    "

CustomData

ID":

null

1,
                    "

CanParallelize

ExecID":

false

1,
                    "

ShouldParallelize

IsPriorityJob": false,
                    "

QuantityOfSplits

Children":

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,

}

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

] }

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

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

scheduleID

DisableIsolateProcess":

"100001"

false,
                "

status

NetworkUser": "

success

fabio.nunes",
                "

scheduleDate

CustomData":

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

null,
                "

executionDate

CanParallelize":

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

true,
                "

executionID

ShouldParallelize":

"1"

false,
                "

user

QuantityOfSplits":

""

0,
                "

recurrent

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,
                "

execution

MaximumQuantityOfPrimaryKeysPerProcess":

{

1000,
                "

processID

NotifyFluig":

"PrjConcederPermissaoAcessoProjetoProc"

false,
                "

status

NotifyEmail":

"success"

false,
                "

scheduleDate

NotifyEmailList":

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

null
            }

"executionDate":

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

 },
        {
            "

executionID

jobScheduleID": "

1

2",

scheduleID

status": "

100001

active",

user

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

recurrent

processID":

false

"GlbWorkflowExecProc",

executionParameter

firstExecution":

{

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

Permissoes

recurrent":

null

true,

Initialized

executionParameter":

false,

PrimaryKeyList

CodColigada":

[

1,
                "IdWorkflow": 45,

[

         "DataSet": null,

1

"Parameters": null,
                "OwnerData": null,

0

     "Initialized": true,
                "PrimaryKeyList":

[],

]

"PrimaryKeyNames": null,

PrimaryKeyNames

PrimaryKeyTableName":

[

null,
                "OnlineMode": false,

"CODCOLIGADA",

         "SyncExecution": false,
                "

IDPRJ

HideProgressDialog": false,

]

"SaveParamsExecution": false,

PrimaryKeyTableName

CodUsuario":

null

"mestre",

OnlineMode

Context":

false,

{
                    "

SyncExecution

$id":

false

"1",
                    "

HideProgressDialog

_params":

false,

{
                        "

SaveParamsExecution

$EXERCICIOFISCAL":

false

2,

"CodUsuario

    "$CODLOCPRT":

null

12,
                        "

Context

$CODTIPOCURSO":

{

-1,
                        "

$id

$EDUTIPOUSR": "-1",
                        "

_params

$CODUNIDADEBIB":

{}

-1,
                        "

Environment

$CODCOLIGADA":

0

1,

}

    "$RHTIPOUSR": "-1",
                        "

UserName

$CODIGOEXTERNO": "

Breno

-1",
                        "

ConnectionId

$CODSISTEMA":

null

"G",
                        "

ConnectionString

$CODUSUARIOSERVICO":

null

"",
                        "

DriverType

$CODUSUARIO":

null

"mestre",
                        "

Ip

$IDPRJ":

"10.31.7.80"

-1,
                        "

HostName

$CHAPAFUNCIONARIO": "

RM0005748

-1",
                        "

JobServerHostName

$CODFILIAL":

"RM0005748",

"ActionName": "PrjConcederPermissaoAcessoProjetoAction"

},
                    "

MasterActionName

Environment":

null,

1
                },

"ActionModule":

null,

           "UserName": "mestre",

"JobID":

{

       "ConnectionId": null,
                "

ID

ConnectionString":

-1

null,
                "DriverType": null,

"ExecID": -1,

         "Ip": "10.31.4.57",
                "

IsPriorityJob

HostName":

false

"BHD050100279",

Children

JobServerHostName":

[]

"BHD050100279",

}

"ActionName": "GlbWorkflowExecAction",

ExecutionId

MasterActionName":

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

null,

ProcessName

ActionModule": "

Conceder permissão de Acesso a Projetos

G",

ServerName

JobID":

"PrjConcederPermissaoAcessoProjetoProc",

{
                    "

ServiceInterface

ID":

null

2,
                    "

Scheduler

ExecID":

2

1,
                    "

UseJobMonitor

IsPriorityJob": false,
                    "

ScheduleDateTime

Children":

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

[]

"CanSendMail": false

},

CanWaitSchedule

ShowReExecuteButton":

false

true,

SendMail

ExecutionId":

false

"a6bad34f-2946-46ca-b69b-7434004fc0f6",

FriendlyLogs

ProcessName":

null

"Executar Fórmula Visual",

SuccessMessage

ServerName": "

Processo executado com sucesso

GlbWorkflowExecProc",

FailureMessage

ServiceInterface":

"Falha na execução do processo"

null,

SaveLogInDatabase

Scheduler":

false

1,

StatusMessage

UseJobMonitor":

null

true,

WaitSchedule

ScheduleDateTime":

false,

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

IsolateProcess

CanSendMail": false,

DisableIsolateProcess

CanWaitSchedule": false,

NetworkUser

SendMail":

null

false,

CustomData

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

CanParallelize": false

ShouldParallelize

FailureMessage":

false,

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

QuantityOfSplits

SaveLogInDatabase":

0

true,

MinimumQuantityOfPrimaryKeysPerProcess

StatusMessage":

0

null,

MaximumQuantityOfPrimaryKeysPerProcess

WaitSchedule":

0

false,

NotifyFluig

IsolateProcess": false,

NotifyEmail

DisableIsolateProcess": false,

NotifyEmailList

NetworkUser":

null

"fabio.nunes",

}

"CustomData": null,
                "

return

CanParallelize": true,
                "ShouldParallelize": false,

}

   "QuantityOfSplits": 0,

}

        "MinimumQuantityOfPrimaryKeysPerProcess": 1,

] }

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

          "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                "NotifyFluig": false,
                "NotifyEmail": false,
                "NotifyEmailList": null
            },
            "weekly": {
                "

scheduleID

daysOfWeek":

"102776",

"status": "success

        "Monday",

"scheduleDate":

"26/10/2018

10:37:51",

      "Tuesday",

"executionDate":

"26/10/2018

10:38:00",

executionID

Thursday"

: "1",

"user": "rm"

 ],
                "

recurrent

hour":

false

14,
                "

execution

minute":

{

50
            }

"processID": "RMSSendCriticalLogProc",

    },
        {
            "

status

jobScheduleID": "

success

3",

scheduleDate

status": "

26/10/2018 10:37:51

active",

executionDate

lastModified": "

26/10/2018 10:38:00

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

executionID

processID": "

1

GlbWorkflowExecProc",

scheduleID

firstExecution": "

102776

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

            "user": "

rm

mestre",

"recurrent":

false

true,
            "executionParameter": {

"executionParameter

         "CodColigada":

{

1,
                "IdWorkflow": 45,

"LastErrorSent

         "DataSet":

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

null,
                "Parameters": null,
                "OwnerData": null,
                "Initialized": true,

"PrimaryKeyList": [],

"PrimaryKeyNames": null,

"PrimaryKeyTableName": null,

"OnlineMode": false,

"SyncExecution": false,

                "HideProgressDialog": false,

"SaveParamsExecution": false,

"CodUsuario":

null

"mestre",

                "Context": {

                    "$id": "1",

"_params": {

$CODCOLIGADA

$EXERCICIOFISCAL":

0

2,

$CODSISTEMA

$CODLOCPRT":

"G"

12,

}

"$CODTIPOCURSO": -1,
                        "

Environment

$EDUTIPOUSR":

0

"-1",

}

 "$CODUNIDADEBIB": -1,
                        "

UserName

$CODCOLIGADA":

"rm"

1,
                        "

ConnectionId

$RHTIPOUSR":

null

"-1",
                        "

ConnectionString

$CODIGOEXTERNO":

null

"-1",
                        "

DriverType

$CODSISTEMA":

null

"G",
                        "

Ip

$CODUSUARIOSERVICO": "

127.0.0.1

",
                        "

HostName

$CODUSUARIO": "

localhost

mestre",
                        "

JobServerHostName

$IDPRJ":

"BHD050102417"

-1,
                        "

ActionName

$CHAPAFUNCIONARIO":

null

"-1",
                        "

MasterActionName

$CODFILIAL":

null,

"ActionModule": null

},
                    "

JobID

Environment":

{

1
                },

"ID":

102776,

       "UserName": "mestre",
                "

ExecID

ConnectionId":

1

null,
                "ConnectionString": null,

"IsPriorityJob":

false,

        "DriverType": null,
                "

Children

Ip":

[]

"10.31.4.57",

}

"HostName": "BHD050100279",

ShowReExecuteButton

JobServerHostName":

true

"BHD050100279",

ExecutionId

ActionName": "

a88518a8-56c4-43d7-b8f0-c97eda42e5d9

GlbWorkflowExecAction",

ProcessName

MasterActionName": null,

ServerName

ActionModule":

null

"G",

ServiceInterface

JobID":

null,

{
                    "

Scheduler

ID":

1

3,
                    "

UseJobMonitor

ExecID":

true

1,
                    "

ScheduleDateTime

IsPriorityJob":

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

false,
                    "

CanSendMail

Children":

false,

[]

"CanWaitSchedule": false

},

SendMail

ShowReExecuteButton":

false

true,

FriendlyLogs

ExecutionId":

null

"ef13b977-7293-4d52-91a6-44694cbeddc9",

SuccessMessage

ProcessName": "

Processo

Executar

executado

Fórmula

com sucesso

Visual",

FailureMessage

ServerName": "

Falha na execução do processo

GlbWorkflowExecProc",

SaveLogInDatabase

ServiceInterface":

true

null,

StatusMessage

Scheduler":

null

1,

"UseJobMonitor": true,

"WaitSchedule

         "ScheduleDateTime":

false

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

IsolateProcess

CanSendMail": false,

DisableIsolateProcess

CanWaitSchedule": false,

NetworkUser

SendMail":

null

false,

CustomData

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

CanParallelize": false

ShouldParallelize

FailureMessage":

false,

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

QuantityOfSplits

SaveLogInDatabase":

0

true,

MinimumQuantityOfPrimaryKeysPerProcess

StatusMessage":

1

null,

MaximumQuantityOfPrimaryKeysPerProcess

WaitSchedule":

1000

false,

NotifyFluig

IsolateProcess": false,

NotifyEmail

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

NotifyEmailList

CustomData": null,

}

"CanParallelize": true,
                "

return

ShouldParallelize":

""

false,

}

   "QuantityOfSplits": 0,

}

] }

Expandir

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": false, "items": [

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

{

},
            "

scheduleID

monthly":

"100360",

{
                "

status

day":

"pending"

7,
                "

scheduleDate

hour":

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

17,
                "

executionDate

minute":

"",

"executionID": "868",

}
        },

"user": "",

    {
            "

recurrent

jobScheduleID":

true

"4",
            "

weekly

status":

{

"active",

daysOfWeek

lastModified":

[

"2018-12-06T14:44:06",
            "processID": "GlbWorkflowExecProc",

"Sunday",

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

Monday

mestre",
            "recurrent": true,

"Tuesday",

     "executionParameter": {
                "

Wednesday

CodColigada": 1,

Thursday

IdWorkflow": 45,

Friday

DataSet": null,

Saturday

Parameters": null,
                "OwnerData":

]

null,
                "

hour

Initialized":

11

true,
                "

minute

PrimaryKeyList":

0

[],

},

"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,
                        "$CHAPAFUNCIONARIO": "

IDOBJOF

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

"ConnectionId": null,

ConnectionString

ID":

null

4,
                    "

DriverType

ExecID":

null

1,
                    "

Ip

IsPriorityJob":

"10.31.5.226"

false,
                    "

HostName

Children":

"RM005762",

[]
                },

"JobServerHostName

           "ShowReExecuteButton":

"RM005762"

true,

ActionName

ExecutionId": "

MntCalcularMediaDiariaIndicadorUsoAction

c496de16-b989-4292-9c10-1991d87f83a8",
                "ProcessName": "Executar Fórmula

"MasterActionName": null

Visual",

ActionModule

ServerName": "

N

GlbWorkflowExecProc",

JobID

ServiceInterface":

{

null,
                "Scheduler": 1,

"ID": -1,

         "UseJobMonitor": true,
                "

ExecID

ScheduleDateTime":

-1

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

"IsPriorityJob

"CanSendMail": false,

"Children

"CanWaitSchedule":

[]

false,

}

"SendMail": false,

"ExecutionId

"FriendlyLogs":

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

null,

ProcessName

SuccessMessage": "

Calcular

Processo

Média

executado

Diária de Indicador de Uso

com sucesso",

ServerName

FailureMessage": "

MntCalcularMediaDiariaIndicadorUsoProc",

Falha na execução do processo",
                "

ServiceInterface

SaveLogInDatabase":

null

true,

Scheduler

StatusMessage":

1

null,

UseJobMonitor

WaitSchedule":

true

false,

ScheduleDateTime

IsolateProcess":

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

false,

CanSendMail

DisableIsolateProcess": false,

CanWaitSchedule

NetworkUser":

false

"fabio.nunes",

SendMail

CustomData":

false

null,

FriendlyLogs

CanParallelize":

null

true,

SuccessMessage

ShouldParallelize":

"Processo executado com sucesso"

false,

FailureMessage

QuantityOfSplits":

"Falha na execução do processo"

0,

SaveLogInDatabase

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

"StatusMessage": null

"MaximumQuantityOfPrimaryKeysPerProcess": 1000,

WaitSchedule

NotifyFluig": false,

IsolateProcess

NotifyEmail": false,

DisableIsolateProcess

NotifyEmailList":

false,

null

"NetworkUser": null

},

"CustomData

"daily":

null,

CanParallelize

hour":

false

1,

ShouldParallelize

minute":

false,

25
            }

"QuantityOfSplits": 0,

]
}

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	Order (Asc)

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

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?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": false,
    "items": [

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

       {
            "

return

jobScheduleID": "1",

}

"status": "completed",

}

] }

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	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/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/glb/v1/jobscheduler?page=1&pageSize=1

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

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

"lastModified": "2018-12-06T15:33:37",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "

scheduleID

SourceUsuario": "

100001

mestre",
                "

status

RemoveOldPermissions":

"success"

false,
                "

scheduleDate

CopyToAllApplications":

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

true,
                "

executionDate

CodSistema": "

17/11/2008 17:16:05

G",
                "

executionID

NewUser":

"1",

"user": "",

recurrent

Usuario":

false

null,

"single":

{

year

Nome":

2008

null,
                    "

month

Senha":

11

null,
                    "

day

Email":

17

null,
                    "

hour

codAcesso":

17

null,
                    "

minute

UsuariodeRede":

16

null
                },
                "

execution

Initialized":

{

true,
                "

processID

PrimaryKeyList":

"PrjConcederPermissaoAcessoProjetoProc",

"status": "success",

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

        "Fabio.nunes"

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

"executionID": "1"

],
                "

scheduleID

PrimaryKeyNames":

"100001",

"user":

 "CODUSUARIO"

,

"recurrent": false

],
                "

executionParameter

PrimaryKeyTableName":

{

"GUSUARIO",

Permissoes

OnlineMode":

null

false,

Initialized

SyncExecution": false,

PrimaryKeyList

HideProgressDialog":

[

false,
                "SaveParamsExecution": false,

[

         "CodUsuario": "mestre",

1,

"Context": {
                    "$id": "1",

0

             "_params": {

]

"$EXERCICIOFISCAL": 2,

],

PrimaryKeyNames

$CODLOCPRT":

[

12,
                        "

CODCOLIGADA

$CODTIPOCURSO": -1,

"IDPRJ"

"$EDUTIPOUSR": "-1",

]

    "$CODUNIDADEBIB": -1,
                        "

PrimaryKeyTableName

$CODCOLIGADA":

null

1,

"OnlineMode

    "$RHTIPOUSR":

false

"-1",
                        "

SyncExecution

$CODIGOEXTERNO":

false

"-1",
                        "

HideProgressDialog

$CODSISTEMA":

false

"G",
                        "

SaveParamsExecution

$CODUSUARIOSERVICO":

false

"",
                        "

CodUsuario

$CODUSUARIO":

null

"mestre",
                        "

Context

$IDPRJ":

{

-1,
                        "

$id

$CHAPAFUNCIONARIO": "-1",
                        "

_params

$CODFILIAL":

{},

1
                    },
                    "Environment":

0

},

                "UserName": "

Breno

mestre",

"ConnectionId": null,

"ConnectionString": null,

"DriverType": null,

"Ip": "10.31.

7

4.

80

57",

                "HostName": "

RM0005748

BHD050100279",

"JobServerHostName": "

RM0005748

BHD050100279",

"ActionName": "

PrjConcederPermissaoAcessoProjetoAction

GlbActionProcCopyPermisUsr",

"MasterActionName":

null

"GlbUsuarioAction",

"ActionModule":

null

"G",

"JobID": {

"ID":

-

1,

"ExecID":

-

1,

                    "IsPriorityJob": false,

"Children": []
                },

},

            "ShowReExecuteButton": true,
                "ExecutionId": "

1c19b022

2b72d443-

c065

e6f6-

42d2

4693-

ae20

bd83-

647259c2e2c0

318f67585a79",

                "ProcessName": "

Conceder

Cópia

permissão

de

Acesso

Permissões

a

de

Projetos

Usuários",

"ServerName": "

PrjConcederPermissaoAcessoProjetoProc

GlbCopyPermisUsrProc",

                "ServiceInterface": null,

"Scheduler":

2

1,

"UseJobMonitor":

false

true,

"ScheduleDateTime": "

2008

2018-

11

12-

17T17

06T10:

15

39:

54

57.

1180698

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

"",

"CustomData": null,

                "CanParallelize":

false

true,

"ShouldParallelize": false,

"QuantityOfSplits": 0,

"MinimumQuantityOfPrimaryKeysPerProcess":

0

1,

"MaximumQuantityOfPrimaryKeysPerProcess":

0

1000,

"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.5 - Fields (Retorno de campos específicos no resultado)

title

Informações

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	1.1.5 Fields2 Order (Desc)

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,
            "scheduleID": "100310"
        }"CopyToAllApplications": true,
        {
            "scheduleIDCodSistema": "100326G",
        },
        "NewUser": {
            "scheduleID": "100360"
       "Usuario": }null,
        {
            "scheduleIDNome": "100362"null,
        },
             {"Senha": null,
            "scheduleID": "101341"
       "Email": }null,
        {
            "scheduleIDcodAcesso": "102083"null,
        },
        {
    "UsuariodeRede": null
       "scheduleID": "102473"
        },
        {
            "scheduleIDInitialized": "102474"true,
        },
        {"PrimaryKeyList": [
            "scheduleID": "102767"
        [
   },
        {
            "scheduleID": "102769Fabio.nunes"
          },
          {]
               "scheduleID": "102771" ],
        },
        "PrimaryKeyNames": {[
            "scheduleID":        "102772CODUSUARIO"
        },
        {
],
                "scheduleIDPrimaryKeyTableName": "102777GUSUARIO",
        },
         {
"OnlineMode": false,
                "scheduleIDSyncExecution": "102764"false,
        },
        {"HideProgressDialog": false,
                "scheduleIDSaveParamsExecution": "100360"false,
        }
       ]
}

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "scheduleID": "102771",
    "status": "pending",
    "scheduleDate": "24/10/2070 23:00:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": false,
    "single": {
 "CodUsuario": "mestre",
                "Context": {
                    "$id": "1",
                    "_params": {
                        "$EXERCICIOFISCAL": 2,
                        "$CODLOCPRT": 12,
                        "year$CODTIPOCURSO": 2070-1,
        "month": 10,
        "day": 24,
        "hour$EDUTIPOUSR": 23"-1",
        "minute": 0
    },
    "execution": {
        "processID$CODUNIDADEBIB": "RptProcGenerateReport"-1,
        "status": "pending",
                "scheduleDate$CODCOLIGADA": "24/10/2070 23:00:00"1,
             "executionDate": "",
           "executionID$RHTIPOUSR": "-1",
        "scheduleID": "102771",
                "user$CODIGOEXTERNO": "mestre-1",
        "recurrent                "$CODSISTEMA": false"G",
                        "executionParameter$CODUSUARIOSERVICO": "",
    }
}

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

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

{
  "scheduleDate": "2018-10-26 23:05:00",
  "recurrent": true,
   "daily": {
   "hour": 23,
   "minute": 1
  },
  "execution": {
    "processID": "GlbCopyPermisUsrProc",
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			"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,
		}
  }
}

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Image Removed

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": "6",
    "status": "pending",
    "scheduleDate": "26/10/2018 23:05:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": true,
    "daily": {
        "hour": 23,
        "minute": 1
    },
    "execution": {
        "processID": "GlbCopyPermisUsrProc",
        "status": "pending",
        "scheduleDate": "26/10/2018 23:05:00",
        "executionDate": "",
        "executionID": "1",
        "scheduleID": "6",
        "user": "mestre                    "$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",
        "recurrent": true,
        "executionParameterOnlineMode": {false,
                "SourceUsuarioSyncExecution": "mestre"false,
                "RemoveOldPermissionsHideProgressDialog": false,
                "CopyToAllApplicationsSaveParamsExecution": truefalse,
                "CodSistemaCodUsuario": "Gmestre",
                "NewUserContext": {
                    "Usuario$id": "testepost1",
                    "Nome_params": "testepost",{
                "Senha        "$EXERCICIOFISCAL": "totvs"2,
                 "Email       "$CODLOCPRT": "testepost"12,
                "codAcesso        "$CODTIPOCURSO": "Acesso01"-1,
                "UsuariodeRede        "$EDUTIPOUSR": "-1",
            },
            "Initialized$CODUNIDADEBIB": true-1,
            "PrimaryKeyList": [],
            "PrimaryKeyNames$CODCOLIGADA": null1,
            "PrimaryKeyTableName": null,
            "OnlineMode$RHTIPOUSR": false"-1",
            "SyncExecution": false,
            "HideProgressDialog$CODIGOEXTERNO": false"-1",
            "SaveParamsExecution": false,
            "CodUsuario$CODSISTEMA": "mestreG",
            "Context": {
                "$id$CODUSUARIOSERVICO": "1",
                "_params": {
       "$CODUSUARIO": "mestre",
             "$EXERCICIOFISCAL           "$IDPRJ": -1,
                        "$CODLOCPRT$CHAPAFUNCIONARIO": "-1",
                        "$CODTIPOCURSO$CODFILIAL": -1,
                    "$EDUTIPOUSR": "-1"},
                    "$CODUNIDADEBIBEnvironment": -1,
                },
      "$CODCOLIGADA          "UserName": 1"mestre",
                    "$RHTIPOUSRConnectionId": "-1"null,
                    "$CODIGOEXTERNOConnectionString": "-1"null,
                    "$CODSISTEMADriverType": "G"null,
                    "$CODUSUARIOSERVICOIp": "10.31.4.57",
                    "$CODUSUARIOHostName": "mestreBHD050100279",
                    "$IDPRJJobServerHostName": -1"BHD050100279",
                    "$CHAPAFUNCIONARIOActionName": "-1GlbActionProcCopyPermisUsr",
                    "$CODFILIALMasterActionName": -1"GlbUsuarioAction",
                }"ActionModule": "G",
                "EnvironmentJobID": 1{
            },
            "UserNameID": "mestre"1,
                    "ConnectionIdExecID": null1,
                    "ConnectionStringIsPriorityJob": nullfalse,
                    "DriverTypeChildren": null,[]
            "Ip": "10.31.4.57",
    },
                "HostNameShowReExecuteButton": "BHD050100279"true,
                "JobServerHostNameExecutionId": "BHD0501002792b72d443-e6f6-4693-bd83-318f67585a79",
                "ActionNameProcessName": "GlbActionProcCopyPermisUsrCópia de Permissões de Usuários",
                "MasterActionNameServerName": "GlbUsuarioActionGlbCopyPermisUsrProc",
                "ActionModuleServiceInterface": "G"null,
                "JobIDScheduler": {1,
                "IDUseJobMonitor": 6true,
                "ExecIDScheduleDateTime": 1"2018-12-06T10:39:57.5233678-02:00",
                "IsPriorityJobCanSendMail": false,
                "ChildrenCanWaitSchedule": []
false,
               } "SendMail": false,
                "ShowReExecuteButtonFriendlyLogs": truenull,
            "ExecutionId    "SuccessMessage": "7dba5874-a296-43bc-89fd-ab853121feecProcesso executado com sucesso",
                "ProcessNameFailureMessage": "CópiaFalha dena Permissõesexecução dedo Usuáriosprocesso",
                "ServerNameSaveLogInDatabase": "GlbCopyPermisUsrProc"true,
                "ServiceInterfaceStatusMessage": null,
                "SchedulerWaitSchedule": 1false,
                "UseJobMonitorIsolateProcess": truefalse,
                "ScheduleDateTimeDisableIsolateProcess": "2018-10-25T12:04:31.8719316-03:00",
false,
                "CanSendMailNetworkUser": false"",
                "CanWaitScheduleCustomData": falsenull,
                "SendMailCanParallelize": falsetrue,
                "FriendlyLogsShouldParallelize": nullfalse,
                "SuccessMessageQuantityOfSplits": 0,
 "Processo executado com sucesso",
            "FailureMessageMinimumQuantityOfPrimaryKeysPerProcess": "Falha1,
 na execução do processo",
            "SaveLogInDatabaseMaximumQuantityOfPrimaryKeysPerProcess": true1000,
                "StatusMessageNotifyFluig": nullfalse,
                "WaitScheduleNotifyEmail": false,
                "IsolateProcessNotifyEmailList": false,null
            "DisableIsolateProcess": false,}
        }
    "NetworkUser": "",
            "CustomData": null,
            "CanParallelize": true,
            "ShouldParallelize": false,
            "QuantityOfSplits": 0,
            "MinimumQuantityOfPrimaryKeysPerProcess": 1]
}

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

MaximumQuantityOfPrimaryKeysPerProcess

status":

1000

"active",
            "

NotifyFluig

lastModified":

false

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

NotifyEmail

processID":

false

"GlbCopyPermisUsrProc",
            "

NotifyEmailList

firstExecution":

null

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

}

} }

Informações

icon	false
title	Exemplo de Resultado Negativo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

{

"user": "mestre",
            "

Code

recurrent":

"FE016"

true,
            "

Message

executionParameter":

"O corpo da mensagem contém valores inválidos.",

{
                "

DetailMessage

SourceUsuario": "mestre",

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

            "RemoveOldPermissions": false,
                "CopyToAllApplications": true,

"Details

            "CodSistema":

null }

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.2.2 - Post {ID}/Trigger

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

Image Removed

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

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

{
  "scheduleDate": "2018-10-26 23:05:00",
  "recurrent": true,
   "daily": {
   "hour": 23,
   "minute": 1
  },
  "execution": {
    "processID": "GlbCopyPermisUsrProc",
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			"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,
		}
  }
}

Informações

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

{ "scheduleID": "6", "status": "pending", "scheduleDate": "26/10/2018 23:05:00", "executionDate": "", "executionID": "1", "user": "mestre", "recurrent": true, "daily": { "hour": 23, "minute": 1 }, "execution":

processID

jobScheduleID": "

GlbCopyPermisUsrProc

3",

"status": "

pending

inactive",

scheduleDate

lastModified": "

26/10/2018 23:05:00

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

executionDate

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

executionID

user": "

1

mestre",
    "recurrent": true,
    "

scheduleID

executionParameter":

"6",

{
        "

user

SourceUsuario": "mestre",
        "

recurrent

RemoveOldPermissions":

true

false,
        "

executionParameter

CopyToAllApplications":

{

true,

SourceUsuario

CodSistema": "

mestre

G",

RemoveOldPermissions

NewUser":

false,

{
            "

CopyToAllApplications

Usuario":

true

null,
            "

CodSistema

Nome":

"G"

null,
            "

NewUser

Senha":

{

null,
            "

Usuario

Email":

"testepost"

null,

Nome

codAcesso":

"testepost"

null,

Senha

UsuariodeRede":

"totvs",

null
        },
        "

Email

Initialized":

"testepost"

true,
        "PrimaryKeyList": [

"codAcesso": "Acesso01",

"UsuariodeRede":

 "Fabio.nunes"

},

"Initialized": true

],

PrimaryKeyList

PrimaryKeyNames": [

],

PrimaryKeyNames": null,

CODUSUARIO"
        ],
        "PrimaryKeyTableName":

null

"GUSUARIO",

"OnlineMode": false,

"SyncExecution": false,

"HideProgressDialog": false,

"SaveParamsExecution": false,

"CodUsuario": "mestre",

"Context": {

"$id": "1",

"_params": {

"$EXERCICIOFISCAL":

-1

2,

"$CODLOCPRT":

-1

12,

"$CODTIPOCURSO": -1,

                "$EDUTIPOUSR": "-1",

"$CODUNIDADEBIB": -1,

"$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
                "

$RHTIPOUSR

$CODIGOEXTERNO": "-1",
                "$CODSISTEMA": "G",

"$CODIGOEXTERNO

       "$CODUSUARIOSERVICO": "

-1

",
                "$CODUSUARIO": "mestre",
                "

$CODSISTEMA

$IDPRJ":

"G"

-1,

$CODUSUARIOSERVICO

$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 1

"$CODUSUARIO":

"mestre",

        },
            "

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

},

     "MasterActionName": "GlbUsuarioAction",
        "

UserName

ActionModule": "

mestre

G",

ConnectionId

JobID":

null,

{
            "

ConnectionString

ID":

null

3,
            "

DriverType

ExecID":

null

1,
            "

Ip

IsPriorityJob":

"10.31.4.57"

false,
            "

HostName

Children":

"BHD050100279",

[]
        },
        "

JobServerHostName

ShowReExecuteButton":

"BHD050100279"

true,

ActionName

ExecutionId": "

GlbActionProcCopyPermisUsr

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

MasterActionName

ProcessName": "

GlbUsuarioAction",

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

ActionModule

ServerName": "

G

GlbCopyPermisUsrProc",

JobID

ServiceInterface":

{

null,
        "Scheduler": 1,
        "

ID

UseJobMonitor":

6

true,
        "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
        "

ExecID

CanSendMail":

1

false,
        "CanWaitSchedule": false,
        "

IsPriorityJob

SendMail": false,
        "FriendlyLogs": null,
        "

Children

SuccessMessage":

[]

"Processo executado com sucesso",

},

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

ShowReExecuteButton

SaveLogInDatabase": true,
        "StatusMessage": null,
        "

ExecutionId

WaitSchedule":

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

false,

ProcessName

IsolateProcess": false,

"Cópia

de

Permissões

de

Usuários",

   "DisableIsolateProcess": false,
        "

ServerName

NetworkUser": "

GlbCopyPermisUsrProc

",

ServiceInterface

CustomData": null,

Scheduler

CanParallelize":

1

true,

UseJobMonitor

ShouldParallelize":

true

false,

ScheduleDateTime

QuantityOfSplits":

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

0,

CanSendMail

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

CanWaitSchedule

MaximumQuantityOfPrimaryKeysPerProcess":

false

1000,

SendMail

NotifyFluig": false,

FriendlyLogs

NotifyEmail":

null

false,

SuccessMessage

NotifyEmailList": null

"Processo

executado

com

sucesso"

},
    "daily": {
        "

FailureMessage

hour":

"Falha

0,

na

execução

do

processo",

    "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

{
   "

SaveLogInDatabase

Code":

true

"FE011",

StatusMessage

Message":

null,

"Não foi encontrada nenhuma tarefa pendente com o id

"WaitSchedule": false

0.",

"IsolateProcess

"DetailMessage":

false

"",

"DisableIsolateProcess

"HelpUrl":

false

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

"NetworkUser": "", "CustomData": null, "CanParallelize": true, "ShouldParallelize": false, "QuantityOfSplits": 0, "MinimumQuantityOfPrimaryKeysPerProcess": 1, "MaximumQuantityOfPrimaryKeysPerProcess": 1000, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null } } }

"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

Negativo Postman

Image Removed

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

FE016

FE019",
    "Message"

: "O corpo da mensagem contém valores inválidos

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

...

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/glbframework/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/glb/v1/jobscheduler/1

Informações

icon	false
title	Exemplo de Entrada Postman

Image Removed


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

{
   	"firstExecution": "2018-12-06 15:30:00",
	"processID": "GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": true,
	"daily": {
                "hour": 0,
                "minute": 1
            },
    "executionParameter": {
        "SourceUsuario": "mestre",
        "RemoveOldPermissions": false,
        "CopyToAllApplications": true,
        "CodSistema": "G",
        "NewUser": {
            "Usuario": null,
            "Nome": null,
            "Senha": null,
            "Email": null,
            "codAcesso": null,
            "UsuariodeRede": null
        },
        "Initialized": true,
        "PrimaryKeyList": [
            [
                "Fabio.nunes"
            ]
        ],
        "PrimaryKeyNames": [
            "CODUSUARIO"
        ],
        "PrimaryKeyTableName": "GUSUARIO",
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,

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

{
  "scheduleDate": "2018-11-01 20:05:00",
  "recurrent": true,
   "weekly": {
    "daysOfWeek": [
      "Sunday"
    ],
    "hour": 1,
    "minute": 0
  },
  "execution": {
    "processID": "GlbCopyPermisUsrProc",
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			"OnlineMode": false,
			"SyncExecution": false,
			"HideProgressDialog": false,
			"SaveParamsExecution": false,
			"CodUsuario": "mestre",
			        "Context": {
				            "$id": "1",
				            "_params": {
					: {
                "$EXERCICIOFISCAL": -1,
					2,
                "$CODLOCPRT": -1,
					12,
                "$CODTIPOCURSO": -1,
					                "$EDUTIPOUSR": "-1",
					                "$CODUNIDADEBIB": -1,
					                "$CODCOLIGADA": 1,
					                "$RHTIPOUSR": "-1",
					                "$CODIGOEXTERNO": "-1",
					                "$CODSISTEMA": "G",
					                "$CODUSUARIOSERVICO": "",
					                "$CODUSUARIO": "mestre",
					                "$IDPRJ": -1,
					                "$CHAPAFUNCIONARIO": "-1",
					                "$CODFILIAL": -1
				},
				            },
            "Environment": 1
			        },
			        "UserName": "mestre",
			        "ConnectionId": null,
			        "ConnectionString": null,
			        "DriverType": null,
			        "Ip": "10.31.4.57",
			        "HostName": "BHD050100279",
			        "JobServerHostName": "BHD050100279",
			        "ActionName": "GlbActionProcCopyPermisUsr",
			        "MasterActionName": "GlbUsuarioAction",
			        "ActionModule": "G",
			        "JobID": {
				            "ID": 1,
				"ExecID": 1,
				"IsPriorityJob": false,
				"Children": []
			},
			"ShowReExecuteButton": true,
			"ExecutionId": "7dba5874-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 Postman

Image Removed

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            "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,
        "weeklyShouldParallelize": {false,
        "daysOfWeekQuantityOfSplits": [
    0,
        "SundayMinimumQuantityOfPrimaryKeysPerProcess": 1,
        ]"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "hourNotifyFluig": 1false,
        "minuteNotifyEmail": 0false,
    },
    "executionNotifyEmailList": {null
    }
}

title

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": "pendingactive",
        "scheduleDatelastModified": "01/11/2018 20:05:002018-12-06T15:29:47",
    "processID": "GlbCopyPermisUsrProc",
    "executionDatefirstExecution": "2018-12-06T15:30:00",
        "executionIDuser": "1mestre",
    "recurrent": true,
   "scheduleID": "2executionParameter",: {
        "userSourceUsuario": "mestre",
        "recurrentRemoveOldPermissions": truefalse,
        "executionParameterCopyToAllApplications": {true,
            "SourceUsuarioCodSistema": "mestreG",
            "RemoveOldPermissionsNewUser": false,{
            "CopyToAllApplicationsUsuario": truenull,
            "CodSistemaNome": "G"null,
            "NewUserSenha": {null,
                "UsuarioEmail": "testepost"null,
                "NomecodAcesso": "testepost"null,
                "SenhaUsuariodeRede": "totvs",null
        },
        "EmailInitialized": "testepost"true,
        "PrimaryKeyList": [
           "codAcesso": "Acesso01", [
                "UsuariodeRede": ""Fabio.nunes"
            },]
            "Initialized": true],
            "PrimaryKeyListPrimaryKeyNames": [],
            "PrimaryKeyNamesCODUSUARIO": null,

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

Informações

icon

false

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

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.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.1.3 - Filter (Resultado filtrado)

1.2.2 - Post {ID}/Trigger

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 36

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.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.1.3 - Filter (Resultado filtrado)

1.2.2 - Post {ID}/Trigger

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)