Sumário

...

Índice

exclude	Sumário

Objetivo

...

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

1 - Métodos

...

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

...

Informações

icon	false
title	Observação:

Caso não 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)

...

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Resultado

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

1.1.3 - Filter (Resultado filtrado)

...

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: pending

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler?status=pending

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

1.1.4 - Paginação

...

Informações

title	Parâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações

icon	false
title	1.1.4 Paginacao

Expandir

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

Expandir

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

Url Utilizada: http://localhost:8099/api/rm/glb/v1/users?fields=scheduleID,lastModified,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	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 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	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

1.2.2 - Post {IdJob}/Trigger

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobID: 3

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

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

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
   "Code": "FE011",
   "Message": "Não foi encontrada nenhuma tarefa pendente com o id 0.",
   "DetailMessage": "",
   "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
   "Details": null
}

1.2.3 - Post {IdJob}/Restart

...

Informações

icon	false
title	1.2.1 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.

Expandir

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

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{	
    "jobScheduleId": "1",
    "status": "active",
    "lastModified": "2019-03-13T12:11:33-03:00",
    "processId": "GlbCopyPermisUsrProc",
    "firstExecution": "2019-03-13T12:16:00-03:00",
    "user": "mestre",
    "recurrent": true,
    "executionParameter": {
        "SourceUsuario": "mestre",
        "RemoveOldPermissions": false,
        "CopyToAllApplications": true,
        "CodSistema": "G",
        "NewUser": {
            "Usuario": null,
            "Nome": null,
            "Senha": null,
            "Email": null,
            "codAcesso": null,
            "UsuariodeRede": null
        },
        "Initialized": true,
        "PrimaryKeyList": [
            [
                "00001"
            ]
        ],
        "PrimaryKeyNames": [
            "CODUSUARIO"
        ],
        "PrimaryKeyTableName": "GUSUARIO",
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "1",
            "_params": {
                "$EXERCICIOFISCAL": -1,
                "$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": "172.20.81.1",
        "HostName": "BHD050101853",
        "JobServerHostName": "BHD050100616",
        "ActionName": "GlbActionProcCopyPermisUsr",
        "MasterActionName": "GlbUsuarioAction",
        "ActionModule": "G",
        "JobID": {
            "ID": 1,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "1de4983d-1e70-4767-b358-baa174c663a8",
        "ProcessName": "Cópia de Permissões de Usuários",
        "ServerName": "GlbCopyPermisUsrProc",
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2018-10-29T17:37:03-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": "",
        "CustomData": null,
        "CanParallelize": true,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    },
    "weekly": {
        "daysOfWeek": [
            "Thursday",
            "Saturday"
        ],
        "hour": 14,
        "minute": 35
    }
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE019",
    "Message": "Não é possível reiniciar o Job 1 pois o mesmo está pendente ou em execução.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

1.3 - PUT

...

1.3.1 - Put (Atualizar um Job)

...

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

...

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,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "1",
            "_params": {
                "$EXERCICIOFISCAL": 2,
                "$CODLOCPRT": 12,
                "$CODTIPOCURSO": -1,
                "$EDUTIPOUSR": "-1",
                "$CODUNIDADEBIB": -1,
                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
                "$CODIGOEXTERNO": "-1",
                "$CODSISTEMA": "G",
                "$CODUSUARIOSERVICO": "",
                "$CODUSUARIO": "mestre",
                "$IDPRJ": -1,
                "$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 1
            },
            "Environment": 1
        },
        "UserName": "mestre",
        "ConnectionId": null,
        "ConnectionString": null,
        "DriverType": null,
        "Ip": "10.31.4.57",
        "HostName": "BHD050100279",
        "JobServerHostName": "BHD050100279",
        "ActionName": "GlbActionProcCopyPermisUsr",
        "MasterActionName": "GlbUsuarioAction",
        "ActionModule": "G",
        "JobID": {
            "ID": 1,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "2b72d443-e6f6-4693-bd83-318f67585a79",
        "ProcessName": "Cópia de Permissões de Usuários",
        "ServerName": "GlbCopyPermisUsrProc",
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2018-12-06T10:39:57.5233678-02:00",
        "CanSendMail": false,
        "CanWaitSchedule": false,
        "SendMail": false,
        "FriendlyLogs": null,
        "SuccessMessage": "Processo executado com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "SaveLogInDatabase": true,
        "StatusMessage": null,
        "WaitSchedule": false,
        "IsolateProcess": false,
        "DisableIsolateProcess": false,
        "NetworkUser": "fabio.nunes",
        "CustomData": null,
        "CanParallelize": true,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    }
}

Informações

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

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 55

Nova versão 56

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

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

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

Nova versão 56

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

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

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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