Sumário

...

Índice

exclude	Sumário

Objetivo

...

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

Para mais informações sobre consumo de Licença, Veja Aqui.

1 - Métodos

...

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

GET
POST
PUT
DELETE

Informações

icon	false
title	Observação:

A Api de JobExecution também realiza buscas pelo status do agendamento, são eles:

Sucess
Pending
Running
Failure

1.1 - GET

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

...

icon	false
title	1.1.1 GetAll

A API de JobExecution possui apenas o método GET implementado. É possível utilizar os filtros padrões da API para filtrar um registro desejado, ou utilizar a assinatura /jobExecution/{executionId} para retornar um executionId específico.

O executionId é composto por duas chaves: "jobScheduleID|execution". Por exemplo: executionId = "200047|3", esta é a chave para retornar a terceira execução do Job 200047.

...

Configuração

Informações

title
icon	false

Observação:

A Api de JobExecution também realiza buscas pelo status do agendamento, são eles:

Success
Pending
Running
Failure

1.1 - GET

...

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

...

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glbframework/v1/jobExecution

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{ "hasNext": true,

"items":

[ { "processID": "PrjConcederPermissaoAcessoProjetoProc", "status": "success", "scheduleDate": "17/11/2008 17:16:01", "executionDate":

[
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008

17:16:05",

"executionID

"user":

"

1

",

"scheduleID

"return":

"

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

Expandir

title	Ver resultado JSON...

{

"hasNext": true,

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâmetros

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

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

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

},
{
"executionId": "100002|1",
"jobScheduleId": "100002",
"status": "success",
"createdDate": "",
"startedDate": "25/11/2008 15:39:21",
"user": "",
"return": ""
},
{
"executionId": "100003|1",
"jobScheduleId": "100003",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 16:33:00",
"user": "",
"return": ""
},
{
"executionId": "100004|1",
"jobScheduleId": "100004",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:12:03",
"user": "",
"return": ""
},
{
"executionId": "100005|1",
"jobScheduleId": "100005",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:15:13",
"user": "",
"return": ""
},
{
"executionId": "100006|1",
"jobScheduleId": "100006",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:29:24",
"user": "",
"return": ""
},
{
"executionId": "100007|1",
"jobScheduleId": "100007",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:32:35",
"user": "",
"return": ""
},
{
"executionId": "100008|1",
"jobScheduleId": "100008",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:50:26",
"user": "",
"return": ""
},
{
"executionId": "100009|1",
"jobScheduleId": "100009",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 18:01:37",
"user": "",
"return": ""
},
{
"executionId": "100010|1",
"jobScheduleId": "100010",
"status": "success",
"createdDate": "",
"startedDate": "22/05/2009 17:17:12",
"user": "",
"return": ""
},
{
"executionId": "100011|1",
"jobScheduleId": "100011",
"status": "success",
"createdDate": "",
"startedDate": "22/05/2009 17:31:21",
"user": "",
"return": ""
},
{
"executionId": "100012|1",
"jobScheduleId": "100012",
"status": "success",
"createdDate": "",
"startedDate": "25/05/2009 15:55:37",
"user": "",
"return": ""
},
{
"executionId": "100013|1",
"jobScheduleId": "100013",
"status": "failure",
"createdDate": "",
"startedDate": "25/05/2009 15:58:07",
"user": "",
"error": "Não foi encontrada a consulta SQL com código \"GLOBAIS.001\"!"
},
{
"executionId": "100014|1",
"jobScheduleId": "100014",
"status": "success",
"createdDate": "",
"startedDate": "25/05/2009 17:55:33",
"user": "",
"return": ""
},
{
"executionId": "100015|1",
"jobScheduleId": "100015",
"status": "failure",
"createdDate": "",
"startedDate": "25/05/2009 19:01:33",
"user": "",
"error": "Não é possível enviar um e-Mail sem que o endereço do remetente seja informado. Por favor preencha o e-mail da Coligada, no Cadastro de Coligadas."
},
{
"executionId": "100016|1",
"jobScheduleId": "100016",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 09:59:01",
"user": "",
"return": ""
},
{
"executionId": "100017|1",
"jobScheduleId": "100017",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 10:44:11",
"user": "",
"return": ""
},
{
"executionId": "100018|1",
"jobScheduleId": "100018",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 10:45:11",
"user": "",
"return": ""
},
{
"executionId": "100018|2",
"jobScheduleId": "100018",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 10:45:21",
"user": "",
"return": ""
},
{
"executionId": "100019|1",
"jobScheduleId": "100019",
"status": "success",
"createdDate": "",
"startedDate": "26/05/2009 10:46:01",
"user": "",
"return": ""
}
]
}

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâmetros

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

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

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

Informações

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: jobScheduleId

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?order=jobScheduleId

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{

"hasNext": true,
"items": [
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008 17:16:05",
"user": "",
"return": ""
},
{
"executionId": "100002|1",
"jobScheduleId": "100002",
"status": "success",
"createdDate": "",
"startedDate": "25/11/2008 15:39:21",
"user": "",
"return": ""
},
{
"executionId": "100003|1",
"jobScheduleId": "100003",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 16:33:00",
"user": "",
"return": ""
},
{
"executionId": "100004|1",
"jobScheduleId": "100004",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:12:03",
"user": "",
"return": ""
},
{
"executionId": "100005|1",
"jobScheduleId": "100005",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:15:13",
"user": "",
"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/jobExecution?order=[-]{campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: processID

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/jobExecution?order=processID

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{ "hasNext": true, "items": [ { "processID": "BibAtualizarSitBibliotecaData", "status": "success", "scheduleDate": "22/05/2009 17:17:10", "executionDate": "22/05/2009 17:17:12", "executionID": "1", "scheduleID": "100010", "user": "", "recurrent": false, "executionParameter": { "SitBiblioteca": [ { "CodColigada": 1, "CodFilial": 1, "CodUnidade": 5, "usuarioBiblios": "mestre", "CodReserva": null, "InternalId": null } ], "UsuariosExpirados": [], "Initialized": false, "PrimaryKeyList": [], "PrimaryKeyNames": null, "PrimaryKeyTableName": null, "OnlineMode": false, "SyncExecution": false, "HideProgressDialog": false, "SaveParamsExecution": false, "CodUsuario": null, "Context": { "$id": "1", "_params": {}, "Environment": 0 }, "UserName": "mestre", "ConnectionId": null, "ConnectionString": null, "DriverType": null, "Ip": "10.31.5.165", "HostName": "RM004899", "JobServerHostName": "RM004899", "ActionName": "BibAtualizarSitBibliotecaAction", "MasterActionName": null, "ActionModule": "L", "JobID": { "ID": -1, "ExecID": -1, "IsPriorityJob": false, "Children": [] }, "ExecutionId": "9a47e0c3-f9f3-4ec2-9742-d09afb57a60f", "ProcessName": "Atualizar situação da biblioteca", "ServerName": "BibAtualizarSitBibliotecaData", "ServiceInterface": null, "Scheduler": 2, "UseJobMonitor": false, "ScheduleDateTime": "2009-05-22T17:17:05.763045-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": "" } ]

}

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: processID jobScheduleId

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glbframework/v1/jobExecution?order=-processIDjobScheduleId

Informações

icon	false
title	Exemplo Postman

Image Removed

Informações

icon	false
title	Exemplo de Resultado

{

"hasNext":

true,

"items":

[ { "processID": "SmtTipoRelatorioGerarModeloPPRAServer", "status": "success", "scheduleDate": "13/04/2011 10:45:30", "executionDate": "13/04/2011 10:45:30", "executionID": "1", "scheduleID": "101654", "user": "Denise", "recurrent": false, "executionParameter": "", "return": "" }, { "processID": "SmtTipoRelatorioGerarModeloPPRAServer", "status": "success", "scheduleDate": "11/10/2011 09:00:27", "executionDate": "11/10/2011 09:00:27", "executionID": "1", "scheduleID": "102014", "user": "Bartira", "recurrent": false, "executionParameter": { "Initialized": true, "PrimaryKeyList": [ [ 1, 1 ] ], "PrimaryKeyNames": [ "CODCOLIGADA", "CODTIPO" ], "PrimaryKeyTableName": null, "OnlineMode": false, "SyncExecution": false, "HideProgressDialog": false, "SaveParamsExecution": false, "CodUsuario": "Bartira", "Context": { "$id": "2", "_params": {}, "Environment": 1 }, "UserName": "Bartira", "ConnectionId": null, "ConnectionString": null, "DriverType": null, "Ip": "10.31.6.172", "HostName": "T000000486", "JobServerHostName": "T000000486", "ActionName": "SmtTipoRelatorioGerarModeloPPRAAction", "MasterActionName": "SmtTipoRelatorioAction", "ActionModule": "V", "JobID": { "ID": 102014, "ExecID": 1, "IsPriorityJob": false, "Children": null }, "ExecutionId": "251ed985-c9ac-4d9e-8955-e6c9d9cba50b", "ProcessName": "Gerar modelo de PPRA", "ServerName": "SmtTipoRelatorioGerarModeloPPRAServer", "ServiceInterface": null, "Scheduler": 1, "UseJobMonitor": true, "ScheduleDateTime": "2011-10-11T09:00:27.0749812-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": null, "CustomData": null, "CanParallelize": false, "ShouldParallelize": false, "QuantityOfSplits": 0, "MinimumQuantityOfPrimaryKeysPerProcess": 0, "MaximumQuantityOfPrimaryKeysPerProcess": 0, "NotifyFluig": false, "NotifyEmail": false, "NotifyEmailList": null }, "return": "" } ] }

Expandir

title	Ver resultado JSON...

{

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: success

Url Utilizada: http://localhost:8051/api/glb/v1/jobExecution?status=success

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

1.1.4 - Paginação

Informações

title	Parâmetros

Page: Página que será apresentada.

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

Exemplo: ?page=valor1&pageSize=1

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

Page: 1

PageSize: 20

Informações

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/jobExecution?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/jobExecution?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": [
        {
            "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": ""
        }
    ]
}

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: processID,status,scheduleID,executionID

Url Utilizada: http://localhost:8051/api/glb/v1/jobExecution?fields=processID,status,scheduleID,executionID

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": [
        {
            "processID": "GlbProcAssistConfigGrafico",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "100147"
        },
        {
            "processID": "RMSImpExpExportProcServer",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "100149"
        },
        {
            "processID": "GlbProcAssistConfigGrafico",
            "status": "success",
            "executionID": "2",
            "scheduleID": "100157"
        },
        {
            "processID": "GlbProcAssistConfigGrafico",
            "status": "failure",
            "executionID": "2",
            "scheduleID": "100229"
        },
        {
            "processID": "FinLanCancelamentoData",
            "status": "failure",
            "executionID": "2",
            "scheduleID": "100302"
        },
        {
            "processID": "RMSImpExpImportProcServer",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "100310"
        },
        {
            "processID": "GlbProcAssistConfigGrafico",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "100326"
        },
        {
            "processID": "MntCalcularMediaDiariaIndicadorUsoProc",
            "status": "pending",
            "executionID": "868",
            "scheduleID": "100360"
        },
        {
            "processID": "MntCalcularMediaDiariaIndicadorUsoProc",
            "status": "pending",
            "executionID": "685",
            "scheduleID": "100362"
        },
        {
            "processID": "PtoProcLancamentoBatidaPeloPlanejado",
            "status": "failure",
            "executionID": "2",
            "scheduleID": "101341"
        },
        {
            "processID": "RMSImpExpImportProcServer",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "102083"
        },
        {
            "processID": "FopRotinasLibCompetenciaProcess",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "102473"
        },
        {
            "processID": "FopRotinasLibCompetenciaProcess",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "102474"
        },
        {
            "processID": "RMSUserAnalysisSyncProcess",
            "status": "pending",
            "executionID": "4",
            "scheduleID": "102767"
        },
        {
            "processID": "RptProcGenerateReport",
            "status": "failure",
            "executionID": "1",
            "scheduleID": "102769"
        },
        {
            "processID": "RptProcGenerateReport",
            "status": "pending",
            "executionID": "1",
            "scheduleID": "102771"
        },
        {
            "processID": "RptProcGenerateReport",
            "status": "pending",
            "executionID": "1",
            "scheduleID": "102772"
        },
        {
            "processID": "FinBoletoGerarConversaoProc",
            "status": "success",
            "executionID": "1",
            "scheduleID": "102764"
        },
        {
            "processID": "MntCalcularMediaDiariaIndicadorUsoProc",
            "status": "success",
            "executionID": "866",
            "scheduleID": "100360"
        },
        {
            "processID": "MntCalcularMediaDiariaIndicadorUsoProc",
            "status": "success",
            "executionID": "867",
            "scheduleID": "100360"
        }
    ]
}

1.1.6 - GetOne (Recuperar a execução pelo SchedulerID)

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.

[
{
"executionId": "102792|1",
"jobScheduleId": "102792",
"status": "success",
"createdDate": "05/12/2018 09:50:19",
"startedDate": "05/12/2018 09:50:19",
"user": "rm",
"return": ""
},
{
"executionId": "102791|1",
"jobScheduleId": "102791",
"status": "success",
"createdDate": "04/12/2018 09:52:09",
"startedDate": "04/12/2018 09:52:10",
"user": "rm",
"return": ""
},
{
"executionId": "102790|1",
"jobScheduleId": "102790",
"status": "success",
"createdDate": "03/12/2018 16:37:33",
"startedDate": "03/12/2018 16:37:33",
"user": "rm",
"return": ""
},
{
"executionId": "102789|1",
"jobScheduleId": "102789",
"status": "success",
"createdDate": "05/10/2018 10:05:20",
"startedDate": "05/10/2018 10:05:22",
"user": "rm",
"return": ""
},
{
"executionId": "102788|1",
"jobScheduleId": "102788",
"status": "success",
"createdDate": "05/10/2018 09:55:30",
"startedDate": "05/10/2018 09:55:30",
"user": "mestre",
"return": ""
}
]
}

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/jobExecution?{campo}={valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: status

Valor: success

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?status=success

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{

"hasNext": true,
"items": [
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008 17:16:05",
"user": "",
"return": ""
},
{
"executionId": "100002|1",
"jobScheduleId": "100002",
"status": "success",
"createdDate": "",
"startedDate": "25/11/2008 15:39:21",
"user": "",
"return": ""
},
{
"executionId": "100003|1",
"jobScheduleId": "100003",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 16:33:00",
"user": "",
"return": ""
},
{
"executionId": "100004|1",
"jobScheduleId": "100004",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:12:03",
"user": "",
"return": ""
},
{
"executionId": "100005|1",
"jobScheduleId": "100005",
"status": "success",
"createdDate": "",
"startedDate": "02/12/2008 17:15:13",
"user": "",
"return": ""
}
]
}

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/jobExecution?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/jobExecution?page=1&pageSize=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{

"hasNext": true,
"items": [
{
"executionId": "100001|1",
"jobScheduleId": "100001",
"status": "success",
"createdDate": "",
"startedDate": "17/11/2008 17:16:05",
"user": "",
"return": ""
}
]
}

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/jobExecution?fields={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: status,jobScheduleId,executionId

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution?fields=status,jobScheduleId,executionId

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{

"hasNext": true,
"items": [
{
"executionId": "100360|866",
"jobScheduleId": "100360",
"status": "pending"
},
{
"executionId": "100362|682",
"jobScheduleId": "100362",
"status": "pending"
},
{
"executionId": "102767|2",
"jobScheduleId": "102767",
"status": "pending"
},
{
"executionId": "102768|2",
"jobScheduleId": "102768",
"status": "pending"
},
{
"executionId": "100157|2",
"jobScheduleId": "100157",
"status": "success"
}
]
}

1.1.6 - GetOne (Recuperar a execução pelo executionId)

...

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/jobExecution/{executionId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

executionId: 100025|3 , onde jobScheduleId = 100025 e o número da execução = 3

Url Utilizada: http://localhost:8051/api/framework/v1/jobExecution/100025|3

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

{
    "executionId": "100025|3",
    "jobScheduleId": "100025",
    "status": "success",
    "createdDate": "",
    "startedDate": "26/05/2009 11:58:29",
    "user": ""

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/jobExecution/{jobId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

JobId: 102774

Url Utilizada: http://localhost:8051/api/glb/v1/jobExecution/102774

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

{
    "processID": "FopAlterarRegAtualPFuncProcess",
    "status": "success",
    "scheduleDate": "25/10/2018 11:09:15",
    "executionDate": "25/10/2018 11:09:26",
    "executionID": "1",
    "scheduleID": "102774",
    "user": "mestre",
    "recurrent": false,
    "executionParameter": {
        "Initialized": true,
        "PrimaryKeyList": [],
        "PrimaryKeyNames": null,
        "PrimaryKeyTableName": null,
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "2",
            "_params": {
                "$EXERCICIOFISCAL": 2,
                "$CODLOCPRT": -1,
                "$CODTIPOCURSO": 1,
                "$EDUTIPOUSR": "",
                "$CODUNIDADEBIB": -1,
                "$CODCOLIGADA": 1,
                "$RHTIPOUSR": "-1",
                "$CODIGOEXTERNO": "-1",
                "$CODSISTEMA": "G",
                "$CODUSUARIOSERVICO": "",
                "$CODUSUARIO": "mestre",
                "$IDPRJ": 2,
                "$CHAPAFUNCIONARIO": "-1",
                "$CODFILIAL": 1
            },
            "Environment": 1
        },
        "UserName": "mestre",
        "ConnectionId": null,
        "ConnectionString": null,
        "DriverType": null,
        "Ip": "172.20.81.1",
        "HostName": "BHD050101853",
        "JobServerHostName": "BHD050101853",
        "ActionName": "FopAlterarRegAtualPFuncAction",
        "MasterActionName": null,
        "ActionModule": "P",
        "JobID": {
            "ID": 102774,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "60847222-fd29-4add-8d41-7d05dbd60d84",
        "ProcessName": "Manutenção do campo RegAtual na tabela PFunc",
        "ServerName": "FopAlterarRegAtualPFuncProcess",
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2018-10-25T10:09:25.1212498-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": "stella.vilaca",
        "CustomData": null,
        "CanParallelize": true,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    },
    "return": ""
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

1.1 - GET

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

1.1.2 - Order(Resultado Ordenado)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar a execução pelo SchedulerID)

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 a execução pelo executionId)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

1.1 - GET

1.1.1 - Get All (Recuperar todas as execuções de jobs realizado na base)

1.1.2 - Order(Resultado Ordenado)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.6 - GetOne (Recuperar a execução pelo SchedulerID)

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 a execução pelo executionId)