question Re: When to use the 'options' property for AtlasBaseTypeDefs in Archives of Support Questions (Read Only)

When to use the 'options' property for AtlasBaseTypeDefs

laura_ngo — Sun, 18 Jun 2017 21:20:51 GMT

Could someone help me understand when I would use the 'options' property? It's part of the AtlasBaseTypeDefs and has a type of 'map of string'. In the below example I can create an entity type, but I don't know how to use the 'options' property and under what circumstances I would want to.

{
   "enumDefs":[],
   "structDefs":[],
   "classificationDefs":[],
   "entityDefs":[
      {
         "superTypes":[
           "DataSet"
         ],
	"name":"test_entity_3",
	"description":"test_entity_3",
	"createdBy": "admin",
	"updatedBy": "admin",
	"options" : 
	     {
                "property1" : "when_to_use_1",
                "property2" : "when_to_use_2"
             },
         "attributeDefs":[
            {
               "name":"test_3",
               "isOptional":true,
               "isUnique":false,
               "isIndexable":false,
               "typeName":"string",
               "valuesMaxCount":1,
               "cardinality":"SINGLE",
               "valuesMinCount":0
            }
         ]
         
      }
   ]
}

Re: When to use the 'options' property for AtlasBaseTypeDefs

anaik — Mon, 19 Jun 2017 23:04:23 GMT

As per my knowledge these are only being used for UI rendering. It acts like additional metadata about the entity.

Re: When to use the 'options' property for AtlasBaseTypeDefs

ssubramanian — Tue, 20 Jun 2017 00:27:07 GMT

@Laura Ngo, "options" was added to AtlasBaseTypeDef to allow additional metadata properties to be included with the type definition. These properties allow users to specify any key/value property or constraint on the type definition e.g.

cluster = test_cluster

contains_all_primitive_attributes=true

The options map is not being used currently but added for future use cases.