Histórico da Página

...

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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": "1",
                "scheduleID": "100001",
                "user": "",
                "recurrent": false,
                "executionParameter": {
                    "Permissoes": null,
                    "Initialized": false,
                    "PrimaryKeyList": [
                        [
                            1,
                            0
                        ]
                    ],
                    "PrimaryKeyNames": [
                        "CODCOLIGADA",
                        "IDPRJ"
                    ],
                    "PrimaryKeyTableName": null,
                    "OnlineMode": false,
                    "SyncExecution": false,
                    "HideProgressDialog": false,
                    "SaveParamsExecution": false,
                    "CodUsuario": null,
                    "Context": {
                        "$id": "1",
                        "_params": {},
                        "Environment": 0
                    },
                    "UserName": "Breno",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "10.31.7.80",
                    "HostName": "RM0005748",
                    "JobServerHostName": "RM0005748",
                    "ActionName": "PrjConcederPermissaoAcessoProjetoAction",
                    "MasterActionName": null,
                    "ActionModule": null,
                    "JobID": {
                        "ID": -1,
                        "ExecID": -1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ExecutionId": "1c19b022-c065-42d2-ae20-647259c2e2c0",
                    "ProcessName": "Conceder permissão de Acesso a Projetos",
                    "ServerName": "PrjConcederPermissaoAcessoProjetoProc",
                    "ServiceInterface": null,
                    "Scheduler": 2,
                    "UseJobMonitor": false,
                    "ScheduleDateTime": "2008-11-17T17:15:54.1180698-02:00",
                    "CanSendMail": false,
                    "CanWaitSchedule": false,
                    "SendMail": false,
                    "FriendlyLogs": null,
                    "SuccessMessage": "Processo executado com sucesso",
                    "FailureMessage": "Falha na execução do processo",
                    "SaveLogInDatabase": false,
                    "StatusMessage": null,
                    "WaitSchedule": false,
                    "IsolateProcess": false,
                    "DisableIsolateProcess": false,
                    "NetworkUser": null,
                    "CustomData": null,
                    "CanParallelize": false,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 0,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 0,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

...

Informações

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?order=scheduleID

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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": "1",
                "scheduleID": "100001",
                "user": "",
                "recurrent": false,
                "executionParameter": {
                    "Permissoes": null,
                    "Initialized": false,
                    "PrimaryKeyList": [
                        [
                            1,
                            0
                        ]
                    ],
                    "PrimaryKeyNames": [
                        "CODCOLIGADA",
                        "IDPRJ"
                    ],
                    "PrimaryKeyTableName": null,
                    "OnlineMode": false,
                    "SyncExecution": false,
                    "HideProgressDialog": false,
                    "SaveParamsExecution": false,
                    "CodUsuario": null,
                    "Context": {
                        "$id": "1",
                        "_params": {},
                        "Environment": 0
                    },
                    "UserName": "Breno",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "10.31.7.80",
                    "HostName": "RM0005748",
                    "JobServerHostName": "RM0005748",
                    "ActionName": "PrjConcederPermissaoAcessoProjetoAction",
                    "MasterActionName": null,
                    "ActionModule": null,
                    "JobID": {
                        "ID": -1,
                        "ExecID": -1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ExecutionId": "1c19b022-c065-42d2-ae20-647259c2e2c0",
                    "ProcessName": "Conceder permissão de Acesso a Projetos",
                    "ServerName": "PrjConcederPermissaoAcessoProjetoProc",
                    "ServiceInterface": null,
                    "Scheduler": 2,
                    "UseJobMonitor": false,
                    "ScheduleDateTime": "2008-11-17T17:15:54.1180698-02:00",
                    "CanSendMail": false,
                    "CanWaitSchedule": false,
                    "SendMail": false,
                    "FriendlyLogs": null,
                    "SuccessMessage": "Processo executado com sucesso",
                    "FailureMessage": "Falha na execução do processo",
                    "SaveLogInDatabase": false,
                    "StatusMessage": null,
                    "WaitSchedule": false,
                    "IsolateProcess": false,
                    "DisableIsolateProcess": false,
                    "NetworkUser": null,
                    "CustomData": null,
                    "CanParallelize": false,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 0,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 0,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?order=-scheduleID

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "scheduleID": "102776",
            "status": "success",
            "scheduleDate": "26/10/2018 10:37:51",
            "executionDate": "26/10/2018 10:38:00",
            "executionID": "1",
            "user": "rm",
            "recurrent": false,
            "execution": {
                "processID": "RMSSendCriticalLogProc",
                "status": "success",
                "scheduleDate": "26/10/2018 10:37:51",
                "executionDate": "26/10/2018 10:38:00",
                "executionID": "1",
                "scheduleID": "102776",
                "user": "rm",
                "recurrent": false,
                "executionParameter": {
                    "LastErrorSent": "0001-01-01T00:00:00-02:00",
                    "Initialized": true,
                    "PrimaryKeyList": [],
                    "PrimaryKeyNames": null,
                    "PrimaryKeyTableName": null,
                    "OnlineMode": false,
                    "SyncExecution": false,
                    "HideProgressDialog": false,
                    "SaveParamsExecution": false,
                    "CodUsuario": null,
                    "Context": {
                        "$id": "1",
                        "_params": {
                            "$CODCOLIGADA": 0,
                            "$CODSISTEMA": "G"
                        },
                        "Environment": 0
                    },
                    "UserName": "rm",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "127.0.0.1",
                    "HostName": "localhost",
                    "JobServerHostName": "BHD050102417",
                    "ActionName": null,
                    "MasterActionName": null,
                    "ActionModule": null,
                    "JobID": {
                        "ID": 102776,
                        "ExecID": 1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ShowReExecuteButton": true,
                    "ExecutionId": "a88518a8-56c4-43d7-b8f0-c97eda42e5d9",
                    "ProcessName": null,
                    "ServerName": null,
                    "ServiceInterface": null,
                    "Scheduler": 1,
                    "UseJobMonitor": true,
                    "ScheduleDateTime": "2018-10-26T10:37:51.4185986-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": false,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 1,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

...

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: pending

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

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "scheduleID": "100360",
            "status": "pending",
            "scheduleDate": "26/10/2018 11:00:00",
            "executionDate": "",
            "executionID": "868",
            "user": "",
            "recurrent": true,
            "weekly": {
                "daysOfWeek": [
                    "Sunday",
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday"
                ],
                "hour": 11,
                "minute": 0
            },
            "execution": {
                "processID": "MntCalcularMediaDiariaIndicadorUsoProc",
                "status": "success",
                "scheduleDate": "11/06/2009 11:00:00",
                "executionDate": "04/04/2011 13:56:05",
                "executionID": "1",
                "scheduleID": "100360",
                "user": "",
                "recurrent": true,
                "executionParameter": {
                    "CodColigada": 1,
                    "DataInicial": "2008-01-01T00:00:00-02:00",
                    "DataFinal": "2009-06-04T00:00:00-03:00",
                    "Initialized": false,
                    "PrimaryKeyList": [
                        [
                            1,
                            "Z000Y0011"
                        ]
                    ],
                    "PrimaryKeyNames": [
                        "CODCOLIGADA",
                        "IDOBJOF"
                    ],
                    "PrimaryKeyTableName": null,
                    "OnlineMode": false,
                    "SyncExecution": false,
                    "HideProgressDialog": false,
                    "SaveParamsExecution": false,
                    "CodUsuario": null,
                    "Context": {
                        "$id": "1",
                        "_params": {},
                        "Environment": 0
                    },
                    "UserName": "Sara",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "10.31.5.226",
                    "HostName": "RM005762",
                    "JobServerHostName": "RM005762",
                    "ActionName": "MntCalcularMediaDiariaIndicadorUsoAction",
                    "MasterActionName": null,
                    "ActionModule": "N",
                    "JobID": {
                        "ID": -1,
                        "ExecID": -1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ExecutionId": "30cda7ed-fa9d-4593-be95-a590f4661b51",
                    "ProcessName": "Calcular Média Diária de Indicador de Uso",
                    "ServerName": "MntCalcularMediaDiariaIndicadorUsoProc",
                    "ServiceInterface": null,
                    "Scheduler": 1,
                    "UseJobMonitor": true,
                    "ScheduleDateTime": "2009-06-04T15:31:52.7944738-03:00",
                    "CanSendMail": false,
                    "CanWaitSchedule": false,
                    "SendMail": false,
                    "FriendlyLogs": null,
                    "SuccessMessage": "Processo executado com sucesso",
                    "FailureMessage": "Falha na execução do processo",
                    "SaveLogInDatabase": false,
                    "StatusMessage": null,
                    "WaitSchedule": false,
                    "IsolateProcess": false,
                    "DisableIsolateProcess": false,
                    "NetworkUser": null,
                    "CustomData": null,
                    "CanParallelize": false,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 0,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 0,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

...

Informações

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?page=1&pageSize=1

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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,
            "single": {
                "year": 2008,
                "month": 11,
                "day": 17,
                "hour": 17,
                "minute": 16
            },
            "execution": {
                "processID": "PrjConcederPermissaoAcessoProjetoProc",
                "status": "success",
                "scheduleDate": "17/11/2008 17:16:01",
                "executionDate": "17/11/2008 17:16:05",
                "executionID": "1",
                "scheduleID": "100001",
                "user": "",
                "recurrent": false,
                "executionParameter": {
                    "Permissoes": null,
                    "Initialized": false,
                    "PrimaryKeyList": [
                        [
                            1,
                            0
                        ]
                    ],
                    "PrimaryKeyNames": [
                        "CODCOLIGADA",
                        "IDPRJ"
                    ],
                    "PrimaryKeyTableName": null,
                    "OnlineMode": false,
                    "SyncExecution": false,
                    "HideProgressDialog": false,
                    "SaveParamsExecution": false,
                    "CodUsuario": null,
                    "Context": {
                        "$id": "1",
                        "_params": {},
                        "Environment": 0
                    },
                    "UserName": "Breno",
                    "ConnectionId": null,
                    "ConnectionString": null,
                    "DriverType": null,
                    "Ip": "10.31.7.80",
                    "HostName": "RM0005748",
                    "JobServerHostName": "RM0005748",
                    "ActionName": "PrjConcederPermissaoAcessoProjetoAction",
                    "MasterActionName": null,
                    "ActionModule": null,
                    "JobID": {
                        "ID": -1,
                        "ExecID": -1,
                        "IsPriorityJob": false,
                        "Children": []
                    },
                    "ExecutionId": "1c19b022-c065-42d2-ae20-647259c2e2c0",
                    "ProcessName": "Conceder permissão de Acesso a Projetos",
                    "ServerName": "PrjConcederPermissaoAcessoProjetoProc",
                    "ServiceInterface": null,
                    "Scheduler": 2,
                    "UseJobMonitor": false,
                    "ScheduleDateTime": "2008-11-17T17:15:54.1180698-02:00",
                    "CanSendMail": false,
                    "CanWaitSchedule": false,
                    "SendMail": false,
                    "FriendlyLogs": null,
                    "SuccessMessage": "Processo executado com sucesso",
                    "FailureMessage": "Falha na execução do processo",
                    "SaveLogInDatabase": false,
                    "StatusMessage": null,
                    "WaitSchedule": false,
                    "IsolateProcess": false,
                    "DisableIsolateProcess": false,
                    "NetworkUser": null,
                    "CustomData": null,
                    "CanParallelize": false,
                    "ShouldParallelize": false,
                    "QuantityOfSplits": 0,
                    "MinimumQuantityOfPrimaryKeysPerProcess": 0,
                    "MaximumQuantityOfPrimaryKeysPerProcess": 0,
                    "NotifyFluig": false,
                    "NotifyEmail": false,
                    "NotifyEmailList": null
                },
                "return": ""
            }
        }
    ]
}

...

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/glb/v1/jobscheduler?fields={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: scheduleID

Url Utilizada: http://localhost:8051/api/glb/v1/jobscheduler?fields=scheduleID

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "scheduleID": "100147"
        },
        {
            "scheduleID": "100149"
        },
        {
            "scheduleID": "100157"
        },
        {
            "scheduleID": "100229"
        },
        {
            "scheduleID": "100302"
        },
        {
            "scheduleID": "100310"
        },
        {
            "scheduleID": "100326"
        },
        {
            "scheduleID": "100360"
        },
        {
            "scheduleID": "100362"
        },
        {
            "scheduleID": "101341"
        },
        {
            "scheduleID": "102083"
        },
        {
            "scheduleID": "102473"
        },
        {
            "scheduleID": "102474"
        },
        {
            "scheduleID": "102767"
        },
        {
            "scheduleID": "102769"
        },
        {
            "scheduleID": "102771"
        },
        {
            "scheduleID": "102772"
        },
        {
            "scheduleID": "102777"
        },
        {
            "scheduleID": "102764"
        },
        {
            "scheduleID": "100360"
        }
    ]
}

...

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 102771

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

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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

Informações

icon	false
title	Exemplo de Entrada Postman

Image Removed

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
  "scheduleDate": "2018-10-26 23:05:00",
  "recurrent": true,
   "daily": {
   "hour": 23,
   "minute": 1
  },
  "execution": {
    "processID": "GlbCopyPermisUsrProc",
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			"OnlineMode": false,
			"SyncExecution": false,
			"HideProgressDialog": false,
			"SaveParamsExecution": false,
			"CodUsuario": "mestre",
			"Context": {
				"$id": "1",
				"_params": {
					"$EXERCICIOFISCAL": -1,
					"$CODLOCPRT": -1,
					"$CODTIPOCURSO": -1,
					"$EDUTIPOUSR": "-1",
					"$CODUNIDADEBIB": -1,
					"$CODCOLIGADA": 1,
					"$RHTIPOUSR": "-1",
					"$CODIGOEXTERNO": "-1",
					"$CODSISTEMA": "G",
					"$CODUSUARIOSERVICO": "",
					"$CODUSUARIO": "mestre",
					"$IDPRJ": -1,
					"$CHAPAFUNCIONARIO": "-1",
					"$CODFILIAL": -1
				},
				"Environment": 1
			},
			"UserName": "mestre",
			"ConnectionId": null,
			"ConnectionString": null,
			"DriverType": null,
			"Ip": "10.31.4.57",
			"HostName": "BHD050100279",
			"JobServerHostName": "BHD050100279",
			"ActionName": "GlbActionProcCopyPermisUsr",
			"MasterActionName": "GlbUsuarioAction",
			"ActionModule": "G",
			"JobID": {
				"ID": 1,
				"ExecID": 1,
				"IsPriorityJob": false,
				"Children": []
			},
			"ShowReExecuteButton": true,
			"ExecutionId": "7dba5874-a296-43bc-89fd-ab853121feec",
			"ProcessName": "Cópia de Permissões de Usuários",
			"ServerName": "GlbCopyPermisUsrProc",
			"ServiceInterface": null,
			"Scheduler": 1,
			"UseJobMonitor": true,
			"ScheduleDateTime": "2018-10-25T12:04:31.8719316-03:00",
			"CanSendMail": false,
			"CanWaitSchedule": false,
			"SendMail": false,
			"FriendlyLogs": null,
			"SuccessMessage": "Processo executado com sucesso",
			"FailureMessage": "Falha na execução do processo",
			"SaveLogInDatabase": true,
			"StatusMessage": null,
			"WaitSchedule": false,
			"IsolateProcess": false,
			"DisableIsolateProcess": false,
			"NetworkUser": "fabio.nunes",
			"CustomData": null,
			"CanParallelize": true,
			"ShouldParallelize": false,
			"QuantityOfSplits": 0,
			"MinimumQuantityOfPrimaryKeysPerProcess": 1,
			"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
			"NotifyFluig": false,
			"NotifyEmail": false,
		}
  }
}

Image Removed

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "scheduleID": "6",
    "status": "pending",
    "scheduleDate": "26/10/2018 23:05:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": true,
    "daily": {
        "hour": 23,
        "minute": 1
    },
    "execution": {
        "processID": "GlbCopyPermisUsrProc",
        "status": "pending",
        "scheduleDate": "26/10/2018 23:05:00",
        "executionDate": "",
        "executionID": "1",
        "scheduleID": "6",
        "user": "mestre",
        "recurrent": true,
        "executionParameter": {
            "SourceUsuario": "mestre",
            "RemoveOldPermissions": false,
            "CopyToAllApplications": true,
            "CodSistema": "G",
            "NewUser": {
                "Usuario": "testepost",
                "Nome": "testepost",
                "Senha": "totvs",
                "Email": "testepost",
                "codAcesso": "Acesso01",
                "UsuariodeRede": ""
            },
            "Initialized": true,
            "PrimaryKeyList": [],
            "PrimaryKeyNames": null,
            "PrimaryKeyTableName": null,
            "OnlineMode": false,
            "SyncExecution": false,
            "HideProgressDialog": false,
            "SaveParamsExecution": false,
            "CodUsuario": "mestre",
            "Context": {
                "$id": "1",
                "_params": {
                    "$EXERCICIOFISCAL": -1,
                    "$CODLOCPRT": -1,
                    "$CODTIPOCURSO": -1,
                    "$EDUTIPOUSR": "-1",
                    "$CODUNIDADEBIB": -1,
                    "$CODCOLIGADA": 1,
                    "$RHTIPOUSR": "-1",
                    "$CODIGOEXTERNO": "-1",
                    "$CODSISTEMA": "G",
                    "$CODUSUARIOSERVICO": "",
                    "$CODUSUARIO": "mestre",
                    "$IDPRJ": -1,
                    "$CHAPAFUNCIONARIO": "-1",
                    "$CODFILIAL": -1
                },
                "Environment": 1
            },
            "UserName": "mestre",
            "ConnectionId": null,
            "ConnectionString": null,
            "DriverType": null,
            "Ip": "10.31.4.57",
            "HostName": "BHD050100279",
            "JobServerHostName": "BHD050100279",
            "ActionName": "GlbActionProcCopyPermisUsr",
            "MasterActionName": "GlbUsuarioAction",
            "ActionModule": "G",
            "JobID": {
                "ID": 6,
                "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": "",
            "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 Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

...

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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

Informações

icon	false
title	Exemplo de Entrada Postman

Image Removed

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
  "scheduleDate": "2018-10-26 23:05:00",
  "recurrent": true,
   "daily": {
   "hour": 23,
   "minute": 1
  },
  "execution": {
    "processID": "GlbCopyPermisUsrProc",
    "executionParameter": {
			"SourceUsuario": "mestre",
			"RemoveOldPermissions": false,
			"CopyToAllApplications": true,
			"CodSistema": "G",
			"NewUser": {
				"Usuario": "testepost",
				"Nome": "testepost",
				"Senha": "totvs",
				"Email": "testepost",
				"codAcesso": "Acesso01",
				"UsuariodeRede": ""
			},
			"Initialized": true,
			"PrimaryKeyList": [],
			"PrimaryKeyNames": null,
			"PrimaryKeyTableName": null,
			"OnlineMode": false,
			"SyncExecution": false,
			"HideProgressDialog": false,
			"SaveParamsExecution": false,
			"CodUsuario": "mestre",
			"Context": {
				"$id": "1",
				"_params": {
					"$EXERCICIOFISCAL": -1,
					"$CODLOCPRT": -1,
					"$CODTIPOCURSO": -1,
					"$EDUTIPOUSR": "-1",
					"$CODUNIDADEBIB": -1,
					"$CODCOLIGADA": 1,
					"$RHTIPOUSR": "-1",
					"$CODIGOEXTERNO": "-1",
					"$CODSISTEMA": "G",
					"$CODUSUARIOSERVICO": "",
					"$CODUSUARIO": "mestre",
					"$IDPRJ": -1,
					"$CHAPAFUNCIONARIO": "-1",
					"$CODFILIAL": -1
				},
				"Environment": 1
			},
			"UserName": "mestre",
			"ConnectionId": null,
			"ConnectionString": null,
			"DriverType": null,
			"Ip": "10.31.4.57",
			"HostName": "BHD050100279",
			"JobServerHostName": "BHD050100279",
			"ActionName": "GlbActionProcCopyPermisUsr",
			"MasterActionName": "GlbUsuarioAction",
			"ActionModule": "G",
			"JobID": {
				"ID": 1,
				"ExecID": 1,
				"IsPriorityJob": false,
				"Children": []
			},
			"ShowReExecuteButton": true,
			"ExecutionId": "7dba5874-a296-43bc-89fd-ab853121feec",
			"ProcessName": "Cópia de Permissões de Usuários",
			"ServerName": "GlbCopyPermisUsrProc",
			"ServiceInterface": null,
			"Scheduler": 1,
			"UseJobMonitor": true,
			"ScheduleDateTime": "2018-10-25T12:04:31.8719316-03:00",
			"CanSendMail": false,
			"CanWaitSchedule": false,
			"SendMail": false,
			"FriendlyLogs": null,
			"SuccessMessage": "Processo executado com sucesso",
			"FailureMessage": "Falha na execução do processo",
			"SaveLogInDatabase": true,
			"StatusMessage": null,
			"WaitSchedule": false,
			"IsolateProcess": false,
			"DisableIsolateProcess": false,
			"NetworkUser": "fabio.nunes",
			"CustomData": null,
			"CanParallelize": true,
			"ShouldParallelize": false,
			"QuantityOfSplits": 0,
			"MinimumQuantityOfPrimaryKeysPerProcess": 1,
			"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
			"NotifyFluig": false,
			"NotifyEmail": false,
		}
  }
}

Image Removed

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "scheduleID": "6",
    "status": "pending",
    "scheduleDate": "26/10/2018 23:05:00",
    "executionDate": "",
    "executionID": "1",
    "user": "mestre",
    "recurrent": true,
    "daily": {
        "hour": 23,
        "minute": 1
    },
    "execution": {
        "processID": "GlbCopyPermisUsrProc",
        "status": "pending",
        "scheduleDate": "26/10/2018 23:05:00",
        "executionDate": "",
        "executionID": "1",
        "scheduleID": "6",
        "user": "mestre",
        "recurrent": true,
        "executionParameter": {
            "SourceUsuario": "mestre",
            "RemoveOldPermissions": false,
            "CopyToAllApplications": true,
            "CodSistema": "G",
            "NewUser": {
                "Usuario": "testepost",
                "Nome": "testepost",
                "Senha": "totvs",
                "Email": "testepost",
                "codAcesso": "Acesso01",
                "UsuariodeRede": ""
            },
            "Initialized": true,
            "PrimaryKeyList": [],
            "PrimaryKeyNames": null,
            "PrimaryKeyTableName": null,
            "OnlineMode": false,
            "SyncExecution": false,
            "HideProgressDialog": false,
            "SaveParamsExecution": false,
            "CodUsuario": "mestre",
            "Context": {
                "$id": "1",
                "_params": {
                    "$EXERCICIOFISCAL": -1,
                    "$CODLOCPRT": -1,
                    "$CODTIPOCURSO": -1,
                    "$EDUTIPOUSR": "-1",
                    "$CODUNIDADEBIB": -1,
                    "$CODCOLIGADA": 1,
                    "$RHTIPOUSR": "-1",
                    "$CODIGOEXTERNO": "-1",
                    "$CODSISTEMA": "G",
                    "$CODUSUARIOSERVICO": "",
                    "$CODUSUARIO": "mestre",
                    "$IDPRJ": -1,
                    "$CHAPAFUNCIONARIO": "-1",
                    "$CODFILIAL": -1
                },
                "Environment": 1
            },
            "UserName": "mestre",
            "ConnectionId": null,
            "ConnectionString": null,
            "DriverType": null,
            "Ip": "10.31.4.57",
            "HostName": "BHD050100279",
            "JobServerHostName": "BHD050100279",
            "ActionName": "GlbActionProcCopyPermisUsr",
            "MasterActionName": "GlbUsuarioAction",
            "ActionModule": "G",
            "JobID": {
                "ID": 6,
                "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": "",
            "CustomData": null,
            "CanParallelize": true,
            "ShouldParallelize": false,
            "QuantityOfSplits": 0,
            "MinimumQuantityOfPrimaryKeysPerProcess": 1,
            "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
            "NotifyFluig": false,
            "NotifyEmail": false,
            "NotifyEmailList": null
        }
    }
}

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo Postman

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
}

...

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

Image Removed

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
  "scheduleDate": "2018-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,
					"$CODLOCPRT": -1,
					"$CODTIPOCURSO": -1,
					"$EDUTIPOUSR": "-1",
					"$CODUNIDADEBIB": -1,
					"$CODCOLIGADA": 1,
					"$RHTIPOUSR": "-1",
					"$CODIGOEXTERNO": "-1",
					"$CODSISTEMA": "G",
					"$CODUSUARIOSERVICO": "",
					"$CODUSUARIO": "mestre",
					"$IDPRJ": -1,
					"$CHAPAFUNCIONARIO": "-1",
					"$CODFILIAL": -1
				},
				"Environment": 1
			},
			"UserName": "mestre",
			"ConnectionId": null,
			"ConnectionString": null,
			"DriverType": null,
			"Ip": "10.31.4.57",
			"HostName": "BHD050100279",
			"JobServerHostName": "BHD050100279",
			"ActionName": "GlbActionProcCopyPermisUsr",
			"MasterActionName": "GlbUsuarioAction",
			"ActionModule": "G",
			"JobID": {
				"ID": 1,
				"ExecID": 1,
				"IsPriorityJob": false,
				"Children": []
			},
			"ShowReExecuteButton": true,
			"ExecutionId": "7dba5874-a296-43bc-89fd-ab853121feec",
			"ProcessName": "Cópia de Permissões de Usuários",
			"ServerName": "GlbCopyPermisUsrProc",
			"ServiceInterface": null,
			"Scheduler": 1,
			"UseJobMonitor": true,
			"ScheduleDateTime": "2018-10-25T12:04:31.8719316-03:00",
			"CanSendMail": false,
			"CanWaitSchedule": false,
			"SendMail": false,
			"FriendlyLogs": null,
			"SuccessMessage": "Processo executado com sucesso",
			"FailureMessage": "Falha na execução do processo",
			"SaveLogInDatabase": true,
			"StatusMessage": null,
			"WaitSchedule": false,
			"IsolateProcess": false,
			"DisableIsolateProcess": false,
			"NetworkUser": "fabio.nunes",
			"CustomData": null,
			"CanParallelize": true,
			"ShouldParallelize": false,
			"QuantityOfSplits": 0,
			"MinimumQuantityOfPrimaryKeysPerProcess": 1,
			"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
			"NotifyFluig": false,
			"NotifyEmail": false,
		}
  }
}

Image Removed

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

...

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/glb/v1/jobScheduler/{JobID}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8050

Idjob: 106124

Url Utilizada: http://localhost:8051/api/glb/v1/jobScheduler/106124

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

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

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 36

Nova versão 37

Chave