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": {
"_paramsHostName": {"HOST",
"appliedMatrixCodeList": [
"$CODCOLIGADA": 1,
21,
"$CODFILIAL": 125,
"$CODTIPOCURSO": 1,26
],
"$CODUSUARIOappliedMatrixCampusCodeList": "mestre",[
"21|1",
"$CODSISTEMA": "S"
"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 |
|---|
| {},
"ProcessNameprocessID": "VinculoEduVinculaTabelaPrecoMatrizAplicadaData",
Matriz Aplicada e Campus/Polo""recurrent": false,
"UserNameexecutionParameter": "mestre",{
"PrimaryKeyListContext": [{
["_params": {
"$CODCOLIGADA"1|1|6"
: 1,
]"$CODFILIAL": 1,
],
"PrimaryKeyNames$CODTIPOCURSO": [
1,
"$CODUSUARIO": "internalIdmestre",
],
"HostName$CODSISTEMA": "HOSTS",
"appliedMatrixCodeList": [ }
},
21,
"ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
25"UserName": "mestre",
26"PrimaryKeyList": [
],
[
"appliedMatrixCampusCodeList": [
"211|1|6",
"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": { "PrimaryKeyNames": [
"internalId"
],
"HostName": "HOST",
"appliedMatrixCodeList": [
21,
25,
26
],
"ContextappliedMatrixCampusCodeList": {[
"_params": {21|1",
"25|1"
"$CODCOLIGADA": 1,
]
}
} |
|
|
| 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": "105783",
"$CODFILIALstatus": 1"active",
"lastModified": "2025-02-17T18:40:27-03:00",
"processId": "EduVinculaTabelaPrecoMatrizAplicadaData",
"$CODTIPOCURSOfirstExecution": 1"2025-02-17T18:40:00-03:00",
"$CODUSUARIO"user": "mestre",
"recurrent": false,
"executionParameter": {
"$CODSISTEMAappliedMatrixCodeList": "S"[
}
21,
}25,
"ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",26
"UserName": "mestre"],
"PrimaryKeyListappliedMatrixCampusCodeList": [
[
"21|1",
"125|1|6"
],
]"CodColigada": 0,
"PrimaryKeyNamesCodFilial": [
0,
"internalId"
]CodTipoCurso": 0,
"HostNameInitialized": "HOST"false,
"appliedMatrixCodeListPrimaryKeyList": [
21,[
25, "1|1|6"
26]
],
"appliedMatrixCampusCodeListPrimaryKeyNames": [
"21|1internalId",
],
"25|1"
"PrimaryKeyTableName": null,
]"OnlineMode": false,
}
} |
|
| | 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 |
|---|
| {
"jobScheduleIdSyncExecution": "105783"false,
"statusHideProgressDialog": "active",
false,
"lastModifiedSaveParamsExecution": "2025-02-17T18:40:27-03:00"false,
"processIdCodUsuario": "EduVinculaTabelaPrecoMatrizAplicadaDatamestre",
"firstExecutionContext": "2025-02-17T18:40:00-03:00",{
"user "$id": "mestre1",
"recurrent": false,
"executionParameter_params": {
"appliedMatrixCodeList$CODFILIAL": [1,
21 "$CODSISTEMA": "S",
25 "$CODCOLIGADA": 1,
26"$CODUSUARIO": "mestre",
],
"appliedMatrixCampusCodeList$CODTIPOCURSO": [1
"21|1"},
"25|1"Environment": 0
]},
"CodColigadaUserName": 0"mestre",
"CodFilialConnectionId": 0null,
"CodTipoCursoConnectionString": 0null,
"InitializedDriverType": falsenull,
"PrimaryKeyListIp": [null,
"HostName": "",
[
"JobServerHostName": "BHN050104619",
"1|1|6"ActionName": null,
"MasterActionName": null,
]
]"ActionModule": null,
"PrimaryKeyNamesJobID": [{
"internalIdID": 105783,
],
"PrimaryKeyTableNameExecID": null1,
"OnlineModeIsPriorityJob": false,
"SyncExecutionChildren": false,[]
"HideProgressDialog": false},
"SaveParamsExecutionShowReExecuteButton": falsetrue,
"CodUsuarioExecutionId": "mestref414352f-fe43-444c-a437-80cb6390388e",
"ContextProcessName": {
"Vinculo Matriz Aplicada e Campus/Polo",
"$idServerName": "1"null,
"_params"ServiceInterface": {null,
"Scheduler": 1,
"$CODFILIALUseJobMonitor": 1true,
"ScheduleDateTime": "2025-02-17T18:40:26-03:00",
"$CODSISTEMACanSendMail": "S"false,
"CanWaitSchedule": false,
"$CODCOLIGADASendMail": 1false,
"FriendlyLogs": null,
"$CODUSUARIOSuccessMessage": "mestreProcesso executado com sucesso",
"FailureMessage": "Falha na execução do "$CODTIPOCURSO": 1
processo",
}"SaveLogInDatabase": true,
"EnvironmentStatusMessage": 0null,
"WaitSchedule": }false,
"UserNameIsolateProcess": "mestre"false,
"ConnectionIdDisableIsolateProcess": nullfalse,
"ConnectionStringNetworkUser": null"",
"DriverTypeCustomData": null,
"IpCanParallelize": nullfalse,
"HostNameShouldParallelize": ""false,
"JobServerHostNameQuantityOfSplits": "BHN050104619"0,
"ActionNameMinimumQuantityOfPrimaryKeysPerProcess": null1,
"MasterActionNameMaximumQuantityOfPrimaryKeysPerProcess": null1000,
"ActionModuleNotifyFluig": nullfalse,
"JobIDNotifyEmail": {false,
"IDNotifyEmailList": 105783,null
}
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de resultado negativo |
|---|
| | Expandir |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | Ver resultado JSON... |
|---|
| linenumbers | true |
|---|
| {
"ExecIDCode": 1"FE016",
"Message": "O corpo da mensagem contém valores inválidos.",
"IsPriorityJobDetailMessage": false"",
"HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
"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 |
|---|
| | Expandir |
|---|
| | 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
} |
|
