{"id": "json_api:json-api-shapes", "page": "json_api", "ref": "json-api-shapes", "title": "Different shapes", "content": "The  _shape  parameter can be used to access alternative formats for the\n                 rows  key which may be more convenient for your application. There are three\n                options: \n             \n                 \n                     ?_shape=objects  -  \"rows\"  is a list of JSON key/value objects - the default \n                 \n                 \n                     ?_shape=arrays  -  \"rows\"  is a list of lists, where the order of values in each list matches the order of the columns \n                 \n                 \n                     ?_shape=array  - a JSON array of objects - effectively just the  \"rows\"  key from the default representation \n                 \n                 \n                     ?_shape=array&_nl=on  - a newline-separated list of JSON objects \n                 \n                 \n                     ?_shape=arrayfirst  - a flat JSON array containing just the first value from each row \n                 \n                 \n                     ?_shape=object  - a JSON object keyed using the primary keys of the rows \n                 \n             \n             _shape=arrays  looks like this: \n             {\n  \"ok\": true,\n  \"next\": null,\n  \"rows\": [\n    [3, \"Detroit\"],\n    [2, \"Los Angeles\"],\n    [4, \"Memnonia\"],\n    [1, \"San Francisco\"]\n  ]\n} \n             _shape=array  looks like this: \n             [\n  {\n    \"id\": 3,\n    \"name\": \"Detroit\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Los Angeles\"\n  },\n  {\n    \"id\": 4,\n    \"name\": \"Memnonia\"\n  },\n  {\n    \"id\": 1,\n    \"name\": \"San Francisco\"\n  }\n] \n             _shape=array&_nl=on  looks like this: \n             {\"id\": 1, \"value\": \"Myoporum laetum :: Myoporum\"}\n{\"id\": 2, \"value\": \"Metrosideros excelsa :: New Zealand Xmas Tree\"}\n{\"id\": 3, \"value\": \"Pinus radiata :: Monterey Pine\"} \n             _shape=arrayfirst  looks like this: \n             [1, 2, 3] \n             _shape=object  looks like this: \n             {\n  \"1\": {\n    \"id\": 1,\n    \"value\": \"Myoporum laetum :: Myoporum\"\n  },\n  \"2\": {\n    \"id\": 2,\n    \"value\": \"Metrosideros excelsa :: New Zealand Xmas Tree\"\n  },\n  \"3\": {\n    \"id\": 3,\n    \"value\": \"Pinus radiata :: Monterey Pine\"\n  }\n] \n             The  object  shape is only available for queries against tables - custom SQL\n                queries and views do not have an obvious primary key so cannot be returned using\n                this format. \n             The  object  keys are always strings. If your table has a compound primary\n                key, the  object  keys will be a comma-separated string.", "breadcrumbs": "[\"JSON API\"]", "references": "[]"}