HSDA Orchestration

The HSDA orchestration protocol is defined by openapi-hsda-orchestration.yaml. The details below show the available methods and responses.

This is a HSDA sevice specifically intended to manage orchestration around HSDA operations, enabling the system to become a two-way street, pushing data outside individual implementations. The system uses webhooks, and events to understand changes made to the HSDA system, and the data stored within.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /services/

Services

The services being used across ochestration.

Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
service
  The service name. string False
path
  The path name. string True
verb
  The verb. string True
POST /services/

Add Service

Add Service

Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
service
  The service name. string False
path
  The path name. string True
verb
  The verb. string True
GET /services/{service_id}/

Get Service

Get Service

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
service
  The service name. string False
path
  The path name. string True
verb
  The verb. string True
PUT /services/{service_id}/

Update Service

Update an existing service.

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
service
  The service name. string False
path
  The path name. string True
verb
  The verb. string True
DELETE /services/{service_id}/

Delete Service

Delete Service

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
service
  The service name. string False
path
  The path name. string True
verb
  The verb. string True
GET /events/

Events

The are the events that can occur.

Status Codes:

200 Response Body:

  Description Type Required
id
  Each event has unique identifier. string True
service
  The name of the service the event will run against. string True
path
  The path the event will run against. string True
verb
  The verb the event will run against. string True
description
  The description of the event. string True
POST /events/

Add Event

Add Event

Status Codes:

200 Response Body:

  Description Type Required
id
  Each event has unique identifier. string True
service
  The name of the service the event will run against. string True
path
  The path the event will run against. string True
verb
  The verb the event will run against. string True
description
  The description of the event. string True
GET /events/{event_id}/

Get Event

Get Event

Parameters:
  • event_id (string) -- The event id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each event has unique identifier. string True
service
  The name of the service the event will run against. string True
path
  The path the event will run against. string True
verb
  The verb the event will run against. string True
description
  The description of the event. string True
PUT /events/{event_id}/

Update Event

Update an existing event.

Parameters:
  • event_id (string) -- The event id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each event has unique identifier. string True
service
  The name of the service the event will run against. string True
path
  The path the event will run against. string True
verb
  The verb the event will run against. string True
description
  The description of the event. string True
DELETE /events/{event_id}/

Delete Event

Delete Event

Parameters:
  • event_id (string) -- The event id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each event has unique identifier. string True
service
  The name of the service the event will run against. string True
path
  The path the event will run against. string True
verb
  The verb the event will run against. string True
description
  The description of the event. string True
GET /webhooks/

Webhooks

The webhooks currently in operation.

Status Codes:

200 Response Body:

  Description Type Required
id
  Each webhook has a unique identifier. string True
event_id
  The event id for this webhook. string True
POST /webhooks/

Add Webhook

Add Webhook

Status Codes:

200 Response Body:

  Description Type Required
id
  Each webhook has a unique identifier. string True
event_id
  The event id for this webhook. string True
GET /webhooks/{webhook_id}/

Get Webhook

Get Webhook

Parameters:
  • webhook_id (string) -- The webhook id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each webhook has a unique identifier. string True
event_id
  The event id for this webhook. string True
PUT /webhooks/{webhook_id}/

Update Webhook

Update Webhook

Parameters:
  • webhook_id (string) -- The webhook id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each webhook has a unique identifier. string True
event_id
  The event id for this webhook. string True
DELETE /webhooks/{webhook_id}/

Delete Webhook

Delete Webhook

Parameters:
  • webhook_id (string) -- The webhook id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each webhook has a unique identifier. string True
event_id
  The event id for this webhook. string True