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

{ "hasNext": true, "items": [ { "scheduleID": "100001", "status": "success", "scheduleDate": "17/11/2008 17:16:01", "executionDate": "17/11/2008 17:16:05", "executionID": "1", "user": "", "recurrent": false, "execution": { "processID": "PrjConcederPermissaoAcessoProjetoProc", "status": "success", "scheduleDate": "17/11/2008 17:16:01", "executionDate": "17/11/2008 17:16:05",

executionID

jobScheduleID": "1",

scheduleID

status": "

100001

completed",

user

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

recurrent

processID":

false

"GlbCopyPermisUsrProc",

executionParameter

firstExecution":

{

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

Permissoes

recurrent":

null

false,

Initialized

executionParameter":

false,

{
                "

PrimaryKeyList

SourceUsuario":

[

"mestre",
                "RemoveOldPermissions": false,

[

         "CopyToAllApplications": true,

1

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

0

       "Usuario": null,

]

"Nome": null,

]

"Senha": null,
                    "

PrimaryKeyNames

Email":

[

null,

CODCOLIGADA

codAcesso": null,

IDPRJ

UsuariodeRede": null

]

},

PrimaryKeyTableName

Initialized":

null

true,

OnlineMode

PrimaryKeyList":

false,

"SyncExecution": false,

[
                        "

HideProgressDialog": false,

Fabio.nunes"

"SaveParamsExecution": false,

"CodUsuario": null

],

Context

PrimaryKeyNames":

{

"$id": "1",

"CODUSUARIO"
                ],

"_params":

{},

       "PrimaryKeyTableName": "GUSUARIO",
                "

Environment

OnlineMode":

0

false,

}

"SyncExecution": false,

UserName

HideProgressDialog":

"Breno"

false,

ConnectionId

SaveParamsExecution":

null

false,

ConnectionString

CodUsuario":

null

"mestre",

DriverType

Context":

null,

{
                    "

Ip

$id": "

10.31.7.80

1",
                    "

HostName

_params":

"RM0005748",

{
                        "

JobServerHostName

$EXERCICIOFISCAL":

"RM0005748"

2,
                        "

ActionName

$CODLOCPRT":

"PrjConcederPermissaoAcessoProjetoAction"

12,
                        "

MasterActionName

$CODTIPOCURSO":

null

-1,
                        "

ActionModule

$EDUTIPOUSR":

null

"-1",
                        "

JobID

$CODUNIDADEBIB":

{

-1,
                        "

ID

$CODCOLIGADA":

-

1,
                        "

ExecID

$RHTIPOUSR": "-1",
                        "

IsPriorityJob

$CODIGOEXTERNO":

false

"-1",
                        "

Children

$CODSISTEMA":

[]

"G",

}

    "$CODUSUARIOSERVICO": "",
                        "

ExecutionId

$CODUSUARIO": "

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

mestre",
                        "

ProcessName

$IDPRJ":

"Conceder permissão de Acesso a Projetos",

-1,
                        "

ServerName

$CHAPAFUNCIONARIO": "

PrjConcederPermissaoAcessoProjetoProc

-1",
                        "

ServiceInterface

$CODFILIAL":

null,

"Scheduler": 2

},
                    "

UseJobMonitor

Environment":

false,

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

},
                "

CanSendMail

UserName":

false

"mestre",

CanWaitSchedule

ConnectionId":

false

null,

SendMail

ConnectionString":

false

null,

FriendlyLogs

DriverType": null,

SuccessMessage

Ip": "

Processo executado com sucesso

10.31.4.57",

"FailureMessage

"HostName": "

Falha na execução do processo

BHD050100279",

SaveLogInDatabase

JobServerHostName":

false

"BHD050100279",

StatusMessage

ActionName":

null

"GlbActionProcCopyPermisUsr",

WaitSchedule

MasterActionName":

false

"GlbUsuarioAction",

IsolateProcess

ActionModule":

false

"G",

DisableIsolateProcess

JobID":

false,

{
                    "

NetworkUser

ID":

null

1,
                    "

CustomData

ExecID":

null

1,
                    "

CanParallelize

IsPriorityJob": false,
                    "

ShouldParallelize

Children":

false,

[]

"QuantityOfSplits": 0

},

MinimumQuantityOfPrimaryKeysPerProcess

ShowReExecuteButton":

0

true,

MaximumQuantityOfPrimaryKeysPerProcess

ExecutionId":

0

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

NotifyFluig

ProcessName":

false,

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

NotifyEmail

ServerName":

false

"GlbCopyPermisUsrProc",

NotifyEmailList

ServiceInterface": null,

}

"Scheduler": 1,
                "

return

UseJobMonitor":

""

true,

}

} ] }

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâmetros

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

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

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

