API: Meta information

From Yombo
Jump to: navigation, search

Overview

See also

When the results should be filtered, sorted, extended, it helps to know which items be used. The meta information end point for each resource provides this information.

Example

  <div id="curl<random_number></random_number>" class="tab-pane fade in active" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
curl \
-H "x-api-key: abc123xyz789" \
-H "authorization: Bearer Waro7g0Mwl4YBJ..." \
-X DELETE https://api.yombo.net/api/v1/commands/meta
  <div id="python<random_number></random_number>" class="tab-pane fade" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
import requests

url = 'https://api.yombo.net/api/v1/commands/meta'
headers = {
    'x-api-key': 'abc123xyz789',
    'authorization': 'Waro7g0Mwl4YBJ...',
    }

response = requests.put(url, headers=headers)
  <div id="output<random_number></random_number>" class="tab-pane fade" style="border: 1px solid #ccc; border-radius: 5px; padding: 0.7em;">
 1 {
 2     "data": {
 3         "type": "commands_meta",
 4         "id": "commands_meta",
 5         "attributes": {
 6             "sortable": [
 7                 "voice_cmd",
 8                 "machine_label",
 9                 "label",
10                 "public",
11                 "status",
12                 "created_at",
13                 "updated_at"
14             ],
15             "includable": [
16                 "users"
17             ],
18             "filterable": [
19                 "user_id",
20                 "original_user_id",
21                 "voice_cmd",
22                 "machine_label",
23                 "label",
24                 "public",
25                 "status",
26                 "created_at",
27                 "updated_at"
28             ]
29         }
30     }
31 }
This page was last edited on 12 April 2019.