Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de entrada 3 camadas |
|---|
| Caso a propriedade recurrent seja igual a true, obrigatoriamente deve-se informar o Tipo de Recorrência. Propriedades obrigatórias: processID, firstExecution, recurrent, executionParameter executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames
| Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
"firstExecution": "2025-02-17T18:12:00-03:00",
"recurrent": false,
"executionParameter": {
"Context": {
"_params": {
"$CODCOLIGADA": 1,
"$CODFILIAL": 1,
"$CODTIPOCURSO": 1,
"$CODUSUARIO": "mestre",
"$CODSISTEMA": "S"
}
},
"ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
"UserName": "mestre",
"PrimaryKeyList": [
[
"1|1|6"
]
],
"PrimaryKeyNames": [
"internalId"
],
"HostName": "HOST",
"appliedMatrixCodeList": [
21,
25,
26
],
"appliedMatrixCampusCodeList": [
"21|1",
"25|1"
]
}
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de entrada ambiente local |
|---|
| 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. Propriedades obrigatórias: processID, recurrent, executionParameter executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames
| Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
"recurrent": false,
"executionParameter": {
"Context": {
"_params": {
"$CODCOLIGADA": 1,
"$CODFILIAL": 1,
"$CODTIPOCURSO": 1,
"$CODUSUARIO": "mestre",
"$CODSISTEMA": "S"
}
},
"ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
"UserName": "mestre",
"PrimaryKeyList": [
[
"1|1|6"
]
],
"PrimaryKeyNames": [
"internalId"
],
"HostName": "HOST",
"appliedMatrixCodeList": [
21,
25,
26
],
"appliedMatrixCampusCodeList": [
"21|1",
"25|1"
]
}
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de resultado positivo |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Ver resultado JSON... |
|---|
| linenumbers | true |
|---|
| {
"jobScheduleId": "105783",
"status": "active",
"lastModified": "2025-02-17T18:40:27-03:00",
"processId": "EduVinculaTabelaPrecoMatrizAplicadaData",
"firstExecution": "2025-02-17T18:40:00-03:00",
"user": "mestre",
"recurrent": false,
"executionParameter": {
"appliedMatrixCodeList": [
21,
25,
26
],
"appliedMatrixCampusCodeList": [
"21|1",
"25|1"
],
"CodColigada": 0,
"CodFilial": 0,
"CodTipoCurso": 0,
"Initialized": false,
"PrimaryKeyList": [
[
"1|1|6"
]
],
"PrimaryKeyNames": [
"internalId"
],
"PrimaryKeyTableName": null,
"OnlineMode": false,
"SyncExecution": false,
"HideProgressDialog": false,
"SaveParamsExecution": false,
"CodUsuario": "mestre",
"Context": {
"$id": "1",
"_params": {
"$CODFILIAL": 1,
"$CODSISTEMA": "S",
"$CODCOLIGADA": 1,
"$CODUSUARIO": "mestre",
"$CODTIPOCURSO": 1
},
"Environment": 0
},
"UserName": "mestre",
"ConnectionId": null,
"ConnectionString": null,
"DriverType": null,
"Ip": null,
"HostName": "",
"JobServerHostName": "BHN050104619",
"ActionName": null,
"MasterActionName": null,
"ActionModule": null,
"JobID": {
"ID": 105783,
"ExecID": 1,
"IsPriorityJob": false,
"Children": []
},
"ShowReExecuteButton": true,
"ExecutionId": "f414352f-fe43-444c-a437-80cb6390388e",
"ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
"ServerName": null,
"ServiceInterface": null,
"Scheduler": 1,
"UseJobMonitor": true,
"ScheduleDateTime": "2025-02-17T18:40:26-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": false,
"ShouldParallelize": false,
"QuantityOfSplits": 0,
"MinimumQuantityOfPrimaryKeysPerProcess": 1,
"MaximumQuantityOfPrimaryKeysPerProcess": 1000,
"NotifyFluig": false,
"NotifyEmail": false,
"NotifyEmailList": null
}
} |
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de resultado negativo |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Ver 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
} |
|
|
|
