HydraCore
API by router

Scheduled actions

List Schedules

GET
/v1/schedules

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

customer_id?Customer Id
external_id?External Id
status?Status
limit?Limit
Default50
Range1 <= value <= 200
offset?Offset
Default0
Range0 <= value

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/schedules?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&external_id=string&status=string&limit=50&offset=0" \  -H "X-Api-Key: string"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Schedule

POST
/v1/schedules

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

action_after_completion?Action After Completion
Default"NONE"
action_configAction Config

Empty Object

action_typeAction Type
catchup_window_minutes?Catchup Window Minutes
Default10
Range0 <= value <= 1440
customer_id?Customer Id
deduplication_key?Deduplication Key
description?Description
end_at?End At
external_id?External Id
flexible_window_minutes?Flexible Window Minutes
Default0
Range0 <= value <= 60
max_retries?Max Retries
Default3
Range0 <= value <= 10
nameName
Lengthlength <= 200
overlap_policy?Overlap Policy
Default"SKIP"
pause_on_failure_count?Pause On Failure Count
Default5
Range1 <= value <= 100
rate_limit_per_minute?Rate Limit Per Minute
relative_entity_definition_id?Relative Entity Definition Id

Entity definition to query

relative_field_name?Relative Field Name

Date field to compute offset from

relative_filter?Relative Filter

Optional filter conditions on entity records

relative_offset_days?Relative Offset Days

Days before (-) or after (+) the field date

retry_backoff_seconds?Retry Backoff Seconds
Default60
Range0 <= value
schedule_expression?Schedule Expression
schedule_typeSchedule Type
start_at?Start At
timezone?Timezone
Default"UTC"
Lengthlength <= 50

Response Body

curl -X POST "https://loading/v1/schedules" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "action_config": {},    "action_type": "string",    "name": "string",    "schedule_type": "string"  }'
{
  "action_config": {},
  "action_type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "description": "string",
  "external_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_run_at": "2019-08-24T14:15:22Z",
  "last_run_status": "string",
  "name": "string",
  "next_run_at": "2019-08-24T14:15:22Z",
  "overlap_policy": "string",
  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",
  "relative_field_name": "string",
  "relative_filter": {},
  "relative_offset_days": 0,
  "run_count": 0,
  "schedule_expression": "string",
  "schedule_type": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "timezone": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Schedule

GET
/v1/schedules/{schedule_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "action_config": {},
  "action_type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "description": "string",
  "external_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_run_at": "2019-08-24T14:15:22Z",
  "last_run_status": "string",
  "name": "string",
  "next_run_at": "2019-08-24T14:15:22Z",
  "overlap_policy": "string",
  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",
  "relative_field_name": "string",
  "relative_filter": {},
  "relative_offset_days": 0,
  "run_count": 0,
  "schedule_expression": "string",
  "schedule_type": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "timezone": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Schedule

DELETE
/v1/schedules/{schedule_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X DELETE "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Schedule

PUT
/v1/schedules/{schedule_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

action_config?Action Config
catchup_window_minutes?Catchup Window Minutes
description?Description
flexible_window_minutes?Flexible Window Minutes
max_retries?Max Retries
name?Name
overlap_policy?Overlap Policy
rate_limit_per_minute?Rate Limit Per Minute
schedule_expression?Schedule Expression
status?Status
timezone?Timezone

Response Body

curl -X PUT "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "action_config": {},
  "action_type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "description": "string",
  "external_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_run_at": "2019-08-24T14:15:22Z",
  "last_run_status": "string",
  "name": "string",
  "next_run_at": "2019-08-24T14:15:22Z",
  "overlap_policy": "string",
  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",
  "relative_field_name": "string",
  "relative_filter": {},
  "relative_offset_days": 0,
  "run_count": 0,
  "schedule_expression": "string",
  "schedule_type": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "timezone": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Pause Schedule

POST
/v1/schedules/{schedule_id}/pause

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X POST "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause" \  -H "X-Api-Key: string"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Resume Schedule

POST
/v1/schedules/{schedule_id}/resume

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X POST "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume" \  -H "X-Api-Key: string"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Schedule Runs

GET
/v1/schedules/{schedule_id}/runs

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Query Parameters

limit?Limit
Default20
Range1 <= value <= 100
offset?Offset
Default0
Range0 <= value

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs?limit=20&offset=0" \  -H "X-Api-Key: string"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Trigger Schedule

Force immediate execution of a schedule (ignores next_run_at).

POST
/v1/schedules/{schedule_id}/trigger

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

schedule_idSchedule Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X POST "https://loading/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/trigger" \  -H "X-Api-Key: string"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Safetyculture

Previous Page

Scheduled actions internal

Next Page