"ScheduleDateTime": "2018-12-06T14:41:40.809678-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
            }
        },
        {
            "jobScheduleID": "2",
            "status": "active",
            "lastModified": "2018-12-06T14:43:36",
            "processID": "GlbWorkflowExecProc",
            "firstExecution": "2018-12-06T14:50: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": 2,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "a6bad34f-2946-46ca-b69b-7434004fc0f6",
                "ProcessName": "Executar Fórmula Visual",
                "ServerName": "GlbWorkflowExecProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T14:43:26.9732933-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
            },
            "weekly": {
                "daysOfWeek": [
                    "Monday",
                    "Tuesday",
                    "Thursday"
                ],
                "hour": 14,
                "minute": 50
            }
        },
        {
            "jobScheduleID": "3",
            "status": "active",
            "lastModified": "2018-12-06T14:43:50",
            "processID": "GlbWorkflowExecProc",
            "firstExecution": "2018-12-06T17:00: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": 3,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "ef13b977-7293-4d52-91a6-44694cbeddc9",
                "ProcessName": "Executar Fórmula Visual",
                "ServerName": "GlbWorkflowExecProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T14:43:40.8536812-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
            },
            "monthly": {
                "day": 7,
                "hour": 17,
                "minute": 0
            }
        },
        {
            "jobScheduleID": "4",
            "status": "active",
            "lastModified": "2018-12-06T14:44:06",
            "processID": "GlbWorkflowExecProc",
            "firstExecution": "2018-12-07T18:00: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": 4,
                    "ExecID": 1,
                    "IsPriorityJob": false,
                    "Children": []
                },
                "ShowReExecuteButton": true,
                "ExecutionId": "c496de16-b989-4292-9c10-1991d87f83a8",
                "ProcessName": "Executar Fórmula Visual",
                "ServerName": "GlbWorkflowExecProc",
                "ServiceInterface": null,
                "Scheduler": 1,
                "UseJobMonitor": true,
                "ScheduleDateTime": "2018-12-06T14:43:54.1360093-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": 1,
                "minute": 25
            }
        }
    ]
}

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

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleID

