HSDA Meta

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

This is a HSDA service specifically intended to manage the meta data around human services data API operations. Essentially this is a logging system, providing access to data about what API calls are made, managing individual resources, as well as any other service in use association with HSDA operations.

You can also explore this using our OpenAPI viewer.

Warning

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

GET /meta/

Get Meta

Get Meta

Status Codes

200 Response Body:

Description

Type

Required
id

Each entry must have a unique identifier.

string

True
timestamp

The timestamp for entry (yyyy-mm-dd)

string

False
appid

The appid for entry.

string

False
system

The system for entry.

string

False
path

The path for entry.

string

False
verb

The verb for entry.

string

False
request_parameters

The parameters for entry.

string

False
request_headers

The header for entry.

string

False
request_body

The body for entry.

string

False
response_body

The body for entry.

string

False
status

The status of this entry (Complete, Waiting)

string

False
POST /meta/

Add Meta

Add Meta

Status Codes

200 Response Body:

Description

Type

Required
id

Each entry must have a unique identifier.

string

True
timestamp

The timestamp for entry (yyyy-mm-dd)

string

False
appid

The appid for entry.

string

False
system

The system for entry.

string

False
path

The path for entry.

string

False
verb

The verb for entry.

string

False
request_parameters

The parameters for entry.

string

False
request_headers

The header for entry.

string

False
request_body

The body for entry.

string

False
response_body

The body for entry.

string

False
status

The status of this entry (Complete, Waiting)

string

False
GET /meta/{meta_id}/

Get Meta

Get Meta

Parameters

  • meta_id (string) – The meta id.

Status Codes

200 Response Body:

Description

Type

Required
id

Each entry must have a unique identifier.

string

True
timestamp

The timestamp for entry (yyyy-mm-dd)

string

False
appid

The appid for entry.

string

False
system

The system for entry.

string

False
path

The path for entry.

string

False
verb

The verb for entry.

string

False
request_parameters

The parameters for entry.

string

False
request_headers

The header for entry.

string

False
request_body

The body for entry.

string

False
response_body

The body for entry.

string

False
status

The status of this entry (Complete, Waiting)

string

False
PUT /meta/{meta_id}/

Update Meta

Update an existing meta entry.

Parameters

  • meta_id (string) – The meta id.

Status Codes

200 Response Body:

Description

Type

Required
id

Each entry must have a unique identifier.

string

True
timestamp

The timestamp for entry (yyyy-mm-dd)

string

False
appid

The appid for entry.

string

False
system

The system for entry.

string

False
path

The path for entry.

string

False
verb

The verb for entry.

string

False
request_parameters

The parameters for entry.

string

False
request_headers

The header for entry.

string

False
request_body

The body for entry.

string

False
response_body

The body for entry.

string

False
status

The status of this entry (Complete, Waiting)

string

False