{"_id":"582789abbe5c080f00a5a81f","parentDoc":null,"project":"568bdc1483d2061900d86cdc","category":{"_id":"5845d13063c11b2500379681","__v":0,"version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-05T20:42:24.315Z","from_sync":false,"order":1,"slug":"platform-overview","title":"Platform Overview"},"version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"user":"568bdbc4fe6fcc0d006dc970","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-13T22:43:42.904Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nMetadata is data that provides information about other data. Metadata is useful to associate custom information with a record that is not otherwise necessary for the system to function, but is necessary for the client application to function.\n\nIn Droplit.io, metadata can be associated with nearly any record.\n\nRecords that support metadata have a `meta` field. The `meta` field can be read from and written to like any other field in the system by adding properties to it.\n\nMetadata properties are called _keys_. The key names must follow the same rules as aliases:\n - Between 1 and 24 characters\n - Only the contain characters: `a-z`, `A-Z`, `0-9`, `_`\n - No spaces\n - Keys are case-sensitive\n\nYou may create any meta field by simply writing to it with an update.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"System defined meta keys\"\n}\n[/block]\nMeta keys prefixed with a `$` are reserved for special uses.\n\nFor example: `$label` is a special meta field to assign a display name to a record. \n\n`$label` is used by the developer portal and CLI tools. You may also use it in your applications.\n\nA user of the API may specify some other character to map to the prefix instead of `$` by adding `x-system-meta-prefix` to the request header. E.g., if the value of `x-system-meta-prefix` is set to `droplit-`, the system knows to map `droplit-label` to `$label`. This is useful when a client of the API is binding the meta-data using a system where `$` already has special meaning, such as with Angular.","excerpt":"Associating custom information with a record","slug":"metadata","type":"basic","title":"Meta data"}

Meta data

Associating custom information with a record

[block:api-header] { "type": "basic", "title": "Introduction" } [/block] Metadata is data that provides information about other data. Metadata is useful to associate custom information with a record that is not otherwise necessary for the system to function, but is necessary for the client application to function. In Droplit.io, metadata can be associated with nearly any record. Records that support metadata have a `meta` field. The `meta` field can be read from and written to like any other field in the system by adding properties to it. Metadata properties are called _keys_. The key names must follow the same rules as aliases: - Between 1 and 24 characters - Only the contain characters: `a-z`, `A-Z`, `0-9`, `_` - No spaces - Keys are case-sensitive You may create any meta field by simply writing to it with an update. [block:api-header] { "type": "basic", "title": "System defined meta keys" } [/block] Meta keys prefixed with a `$` are reserved for special uses. For example: `$label` is a special meta field to assign a display name to a record. `$label` is used by the developer portal and CLI tools. You may also use it in your applications. A user of the API may specify some other character to map to the prefix instead of `$` by adding `x-system-meta-prefix` to the request header. E.g., if the value of `x-system-meta-prefix` is set to `droplit-`, the system knows to map `droplit-label` to `$label`. This is useful when a client of the API is binding the meta-data using a system where `$` already has special meaning, such as with Angular.