Tipo de Ordenação: Descendente

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": [
        {
            "jobScheduleID": "2",
            "status": "active",
            "lastModified": "2018-12-06T15:34:53",
            "processID": "GlbCopyPermisUsrProc",
            "firstExecution": "2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": false,
            "executionParameter": {
                "SourceUsuario": "mestre",
                "RemoveOldPermissions": false,
                "CopyToAllApplications": true,
                "CodSistema": "G",
                "NewUser": {
                    "Usuario": null,
                    "Nome": null,
                    "Senha": null,
                    "Email": null,
                    "codAcesso": null,
                    "UsuariodeRede": null
                },
                "Initialized": true,
                "PrimaryKeyList": [
                    [

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "scheduleID": "100001",
           "Fabio.nunes"
                  "status": "success",  ]
            "scheduleDate": "17/11/2008 17:16:01"    ],
                "executionDatePrimaryKeyNames": [
           "17/11/2008 17:16:05",         "CODUSUARIO"
            "executionID": "1"    ],
                "userPrimaryKeyTableName": "GUSUARIO",
                "recurrentOnlineMode": false,

                "executionSyncExecution": {false,
                "processIDHideProgressDialog": "PrjConcederPermissaoAcessoProjetoProc"false,
                "statusSaveParamsExecution": "success"false,
                "scheduleDateCodUsuario": "17/11/2008 17:16:01mestre",
                "executionDateContext": "17/11/2008 17:16:05",
 {
                    "executionID$id": "1",
                "scheduleID    "_params": "100001",{
                "user        "$EXERCICIOFISCAL": ""2,
                        "recurrent$CODLOCPRT": false12,
                        "executionParameter$CODTIPOCURSO": {-1,
                        "Permissoes$EDUTIPOUSR": null"-1",
                        "Initialized$CODUNIDADEBIB": false-1,
                        "PrimaryKeyList$CODCOLIGADA": [1,
                        ["$RHTIPOUSR": "-1",
                        "$CODIGOEXTERNO": "-1",
   1,
                     "$CODSISTEMA": "G",
      0
                  "$CODUSUARIOSERVICO": "",
     ]
                    ]"$CODUSUARIO": "mestre",
                        "PrimaryKeyNames$IDPRJ": [-1,
                        "CODCOLIGADA$CHAPAFUNCIONARIO": "-1",
                        "IDPRJ$CODFILIAL": 1
                    ]},
                    "PrimaryKeyTableNameEnvironment": null,
1
                },
                "OnlineModeUserName": false"mestre",
                    "SyncExecutionConnectionId": falsenull,
                    "HideProgressDialogConnectionString": falsenull,
                    "SaveParamsExecutionDriverType": falsenull,
                    "CodUsuarioIp": null"10.31.4.57",
                "HostName": "BHD050100279",
   "Context": {
             "JobServerHostName": "BHD050100279",
                "$idActionName": "1GlbActionProcCopyPermisUsr",
                "MasterActionName": "GlbUsuarioAction",
       "_params": {},
         "ActionModule": "G",
                "EnvironmentJobID": 0{
                    "ID": }2,
                    "UserName": "Breno"ExecID": 1,
                    "ConnectionIdIsPriorityJob": nullfalse,
                    "ConnectionStringChildren": null,[]
                    "DriverType": null},
                    "IpShowReExecuteButton": "10.31.7.80"true,
                    "HostNameExecutionId": "RM00057482b72d443-e6f6-4693-bd83-318f67585a79",
                    "JobServerHostNameProcessName": "RM0005748",
Cópia de Permissões de Usuários",
                "ActionNameServerName": "PrjConcederPermissaoAcessoProjetoActionGlbCopyPermisUsrProc",
                    "MasterActionNameServiceInterface": null,
                    "ActionModuleScheduler": null1,
                    "JobIDUseJobMonitor": {true,
                        "ID"ScheduleDateTime": -1"2018-12-06T10:39:57.5233678-02:00",
                "CanSendMail": false,
       "ExecID": -1,
         "CanWaitSchedule": false,
                "IsPriorityJobSendMail": false,
                        "ChildrenFriendlyLogs": []null,
                    },
    "SuccessMessage": "Processo executado com sucesso",
                "ExecutionIdFailureMessage": "1c19b022-c065-42d2-ae20-647259c2e2c0",
    Falha na execução do processo",
                "ProcessNameSaveLogInDatabase": "Conceder permissão de Acesso a Projetos"true,
                    "ServerNameStatusMessage": "PrjConcederPermissaoAcessoProjetoProc"null,
                    "ServiceInterfaceWaitSchedule": nullfalse,
                    "SchedulerIsolateProcess": 2false,
                    "UseJobMonitorDisableIsolateProcess": false,
                    "ScheduleDateTimeNetworkUser": "2008-11-17T17:15:54.1180698-02:00",
                    "CanSendMailCustomData": falsenull,
                    "CanWaitScheduleCanParallelize": falsetrue,
                    "SendMailShouldParallelize": false,
                    "FriendlyLogsQuantityOfSplits": null0,
                "MinimumQuantityOfPrimaryKeysPerProcess": 1,
   "SuccessMessage": "Processo executado com sucesso",
             "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
           "FailureMessage": "Falha na execução do processo"NotifyFluig": false,
                    "SaveLogInDatabaseNotifyEmail": false,
                    "StatusMessageNotifyEmailList": null,
            }
        "WaitSchedule": false},
        {
            "IsolateProcessjobScheduleID": false"1",
            "status": "completed",
            "DisableIsolateProcesslastModified": false"2018-12-06T15:33:37",
            "processID": "GlbCopyPermisUsrProc",
            "NetworkUserfirstExecution": null"2018-12-06T15:30:00",
            "user": "mestre",
            "CustomDatarecurrent": nullfalse,
                    "CanParallelizeexecutionParameter": false,{
                    "ShouldParallelizeSourceUsuario": false"mestre",
                    "QuantityOfSplitsRemoveOldPermissions": 0false,
                    "MinimumQuantityOfPrimaryKeysPerProcessCopyToAllApplications": 0true,
                    "MaximumQuantityOfPrimaryKeysPerProcessCodSistema": 0"G",
                    "NotifyFluigNewUser": false,{
                    "NotifyEmailUsuario": falsenull,
                    "NotifyEmailListNome": null
           ,
     },
                "returnSenha": ""null,
             }
        }
    ]
}

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
"Email": null,
                    "hasNextcodAcesso": truenull,
    "items                "UsuariodeRede": [
null
                {},
                "scheduleIDInitialized": "102776"true,
                "statusPrimaryKeyList": "success",
