{"__v":1,"_id":"55b5eba1f8105a2f00c34d50","category":{"__v":3,"_id":"55afb085f202b12100cd9e83","pages":["55b5e167c2e909190073eaff","55b5e1f16127b12500364227","55b5e433c2e909190073eb01"],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:02:29.010Z","from_sync":false,"order":14,"slug":"field","title":"Field"},"parentDoc":null,"project":"559a61d2dbcfd20d00710b39","user":"55a54dde9c32760d00ca78a8","version":{"__v":23,"_id":"559a61d2dbcfd20d00710b3c","project":"559a61d2dbcfd20d00710b39","createdAt":"2015-07-06T11:09:06.510Z","releaseDate":"2015-07-06T11:09:06.510Z","categories":["559a61d3dbcfd20d00710b3d","55a589ddaaf9cf1900114dd0","55a589e30f354f0d00fd0312","55a589ea80c8a30d00b323cc","55a589f6aaf9cf1900114dd1","55a58d4e80c8a30d00b323e6","55a8e7a227a17d21005251a2","55a93098cf45e1390093f351","55afb085f202b12100cd9e83","55afb22e902fd51700f5f8bf","55afb260902fd51700f5f8c2","55afb28ec8a85321007a5462","55afb294f202b12100cd9e95","55afb29b902fd51700f5f8c5","55afb2a1c8a85321007a5463","55afb2a7902fd51700f5f8c7","55afb2ad902fd51700f5f8c8","55afb2b5902fd51700f5f8ca","55b74b2131bccb190081bedc","55bb441b54f9640d006e6cf2","565711085cb2420d00d70071","5681681330018c0d006bf7ff","588f38b5923d610f00c72dad"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Version 1.0","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-27T08:28:17.406Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Field Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Obligatory?\",\n    \"h-3\": \"Description\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Name of the field.\",\n    \"1-0\": \"type.name\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Yes\",\n    \"1-3\": \"Type of the field.\",\n    \"2-0\": \"type.operators.op\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Name of the operation.\",\n    \"3-0\": \"type.operators.displayName\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Yes\",\n    \"3-3\": \"Displayed name of the operation.\",\n    \"4-0\": \"hidden\",\n    \"4-1\": \"boolean\",\n    \"4-2\": \"Yes\",\n    \"4-3\": \"Whether the field is visible or not.\",\n    \"5-0\": \"displayName\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Yes\",\n    \"5-3\": \"Displayed name of the field.\",\n    \"6-0\": \"index\",\n    \"6-1\": \"integer\",\n    \"6-2\": \"Yes\",\n    \"6-3\": \"Index of the fueld, used for sorting.\",\n    \"7-0\": \"category\",\n    \"7-1\": \"string\",\n    \"7-2\": \"Yes\",\n    \"7-3\": \"Category of the field.\",\n    \"8-0\": \"allowFreeInput\",\n    \"8-1\": \"boolean\",\n    \"8-2\": \"Yes\",\n    \"8-3\": \"Whether free input values are allowed for this field.\",\n    \"9-0\": \"custom\",\n    \"9-1\": \"boolean\",\n    \"9-2\": \"Yes\",\n    \"9-3\": \"Whether this field is custom.\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Field Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"lang\\\",\\n  \\\"type\\\": {\\n    \\\"name\\\": \\\"string\\\",\\n    \\\"operators\\\": [\\n      {\\n        \\\"op\\\": \\\"eq\\\",\\n        \\\"displayName\\\": \\\"is equal to\\\"\\n      },\\n      {\\n        \\\"op\\\": \\\"ne\\\",\\n        \\\"displayName\\\": \\\"is not equal to\\\"\\n      },\\n      {...}\\n    ]\\n  },\\n  \\\"hidden\\\": false,\\n  \\\"displayName\\\": \\\"Language\\\",\\n  \\\"index\\\": 0,\\n  \\\"category\\\": \\\"user\\\",\\n  \\\"allowFreeInput\\\": false,\\n  \\\"custom\\\": false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Events and entities contains attributes represented as key-value pairs. The value can be a single (scalar) value (eg a string, integer, date), or a nested structure like an array or an object.\n\nWhen queried, attributes become fields. A field is similar to a column in a table in a relational database. The mapping for each field has a field type (not to be confused with event or entity type) which indicates the type of data that can be stored in that field, eg integer, string, object.","slug":"field","type":"basic","title":"Fields"}

Fields

Events and entities contains attributes represented as key-value pairs. The value can be a single (scalar) value (eg a string, integer, date), or a nested structure like an array or an object. When queried, attributes become fields. A field is similar to a column in a table in a relational database. The mapping for each field has a field type (not to be confused with event or entity type) which indicates the type of data that can be stored in that field, eg integer, string, object.

[block:api-header] { "type": "basic", "title": "The Field Object" } [/block] [block:parameters] { "data": { "0-0": "name", "h-0": "Name", "h-1": "Type", "h-2": "Obligatory?", "h-3": "Description", "0-1": "string", "0-2": "Yes", "0-3": "Name of the field.", "1-0": "type.name", "1-1": "string", "1-2": "Yes", "1-3": "Type of the field.", "2-0": "type.operators.op", "2-1": "string", "2-2": "Yes", "2-3": "Name of the operation.", "3-0": "type.operators.displayName", "3-1": "string", "3-2": "Yes", "3-3": "Displayed name of the operation.", "4-0": "hidden", "4-1": "boolean", "4-2": "Yes", "4-3": "Whether the field is visible or not.", "5-0": "displayName", "5-1": "string", "5-2": "Yes", "5-3": "Displayed name of the field.", "6-0": "index", "6-1": "integer", "6-2": "Yes", "6-3": "Index of the fueld, used for sorting.", "7-0": "category", "7-1": "string", "7-2": "Yes", "7-3": "Category of the field.", "8-0": "allowFreeInput", "8-1": "boolean", "8-2": "Yes", "8-3": "Whether free input values are allowed for this field.", "9-0": "custom", "9-1": "boolean", "9-2": "Yes", "9-3": "Whether this field is custom." }, "cols": 4, "rows": 10 } [/block] [block:api-header] { "type": "basic", "title": "Sample Field Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"lang\",\n \"type\": {\n \"name\": \"string\",\n \"operators\": [\n {\n \"op\": \"eq\",\n \"displayName\": \"is equal to\"\n },\n {\n \"op\": \"ne\",\n \"displayName\": \"is not equal to\"\n },\n {...}\n ]\n },\n \"hidden\": false,\n \"displayName\": \"Language\",\n \"index\": 0,\n \"category\": \"user\",\n \"allowFreeInput\": false,\n \"custom\": false\n}", "language": "json" } ] } [/block]