Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • GET
  • POST
  • PUT
  • DELETE

1.1 - GET

...

1.1.1 - Get All (Recuperar

...

todas as execuções de jobs realizado na base)

...

Informações
iconfalse
title1.1.1 GetAll
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo Postman

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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": ""
        }
    ]
}

...

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo 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
iconfalse
titleExemplo Postman

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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
titleParâ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
iconfalse
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

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

Informações
iconfalse
titleExemplo 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
iconfalse
titleExemplo Postman

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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
titleParâ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.

...