[
              "scheduleDate": "26/10/2018 10:37:51",
      [
         "executionDate": "26/10/2018 10:38:00",
            "executionID": "1Fabio.nunes",
                   "user": "rm",
 ]
               "recurrent": false],
                "executionPrimaryKeyNames": {[
                    "processID": "RMSSendCriticalLogProc"CODUSUARIO"
                ],
                "statusPrimaryKeyTableName": "successGUSUARIO",
                "scheduleDateOnlineMode": "26/10/2018 10:37:51"false,
                "executionDateSyncExecution": "26/10/2018 10:38:00"false,
                "executionIDHideProgressDialog": "1"false,
                "scheduleIDSaveParamsExecution": "102776"false,
                "userCodUsuario": "rmmestre",
                "recurrentContext": false,{
                    "executionParameter$id": {"1",
                    "LastErrorSent_params": "0001-01-01T00:00:00-02:00",{
                        "Initialized$EXERCICIOFISCAL": true2,
                        "PrimaryKeyList$CODLOCPRT": []12,
                        "PrimaryKeyNames$CODTIPOCURSO": null-1,
                        "PrimaryKeyTableName$EDUTIPOUSR": null"-1",
                        "OnlineMode$CODUNIDADEBIB": false-1,
                        "SyncExecution$CODCOLIGADA": false1,
                        "HideProgressDialog$RHTIPOUSR": false"-1",
                        "SaveParamsExecution$CODIGOEXTERNO": false"-1",
                        "CodUsuario$CODSISTEMA": null"G",
                        "Context$CODUSUARIOSERVICO": {"",
                        "$id$CODUSUARIO": "1mestre",
                        "_params$IDPRJ": {-1,
                            "$CODCOLIGADA$CHAPAFUNCIONARIO": 0"-1",
                            "$CODSISTEMA$CODFILIAL": "G"1
                        },
                        "Environment": 01
                    },
                    "UserName": "rmmestre",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "12710.031.04.157",
                    "HostName": "localhostBHD050100279",
                    "JobServerHostName": "BHD050102417BHD050100279",
                    "ActionName": null"GlbActionProcCopyPermisUsr",
                    "MasterActionName": null"GlbUsuarioAction",
                    "ActionModule": null"G",
                    "JobID": {
                        "ID": 1027761,
                        "ExecID": 1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ShowReExecuteButton": true,
                    "ExecutionId": "a88518a82b72d443-56c4e6f6-43d74693-b8f0bd83-c97eda42e5d9318f67585a79",
                    "ProcessName": null,
     "Cópia de Permissões de Usuários",
                "ServerName": null"GlbCopyPermisUsrProc",
                    "ServiceInterface": null,
                    "Scheduler": 1,
                    "UseJobMonitor": true,
                    "ScheduleDateTime": "2018-1012-26T1006T10:3739:5157.41859865233678-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": null"",
                    "CustomData": null,
                    "CanParallelize": falsetrue,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

1.1.3 - Filter (Resultado filtrado)

...

expand

Informações

icon	false
title	1.1.3 Filter

Informações

icon	false
title	Configuração

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

glb

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/

glb

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

scheduleID

jobScheduleID": "

100360

3",
            "status": "

pending

active",
            "

scheduleDate

lastModified": "

26/10/2018 11:00:00

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

executionDate

processID": "GlbCopyPermisUsrProc",
            "

executionID

firstExecution": "

868

2018-12-06T15:30:00",
            "user": "mestre",
            "recurrent": true,
            "

weekly

executionParameter": {
                "

daysOfWeek

SourceUsuario":

[

"mestre",
                "

Sunday

RemoveOldPermissions": false,

Monday

CopyToAllApplications": true,

"Tuesday

"CodSistema": "G",

Wednesday

NewUser"

,

: {
                    "

Thursday

Usuario": null,
                    "

Friday

Nome": null,
                    "

Saturday

Senha"

: null,

],

"hour

"Email":

11

null,

"minute":

0

}

"codAcesso": null,

"execution": {

processID

UsuariodeRede":

"MntCalcularMediaDiariaIndicadorUsoProc",

null

"status": "success"

},

"scheduleDate":

11/06/2009 11:00:00"

Initialized": true,
                "

executionDate

PrimaryKeyList":

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

"executionID": "1",

"scheduleID":

100360

Fabio.nunes"

,

"user": "",

"recurrent": true

],
                "

executionParameter

PrimaryKeyNames":

{

[
                    "

CodColigada": 1,

CODUSUARIO"
                ],
                "

DataInicial

PrimaryKeyTableName": "

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

GUSUARIO",

DataFinal

OnlineMode":

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

false,

Initialized

SyncExecution": false,

PrimaryKeyList

HideProgressDialog":

[

false,
                "SaveParamsExecution": false,

[

         "CodUsuario": "mestre",

1,

"Context": {
                    "$id":

Z000Y0011

1",
                    "_params": {

]

                    "$EXERCICIOFISCAL":

]

2,
                        "

PrimaryKeyNames

$CODLOCPRT":

[

12,
                        "

CODCOLIGADA

$CODTIPOCURSO": -1,
                        "$EDUTIPOUSR": "

IDOBJOF

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

Sara

mestre",

"ConnectionId": null,

"ConnectionString": null,

                "DriverType": null,

                "Ip": "10.31.

5

4.

226

57",

"HostName": "

RM005762

BHD050100279",

"JobServerHostName": "

RM005762

BHD050100279",

"ActionName": "

MntCalcularMediaDiariaIndicadorUsoAction

GlbActionProcCopyPermisUsr",

"MasterActionName":

null

"GlbUsuarioAction",

"ActionModule": "

N

G",

"JobID": {

                    "ID":

-1

3,

"ExecID":

-

1,

"IsPriorityJob": false,

"Children": []
                },

},

     "ShowReExecuteButton": true,
                "ExecutionId": "

30cda7ed

2b72d443-

fa9d

e6f6-

4593

4693-

be95

bd83-

a590f4661b51

318f67585a79",

"ProcessName": "

Calcular

Cópia

Média Diária

de

Indicador

Permissões de

Uso

Usuários",

"ServerName": "

MntCalcularMediaDiariaIndicadorUsoProc

GlbCopyPermisUsrProc",

"ServiceInterface": null,

"Scheduler": 1,

"UseJobMonitor": true,

"ScheduleDateTime": "

2009

2018-

06

12-

04T15

06T10:

31

39:

52

57.

7944738

5233678-

03

02:00",

"CanSendMail": false,

                "CanWaitSchedule": false,

"SendMail": false,

                "FriendlyLogs": null,

                "SuccessMessage": "Processo executado com sucesso",

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


                "SaveLogInDatabase":

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

NotifyEmail

NotifyEmailList":

false,

null
            },
            "

NotifyEmailList

daily":

null

}

"hour": 0,
                "

return

minute":

""

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	Paginação

Expandir

Informações

icon	false
title	Configuração

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

glb

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/

glb

framework/v1/jobscheduler?page=1&pageSize=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{

hasNext

status":

true

"completed",
            "

items

lastModified":

[

"2018-12-06T15:33:37",

{

"processID": "GlbCopyPermisUsrProc",
            "

scheduleID

firstExecution": "

100001

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

status

user":

"success"

"mestre",
            "recurrent": false,
            "

scheduleDate

executionParameter": {
                "SourceUsuario":

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

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

executionDate

CodSistema": "

17/11/2008 17:16:05

G",
                "

executionID

NewUser":

"1",

{
                    "

user

Usuario":

""

null,
                    "

recurrent

Nome":

false

null,

"single

        "Senha":

{

null,
                    "

year

Email":

2008

null,
                    "

month

codAcesso":

11

null,
                    "

day

UsuariodeRede":

17,

null

"hour": 17

},
                "

minute

Initialized":

16

true,

},

    "PrimaryKeyList": [

"execution":

{

"processID":

"PrjConcederPermissaoAcessoProjetoProc",

"status":

success

Fabio.nunes"

,

"scheduleDate":

"17/11/2008

17:16:01",

"executionDate":

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

 ],
                "

executionID

PrimaryKeyNames":

"1",

"scheduleID":

100001

CODUSUARIO"

,

"user": ""

],
                "

recurrent

PrimaryKeyTableName":

false

"GUSUARIO",
                "

executionParameter

OnlineMode":

{

false,

Permissoes

SyncExecution":

null

false,

Initialized

HideProgressDialog": false,

PrimaryKeyList

SaveParamsExecution":

[

false,
                "CodUsuario": "mestre",

[

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

0

                 "$EXERCICIOFISCAL": 2,

]

"$CODLOCPRT": 12,
                        "

PrimaryKeyNames

$CODTIPOCURSO":

[

-1,
                        "$EDUTIPOUSR": "

CODCOLIGADA

-1",
                        "

IDPRJ

$CODUNIDADEBIB": -1,

]

 "$CODCOLIGADA": 1,
                        "

PrimaryKeyTableName

$RHTIPOUSR":

null

"-1",
                        "

OnlineMode

$CODIGOEXTERNO":

false

"-1",
                        "

SyncExecution

$CODSISTEMA":

false

"G",
                        "

HideProgressDialog

$CODUSUARIOSERVICO":

false

"",
                        "

SaveParamsExecution

$CODUSUARIO":

false

"mestre",
                        "

CodUsuario

$IDPRJ":

null

-1,
                        "

Context

$CHAPAFUNCIONARIO":

{

"-1",
                        "

$id

$CODFILIAL":

"

",

"_params":

{

},

"Environment":

0

},

"UserName": "

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 permissão

Cópia 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, "MaximumQuantityOfPrimaryKeysPerProcess

": 0,

NotifyFluig

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

NotifyEmail

MaximumQuantityOfPrimaryKeysPerProcess":

false

1000,

NotifyEmailList

NotifyFluig":

null

false,

}

"NotifyEmail": false,
                "

return

NotifyEmailList":

""

null
            }
        }
    ]
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

)

linenumbers

true

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

expand

Informações

icon	false
title	1.1.5 Fields

Informações

icon	false
title	Configuração

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

glb

framework/v1/jobscheduler?fields={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo:

scheduleID

jobScheduleId

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

glb

framework/v1/jobscheduler?fields=

scheduleID

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": true, "items": [ { "scheduleID": "100147" }, { "scheduleID": "100149" }, {

scheduleID

hasNext":

"100157" }

false,

{ "scheduleID

"items":

"100229" },

{
            "

scheduleID

jobScheduleID": "

100302" }, {

1",
            "

scheduleID

lastModified": "

100310" },

0001-01-01T00:00:00",

{

"scheduleID

"firstExecution": "

100326

0001-01-01T00:00:00"
        },
        {
            "

scheduleID

jobScheduleID": "

100360" }, {

2",
            "

scheduleID

lastModified": "

100362" }, {

0001-01-01T00:00:00",
            "

scheduleID

firstExecution": "

101341

0001-01-01T00:00:00"
        },
        {
            "

scheduleID

jobScheduleID": "

102083

3",

},

{

"lastModified": "0001-01-01T00:00:00",
            "

scheduleID

firstExecution": "

102473

0001-01-01T00:00:00"
        }

,

{ "scheduleID": "102474" }, { "scheduleID": "102767" }, { "scheduleID": "102769" }, { "scheduleID": "102771" }, { "scheduleID": "102772" }, { "scheduleID": "102777" }, { "scheduleID": "102764" }, { "scheduleID": "100360" } ] }

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

Informações

title	Parâmetros

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

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

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

]
}

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

...

Informações

title	Parâmetros

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

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

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

Informações

icon	false
title	GetOne

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 1

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.2 - POST

...

1.2.1 - Post (Inserir um agendamento de job)

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

glb

framework/v1/jobscheduler

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

glb

framework/v1/jobscheduler

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

envidas

enviadas as propriedades "

scheduleDate

ScheduleDateTime" e

tipo

Tipo de

recorrência

Recorrência.

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

scheduleDate

firstExecution": "2018-

10

12-

26

23

01:

05

00:00",

recurrent

processID":

true, "daily": { "hour": 23, "minute": 1 }, "execution": { "processID": "GlbCopyPermisUsrProc",

"GlbCopyPermisUsrProc",
	"user": "mestre",
	"recurrent": false,
	"executionParameter": {

"SourceUsuario": "mestre",

"RemoveOldPermissions": false,

"CopyToAllApplications": true,

"CodSistema": "G",

"NewUser": {

			"Usuario":

"testepost"

null,

"Nome":

"testepost"

null,

"Senha":

"totvs"

null,
			"Email": null,

Email

codAcesso":

"testepost",

null,
			"UsuariodeRede": null
		},
		"

codAcesso

Initialized": true,
		"

Acesso01",

PrimaryKeyList": [
			[
				"

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

"$CODIGOEXTERNO": "-1",

"$CODSISTEMA": "G",

"$CODUSUARIOSERVICO": "",

"$CODUSUARIO": "mestre",

"$IDPRJ": -1,

"$CHAPAFUNCIONARIO": "-1",

"$CODFILIAL":

-

},

			"Environment": 1

},

"UserName": "mestre",

"ConnectionId": null,

"ConnectionString": null,

"DriverType": null,

"Ip": "10.31.4.57",

"HostName": "BHD050100279",

		"JobServerHostName": "BHD050100279",

		"ActionName": "GlbActionProcCopyPermisUsr",

"MasterActionName": "GlbUsuarioAction",

		"ActionModule": "G",

		"JobID": {

"ID": 1,

"ExecID": 1,

"IsPriorityJob": false,

"Children": []

},

"ShowReExecuteButton": true,

"ExecutionId": "

7dba5874

2b72d443-

a296

e6f6-

43bc

4693-

89fd

bd83-

ab853121feec

318f67585a79",

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

"ServerName": "GlbCopyPermisUsrProc",

"ServiceInterface": null,

"Scheduler": 1,

		"UseJobMonitor": true,

		"ScheduleDateTime": "2018-

10

12-

25T12

06T10:

04

39:

31

57.

8719316

5233678-

03

02:00",

"CanSendMail": false,

"CanWaitSchedule": false,

"SendMail": false,

"FriendlyLogs": null,

"SuccessMessage": "Processo executado com sucesso",

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

		"SaveLogInDatabase": true,

"StatusMessage": null,

		"WaitSchedule": false,

		"IsolateProcess": false,

"DisableIsolateProcess": false,

"NetworkUser": "fabio.nunes",

"CustomData": null,

"CanParallelize": true,

"ShouldParallelize": false,

"QuantityOfSplits": 0,

"MinimumQuantityOfPrimaryKeysPerProcess": 1,

"MaximumQuantityOfPrimaryKeysPerProcess": 1000,

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

NotifyEmail

NotifyEmailList":

false, } } }

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

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

