Meta API Reference

Meta resource object:

{
	"type": "meta",
	"id": "(string)",
	"attributes": {
		"resource_type": "string",
        "resource_id": "string",
        "data": {
          "meta-key": "meta value"
        }
	}
}

Writable fields

Field name	Create	Update
resource_type	required|string|min:1|max:64	not_fillable
resource_id	required|string|min:1|max:64	not_fillable
data	object	object
override	not_fillable	boolean

Filter

Filter name	Detail
resource_type	string
resource_id	string
meta	object|array

Meta Query Object

Member	Is required?	Detail
key	true	Meta key
operator	false	>, <, >=, <=, =, !=
value	false	Meta value

Meta filter can be a meta query object or an array. Below is an example of a valid meta query object:

{
  "key": "meta-key",
  "operator": ">",
  "value": "string or numeric"
}

Example

For example, if you have a meta object like below:

{
  "type": "meta",
  "id": "(string)",
  "attributes": {
    "resource_type": "example-resource-type",
    "resource_id": "example-resource-id",
    "data": {
        "example-key": "example-value",
    }
  }
}

Then you can find it with:

GET

https://[client].hiweb.io/api/meta?filter[resource_type]=example-resource-type&filter[resource_id]=example-resource-id&filter[meta]={"key":"example-key","value":"example-value"}