ElectroNeek Documentation

Esta página ainda não foi traduzida para o português, por isso é apresentada em inglês.

Get Schedule Info

This returns a specific schedule.

gethttps://api.{region}.electroneek.com/v1/orchestrator/schedule/{id}

{region} pode ser: na, cis, apac, latam, emea

Experimente

Enviado do seu navegador diretamente para a API — nada passa por este site, e o token API fica apenas nesta aba.
Parâmetros de caminho
Preencha id para enviar esta solicitação.
cURL
curl --request GET \
  --url 'https://api.na.electroneek.com/v1/orchestrator/schedule/{id}'

Autenticação

Use um token API da página Orquestrador → Integrações. Envie-o como token bearer: Authorization: Bearer <token>.

Parâmetros de caminho

NomeTipoObrigatórioDescrição
idstringsimSchedule ID

Resposta

200OK
Corpo da resposta
object
idstring

Schedule ID

workflow_idstring

ID of the workflow the schedule launches

typestring (direct, repeatable)

direct runs once, repeatable runs on a recurring period

timezoneLocationstring

IANA time zone, such as America/Sao_Paulo

paramsobject

When the schedule runs. For a direct (one-time) schedule, send only directDateTime. For a repeatable schedule, send period and the fields that period uses:

  • hourly: minutes, optional restriction
  • daily: hours, minutes, optional restriction
  • weekly: dayOfWeek, hours, minutes
  • monthly: dayNumber, hours, minutes
  • custom: hours (0 to 1000), minutes, seconds, optional restriction. Repeats at this interval, counted from when the schedule was created.
object
directDateTimestring

One-time schedules only. Local date and time in timezoneLocation, formatted YYYY-MM-DDTHH:mm:ss, without a UTC offset or Z.

periodstring (hourly, daily, weekly, monthly, custom)

Repeatable schedules only.

hoursinteger

0 to 23 (0 to 1000 for custom).

minutesinteger
secondsinteger

custom only.

dayOfWeekarray of integer

weekly only. One-element array, 0 = Sunday to 6 = Saturday.

integer
dayNumberarray of string

monthly only. One-element array with "1" to "31" or "last".

string
restrictionobject

Optional limits for hourly, daily and custom schedules. Disabled restrictions are ignored.

object
excludeDaysobject

Weekdays when the schedule doesn't run (0 = Sunday to 6 = Saturday). Excluding all seven days is rejected. Hourly, daily and custom schedules.

object
isEnabledboolean
valuearray of integer
integer
rangeStartobject

Start of the allowed daily time window. Hourly and custom schedules. Must be earlier than rangeEnd.

object
isEnabledboolean
valueobject
object
hoursinteger
minutesinteger
rangeEndobject

End of the allowed daily time window. Hourly and custom schedules.

object
isEnabledboolean
valueobject
object
hoursinteger
minutesinteger
isActiveboolean

Whether the schedule is enabled

botRunnerobject · nullable

The Bot Runner that runs this schedule. null uses the workflow's Bot Runner selection.

object
robotIdstringobrigatório

ID of a Bot Runner assigned to the workflow. An unassigned Bot Runner is rejected with 400.

busyPolicystring (queue, cancel)obrigatório

If the Bot Runner is busy: queue waits for it, cancel cancels this occurrence.

offlinePolicystring (fallback, cancel)obrigatório

If the Bot Runner is offline: fallback uses another assigned Bot Runner, cancel cancels this occurrence.

displayNamestring

Bot Runner name, set by the server.

accountEmailstring

Email of the account that created the schedule

statusstring (completed, completed-with-errors)

Result of the last execution. null before the first one.

nextRundate-time · nullable

Next occurrence, in UTC. Also calculated for disabled schedules, so check isActive.

lastRundate-time · nullable

Last execution, in UTC

lastErrorstring · nullable

Error of the last execution, if any

Exemplo de resposta
{
  "id": "663d9083ea1ba2debc1c410f",
  "workflow_id": "663d9083ea1ba2debc1c410d",
  "type": "direct",
  "timezoneLocation": "America/Sao_Paulo",
  "params": {
    "directDateTime": "2099-10-07T09:30:00"
  },
  "isActive": false,
  "botRunner": null,
  "accountEmail": "api-issuer@example.com",
  "status": null,
  "nextRun": "2099-10-07T12:30:00.000Z",
  "lastRun": null,
  "lastError": null
}
400Invalid ID or schedule parameters, or a Bot Runner that isn't assigned to the workflow

Sem corpo de resposta.

401Missing or invalid API key

Sem corpo de resposta.

403The API key's user lacks the required permission

Sem corpo de resposta.

404Workflow or schedule not found in this Orchestrator

Sem corpo de resposta.

Atualizado
Get Workflow SchedulesCreate Schedule