1",

"status": "

pending

active",

scheduleDate

lastModified": "

26/10/2018 23:05:00

2018-12-06T14:18:42",
    "processID": "GlbCopyPermisUsrProc",
    "

executionDate

firstExecution": "2018-12-05T01:00:00",

executionID

user": "

1

mestre",
    "recurrent": false,
    "

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

"$CODIGOEXTERNO": "-1",

"$CODSISTEMA": "G",

                "$CODUSUARIOSERVICO": "",

"$CODUSUARIO": "mestre",

"$IDPRJ": -1,

"$CHAPAFUNCIONARIO": "-1",

"$CODFILIAL":

-

},

"Environment": 1

},

        "UserName": "mestre",

"ConnectionId": null,

        "ConnectionString": null,

        "DriverType":

null,

 null,
        "Ip": "10.31.4.57",

        "HostName": "BHD050100279",

"JobServerHostName": "BHD050100279",

"ActionName": "GlbActionProcCopyPermisUsr",

"MasterActionName": "GlbUsuarioAction",

"ActionModule": "G",

"JobID": {

"ID":

6

1,

            "ExecID": 1,

"IsPriorityJob": false,

            "Children": []

},

"ShowReExecuteButton": true,

"ExecutionId": "

7dba5874

2b72d443-

a296

