getGroup #

Gets a group model.

By default, the metadata of the metadata referential used by the model are resolved: their { "referential": true } marker in metadataMappings is replaced by the referential mappings, and their metadataDetails and defaultMetadata are merged over the current referential values. Use rawModel to get the stored document as is, e.g. to edit the model.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/device-manager/models/group/:model
Method: GET

Other protocols #

{
  "controller": "device-manager/models",
  "action": "getGroup",
  "model": "<group model>",

  // optional:
  "rawModel": false
}

Arguments #

• model: group model
• rawModel: optional, false by default. If true, returns the stored model without resolving its referential metadata

Response #

{
  "status": 200,
  "error": null,
  "controller": "device-manager/models",
  "action": "getGroup",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<modelId>",
    "_source": {
      // Group model content
    },
  }
}