Schema

/schema

Retrieves current schema.

• rights: schema, get, publish
• verbs: GET
• parameters: none
• returns: JSON [{},...] representing the list of properties that make up the environment schema.

curl

curl https://test-m1.minusonedb.com/schema \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 schema

▶200 OKEnvironment schema

{
  "_m1rand": {
    "large": false,
    "name": "_m1rand",
    "description": "Random number assigned at publish time used for sampling use cases.",
    "type": "double",
    "required": true,
    "multi": false
  },
  "myTags": {
    "large": false,
    "name": "myTags",
    "description": "Represents important tags.",
    "type": "string",
    "required": false,
    "multi": true
  },
  "_m1key": {
    "large": false,
    "name": "_m1key",
    "description": "Unique identifier across an environment.",
    "type": "integer",
    "required": true,
    "multi": false
  },
  "myBoolean": {
    "large": false,
    "name": "myBoolean",
    "type": "boolean",
    "required": false
  }
}

/schema/add

Add properties to the environment schema. Can be called as many times as desired to add new property definitions.

• rights: schema
• verbs: POST

Parameter	Type	Required
properties	property[]	Yes

Each property is a map with the following keys:

Key	Type	Required
name	String	Yes
type	String	Yes. One of: string, text, integer, double, date.
multi	boolean	No. Default false. If true the property can contain multiple values.
description	String	No. Default null. Comment describing property, purely for informational purposes.

curl

curl https://test-m1.minusonedb.com/schema/add \
-d 'properties=[
    {
        "name": "myTags",
        "type": "string",
        "multi": true,
        "description": "Represents important tags."
    },
    {
        "name": "myBoolean",
        "type": "boolean"
    }
]' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 schema/add -properties '[
    {
        "name": "myTags",
        "type": "string",
        "multi": true,
        "description": "Represents important tags."
    },
    {
        "name": "myBoolean",
        "type": "boolean"
    }
]'

# Or load from file:
m1 test-m1 schema/add -properties @fileWithSchema.json

No response when successful.

/schema/wipe

Deletes all user defined properties in the environment schema. Note that this does not modify data that has already been written to the data lake.

• rights: schema
• verbs: POST
• parameters: none

curl

curl -X POST https://test-m1.minusonedb.com/schema/wipe \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 schema/wipe/

No response when successful.