e6f6-

43bc

4693-

89fd

bd83-

ab853121feec

318f67585a79",

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

"ServerName": "GlbCopyPermisUsrProc",

        "ServiceInterface": null,

        "Scheduler": 1,

"UseJobMonitor": true,

"ScheduleDateTime": "2018-

10

12-

25T12

06T10:

04

39:

31

57.

8719316

5233678-

03

02:00",

"CanSendMail": false,

"CanWaitSchedule": false,

"SendMail": false,

"FriendlyLogs": null,

"SuccessMessage": "Processo executado com sucesso",

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

"SaveLogInDatabase": true,

"StatusMessage": null,

"WaitSchedule": false,

"IsolateProcess": false,

        "DisableIsolateProcess": false,

"NetworkUser": "",

"CustomData": null,

"CanParallelize": true,

"ShouldParallelize": false,

"QuantityOfSplits": 0,

        "MinimumQuantityOfPrimaryKeysPerProcess": 1,

"MaximumQuantityOfPrimaryKeysPerProcess": 1000,

        "NotifyFluig": false,

        "NotifyEmail": false,

"NotifyEmailList": null

}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE016",
    "Message": "O corpo da mensagem contém valores inválidos.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.2.2 - Post {IdJob}/Trigger

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

glb

framework/v1/jobscheduler/{jobID}/trigger

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobID:

