
Hi there,
In-line with our recent update, we've introduced an update with the Sessions API and released 15 new endpoints for developers.
Sessions API
In the Sessions API, cron_expression is now legacy and will be replaced with interval_unit and interval_value .
This update also added the following fields in the Session API:
-
days_of_week -
recurrence_end_type -
recurrence_end_date -
excluded_dates -
timezone
For the Timezone, we suggest selecting any of these timezones for optimal performance:
"UTC",
"America/New_York",
"America/Chicago",
"America/Denver",
"America/Los_Angeles",
"Europe/London",
"Europe/Paris",
"Europe/Berlin",
"Asia/Tokyo",
"Asia/Shanghai",
"Australia/Sydney",
New API Endpoints
The following API Endpoints are now able to be used with a Developer API key. For full documentation, please refer here: https://api.hyra.io/docs/#/ for now.
Assignments
| Get All Assignments for Workspace | GET | /workspace/assignments/{workspaceId} |
| Create new Assignments | PUT | /workspace/assignments/{workspaceId} |
| Update Assignment | PATCH | /workspace/assignments/{workspaceId}/{assignmentId} |
| Delete Assignment | DELETE | /workspace/assignments/{workspaceId}/{assignmentId} |
Labels
| Get All Assignments for Workspace | GET | /workspace/assignments/{workspaceId} |
| Create new Assignments | PUT | /workspace/assignments/{workspaceId} |
| Update Assignment | PATCH | /workspace/assignments/{workspaceId}/{assignmentId} |
| Delete Assignment | DELETE | /workspace/assignments/{workspaceId}/{assignmentId} |
Role Groups
| Create Session Role Group | POST | /workspace/sessions/roles/{workspaceId} |
| Update Roles in Session Role Group | POST | /workspace/sessions/roles/{workspaceId}/{groupId} |
| Create Role in Session Role Group | POST | /workspace/sessions/roles/{workspaceId}/{groupId}/create |
| Delete Session Group | DELETE | /workspace/sessions/roles/{workspaceId}/groups/{groupId} |
| Update Session Group Position | POST | /workspace/sessions/roles/{workspaceId}/groups/batch/priority |
| Retrieve Session Groups | GET | /workspace/sessions/roles/{workspaceId} |
| Archive/Unarchive Group | PATCH | /workspace/sessions/roles/{workspaceId}/{groupId}/archive |
That's all for today's update! We wish you all the best in updating your new and improved systems using the new API endpoints we've released.
Cheers,
Sam