Skip to content

MetaData API

The Meta API stores typed metadata for any object and can be used as generic key-value storage.

REST API

Set metadata

Creates or updates metadata for an object identified by meta_remote_source and meta_remote_uuid.

HTTP
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl -X POST {{host}}/api/core/meta/set/{{meta_remote_source}}/{{meta_remote_uuid}}/{{meta_name}} \
  -H "Authorization: Token {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
    "meta_price": 34.3,
    "meta_text": "text=3233",
    "meta_date": "2023-01-01",
    "meta_number": 12.2,
    "meta_objectid": "55e0a1d1-0e71-ef11-95b4-d89d6719e0ce",
    "meta_quantity": 12.2,
    "meta_locationid": "55e0a1d1-0e71-ef11-95b4-d89d6719e0cb"
  }'
  • Parameters can be sent in the JSON body (recommended) or as a query string.
  • meta_remote_uuid is the object identifier in the remote system. If you pass the empty GUID 00000000-0000-0000-0000-000000000000, it is resolved to the current user ID.

Get metadata

Returns metadata for the specified object.

HTTP
1
2
curl {{host}}/api/core/meta/get/{{meta_remote_source}}/{{meta_remote_uuid}}/{{meta_name}} \
  -H "Authorization: Token {{token}}"
  • meta_name is optional. When omitted, all metadata for the object is returned.
  • meta_remote_uuid follows the same empty-GUID behavior described above.

Remove metadata

Deletes a metadata record by its unique identifier.

HTTP
1
2
curl -X DELETE {{host}}/api/core/meta/remove/{{meta_uuid}} \
  -H "Authorization: Token {{token}}"

Business objects

  • [app].[meta_set]

Data properties

  • [app].[meta]
    • meta_uuid - unique identifier
    • meta_remote_source, meta_remote_uuid, meta_name - composite key
    • meta_text, meta_date, meta_number, meta_status, meta_objectid, meta_quantity, meta_price, meta_locationid - stored values
    • meta_created_at, meta_created_by, meta_modified_at, meta_modified_by - audit fields