1

3

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

glb

framework/v1/jobscheduler/

1

3/trigger

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

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "

scheduleID

jobScheduleID": "

6

3",
    "status": "

pending

inactive",
    "

scheduleDate

lastModified": "

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

2018-12-06T15:36:53",
    "processID": "GlbCopyPermisUsrProc",
    "firstExecution": "2018-12-06T15:30:00",
    "user": "mestre",

executionID

recurrent":

"1"

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,

codAcesso

PrimaryKeyList":

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

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

"$CODSISTEMA

             "$CODUSUARIOSERVICO": "

G

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

$CODUSUARIOSERVICO

$IDPRJ":

""

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

$CODUSUARIO

$CODFILIAL":

"mestre",

1
            },
            "

$IDPRJ

Environment":

-

,

},

$CHAPAFUNCIONARIO

UserName": "

-1

mestre",
        "ConnectionId": null,

$CODFILIAL

ConnectionString":

-1

null,
        "DriverType": null,

}

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

Environment

JobServerHostName":

1

"BHD050100279",
        "ActionName": "GlbActionProcCopyPermisUsr",

},

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

ExecutionId

StatusMessage":

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

null,
        "WaitSchedule": false,

"ProcessName":

"Cópia

de

Permissões

de

Usuários

"IsolateProcess": false,

ServerName

DisableIsolateProcess":

"GlbCopyPermisUsrProc"

false,

ServiceInterface

NetworkUser":

null

"",

Scheduler

CustomData":

1

null,

UseJobMonitor

CanParallelize": true,

ScheduleDateTime

ShouldParallelize":

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

false,

CanSendMail

QuantityOfSplits":

false

0,

CanWaitSchedule

MinimumQuantityOfPrimaryKeysPerProcess":

false

1,

SendMail

MaximumQuantityOfPrimaryKeysPerProcess":

false

1000,

FriendlyLogs

NotifyFluig":

null

false,

SuccessMessage

NotifyEmail":

"Processo executado com sucesso"

false,

FailureMessage

NotifyEmailList":

"Falha

null

na

execução

do

