Histórico da Página

...

Informações

icon	false
title	Post

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Propriedades obrigatórias:

firstExecution, processID, recurrent, executionParameter

executionParameter: UserName, Context, ProcessName, PrimaryKeyList, PrimaryKeyNames, processStartDate, processEndDate, completeInvoicing

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 67

Nova versão 68

Chave