PUT: Update Entity Info

Update an existing entity's info.

Request

One path param on the request representing the entity name. Body of request is a JSON document matching the enttyInfo JSON-schema

PUT /metadata/{entityName}
{entityInfo JSON document}

Response: Success

On success returns the metadata JSON document with the default version for the given entity. Note that this is not the entityInfo JSON document, it is the metadata JSON document (entity info + schema).

Response: Errors

Additional error codes:

• metadata:NoEntityName - no entity name specified
• rest-metadata:NoNameMatch - entity name on the path does not match entity name in the json document
• metadata:MissingEntityInfo - entity info does not exist and therefore cannot be updated

Sample Request

This example ensures there's an index on sandwich toppings, and a notification hook that creates events when the toppings field is updated.

PUT /metadata/sandwich
{
    "datastore": {
        "backend": "mongo",
        "collection": "sandwich",
        "datasource": "mongodata"
    },
    "defaultVersion": "0.0.66",
    "indexes": [
        {
            "fields": [
                {
                    "dir": "$asc",
                    "field": "sandwichNumber"
                }
            ],
            "name": "sandwich_sandwichNumber",
            "unique": true
        },
    ],
    "hooks": [
      {
        "name": "toppingNotificationHook",
        "actions": [
          "insert",
          "update"
        ],
        "configuration": {
          "watchProjection":[
            {
              "field":"_id",
              "include":true,
              "recursive":false
            },
            {
              "field":"toppings",
              "include":true,
              "recursive":false
            }
          ],
          "includeProjection":[ ],
          "arrayOrderingSignificant":false
        }
    } ],
    "name": "sandwich"
}