processo"

},
    "daily": {
        "

SaveLogInDatabase

hour":

true

0,

StatusMessage

minute":

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

{
   "

WaitSchedule

Code":

false

"FE011",

"IsolateProcess

"Message":

false,

"Não foi encontrada nenhuma tarefa pendente com o id 0.",
   "

DisableIsolateProcess

DetailMessage":

false

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

Expandir

title	Ver resultado JSON...

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "

FE011

FE019",
    "Message": "Não

foi encontrada nenhuma tarefa

 é possível reiniciar o Job 1 pois o mesmo está pendente

com

ou

o

em

id 0

execução.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.3 - PUT

...

1.3.1 - Put (Atualizar um Job)

...

Ao executar a requisição de PUT, informando um JobID, esse processo será desabilitado e um novo será criado.

...

Informações

icon	false
title	1.3.1 Put

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
   	"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	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 1

Url Utilizada: http://localhost:8051/api/glb/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

{
  "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                "$EDUTIPOUSR": "-1",
					"$CODIGOEXTERNO                "$CODUNIDADEBIB": "-1",
					"$CODSISTEMA": "G",
					"$CODUSUARIOSERVICO": "",
					"$CODUSUARIO": "mestre",
					"$IDPRJ": -1,
					"$CHAPAFUNCIONARIO,
                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
					"$CODFILIAL                "$CODIGOEXTERNO": "-1
				},
				"Environment": 1
			},
			"UserName",
                "$CODSISTEMA": "mestreG",
			"ConnectionId                "$CODUSUARIOSERVICO": 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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "processIDjobScheduleID": "GlbCopyPermisUsrProc2",
    "status": "active",
    "statuslastModified": "pending2018-12-06T15:29:47",
    "processID": "GlbCopyPermisUsrProc",
    "scheduleDatefirstExecution": "01/11/2018 20:052018-12-06T15:30:00",
        "executionDateuser": "mestre",
    "recurrent": true,
    "executionIDexecutionParameter": "1",{
        "scheduleIDSourceUsuario": "2mestre",
        "userRemoveOldPermissions": "mestre"false,
        "recurrentCopyToAllApplications": true,
        "executionParameterCodSistema": {
    "G",
        "SourceUsuarioNewUser": "mestre",{
            "RemoveOldPermissionsUsuario": falsenull,
            "CopyToAllApplicationsNome": truenull,
            "CodSistemaSenha": "G"null,
            "NewUserEmail": {null,
                "UsuariocodAcesso": "testepost"null,
                "NomeUsuariodeRede": "testepost",null
        },
        "SenhaInitialized": "totvs"true,
                "Email"PrimaryKeyList": "testepost",[
                "codAcesso": "Acesso01",[
                "UsuariodeRede": ""Fabio.nunes"
            },]
            "Initialized": true],
            "PrimaryKeyListPrimaryKeyNames": [],
            "PrimaryKeyNames": null,
CODUSUARIO"
        ],
        "PrimaryKeyTableName": null"GUSUARIO",
            "OnlineMode": false,
            "SyncExecution": false,
            "HideProgressDialog": false,
            "SaveParamsExecution": false,
            "CodUsuario": "mestre",
            "Context": {
                "$id": "1",
                "_params": {
                    "$EXERCICIOFISCAL": -12,
                    "$CODLOCPRT": -112,
                    "$CODTIPOCURSO": -1,
                    "$EDUTIPOUSR": "-1",
                    "$CODUNIDADEBIB": -1,
                    "$CODCOLIGADA": 1,
                    "$RHTIPOUSR": "-1",
                    "$CODIGOEXTERNO": "-1",
                    "$CODSISTEMA": "G",
                    "$CODUSUARIOSERVICO": "",
                    "$CODUSUARIO": "mestre",
                    "$IDPRJ": -1,
                    "$CHAPAFUNCIONARIO": "-1",
                    "$CODFILIAL": -1
                },
                "Environment": 1
            },
            "UserName": "mestre",
            "ConnectionId": null,
            "ConnectionString": null,
            "DriverType": null,
            "Ip": "10.31.4.57",
            "HostName": "BHD050100279",
            "JobServerHostName": "BHD050100279",
            "ActionName": "GlbActionProcCopyPermisUsr",
            "MasterActionName": "GlbUsuarioAction",
            "ActionModule": "G",
            "JobID": {
                "ID": 2,
                "ExecID": 1,
                "IsPriorityJob": false,
                "Children": []
            },
            "ShowReExecuteButton": true,
            "ExecutionId": "7dba58742b72d443-a296e6f6-43bc4693-89fdbd83-ab853121feec318f67585a79",
            "ProcessName": "Cópia de Permissões de Usuários",
            "ServerName": "GlbCopyPermisUsrProc",
            "ServiceInterface": null,
            "Scheduler": 1,
            "UseJobMonitor": true,
            "ScheduleDateTime": "2018-1012-25T1206T10:0439:3157.87193165233678-0302:00",
            "CanSendMail": false,
            "CanWaitSchedule": false,
            "SendMail": false,
            "FriendlyLogs": null,
            "SuccessMessage": "Processo executado com sucesso",
            "FailureMessage": "Falha na execução do processo",
            "SaveLogInDatabase": true,
            "StatusMessage": null,
            "WaitSchedule": false,
            "IsolateProcess": false,
            "DisableIsolateProcess": false,
            "NetworkUser": "",
            "CustomData": null,
            "CanParallelize": true,
            "ShouldParallelize": false,
            "QuantityOfSplits": 0,
            "MinimumQuantityOfPrimaryKeysPerProcess": 1,
            "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyFluigNotifyEmail": false,
        "NotifyEmailList": null
   "NotifyEmail": false},
    "daily": {
        "NotifyEmailListhour": null0,
        }"minute": 1
    }
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE016",
    "Message": "O Job 10 não foi encontrado na base de dados!",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Deletar um Job)

...

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

...

Informações

icon	false
title	1.4.1 Delete

Expandir

title	Clique aqui para expandir...

Informações

icon	false
title	Configuração

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

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 40

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.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

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

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.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar o Agendamento pelo JobId)

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