Human Services Data API (HSDA) - Orchestration v1.0

This is the OpenAPI definition for the Human Services Data API (HSDA) v1.2. This is a set of API paths, organized as a separate service, for managing orchestration involving any HSDA inmplementation. It is available as this HTML list or YAML OpenAPI definition, with an accompanying demo site, and link to current Github Issues for support.

Services
Services /services/ GET
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Add Service /services/ POST
Request Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Get Service /services/{service_id}/ GET
Path Parameters:
service_id: The service id.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Update Service /services/{service_id}/ PUT
Path Parameters:
service_id: The service id.
Request Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Delete Service /services/{service_id}/ DELETE
Path Parameters:
service_id: The service id.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
service (string) The service name.
path (string) The path name.
verb (string) The verb.
Events
Events /events/ GET
Reponse Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Add Event /events/ POST
Request Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Reponse Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Get Event /events/{event_id}/ GET
Path Parameters:
event_id: The event id.
Reponse Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Update Event /events/{event_id}/ PUT
Path Parameters:
event_id: The event id.
Request Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Reponse Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Delete Event /events/{event_id}/ DELETE
Path Parameters:
event_id: The event id.
Reponse Body:
id (string) Each event has unique identifier.
service (string) The name of the service the event will run against.
path (string) The path the event will run against.
verb (string) The verb the event will run against.
description (string) The description of the event.
Webhooks
Webhooks /webhooks/ GET
Reponse Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Add Webhook /webhooks/ POST
Request Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Reponse Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Get Webhook /webhooks/{webhook_id}/ GET
Path Parameters:
webhook_id: The webhook id.
Reponse Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Update Webhook /webhooks/{webhook_id}/ PUT
Path Parameters:
webhook_id: The webhook id.
Request Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Reponse Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.
Delete Webhook /webhooks/{webhook_id}/ DELETE
Path Parameters:
webhook_id: The webhook id.
Reponse Body:
id (string) Each webhook has a unique identifier.
event_id (string) The event id for this webhook.