Metadata Version 2
This document describes the metadata resource as implemented by the Action Network.
Note: Metadata is read only.
Sections:
- Endpoints and URL structures
- Field names and descriptions
- Links
- Scenario: Retrieving a collection of metadata resources (GET)
- POST/PUT/DELETE
Endpoints and URL structures
Endpoints:
https://actionnetwork.org/api/v2/metadata
Metadata resources live exclusively at the above endpoint.
URL Structures:
https://actionnetwork.org/api/v2/metadata/[data]
The endpoint returns a collection of all the metadata associated with your API key.
Back To Top ↑Field names and descriptions
Field names and descriptions:
Field Name | Type | Required on POST | Description |
---|---|---|---|
name | string | n/a | A human readable string identifying this system. |
Links
Link Name | Description |
---|---|
self | A link to the metadata resource. |
action_network:custom_fields | The collection of custom fields available at this endpoint. Click here for custom fields documentation. |
Related resources
Back To Top ↑Scenario: Retrieving a collection of metadata resources (GET)
Calling the metadata endpoint will reveal the endpoint where custom fields are available.
Request
GET https://actionnetwork.org/api/v2/metadata/
Header:
OSDI-API-Token: your_api_key_here
Response
200 OK
Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
"name": "Action Network",
"_links": {
"curies": [
{
"name": "osdi",
"href": "https://dev.actionnetwork.org/docs/v2/{rel}",
"templated": true
},
{
"name": "action_network",
"href": "https://dev.actionnetwork.org/docs/v2/{rel}",
"templated": true
}
],
"self": {
"href": "https://dev.actionnetwork.org/api/v2/metadata"
},
"action_network:custom_fields": {
"href": "https://dev.actionnetwork.org/api/v2/metadata/custom_fields"
}
}
}
Back To Top ↑
Scenario: POST/PUT/DELETE
Posting, putting, and deleting metadata is not allowed. Attempts will result in errors.
Back To Top ↑