Update Description - PUT /modelsnapshots/<jobId>/<snapshotId>/description

Updates the snapshot description, enabling easier administration. List snapshots in order to see currently saved snapshots and their descriptions.

Example

curl -X PUT -H 'Content-Type: application/json' 'http://localhost:8080/engine/v2/modelsnapshots/kpi_measure/1234567890/description' -d '
{
  "description" : "07MAR16_REF632_VALID"
}'

Warning

Depending upon the method used to update this field, this may need URL encoding to be applied.

Returns

Status code 200 (Ok).

If successful the API returns the updated model snapshot document, for example:

{
  "documentId" : "1234567890",
  "exists" : true,
  "type" : "modelSnapshot",
  "document" : {
    "description" : "07MAR16_REF632_VALID",
    "timestamp" : "2016-03-07T13:35:56.000+0000",
    "restorePriority" : 1457618890518,
    "snapshotId" : "1234567890",
    "snapshotDocCount" : 1,
    "modelSizeStats" : {
      "modelBytes" : 544831,
      "totalByFieldCount" : 20,
      "totalPartitionFieldCount" : 2,
      "totalOverFieldCount" : 0,
      "bucketAllocationFailuresCount" : 0,
      "memoryStatus" : "OK"
    },
    "latestRecordTimeStamp" : "2016-03-07T11:28:40.000+0000"
  }
}

Errors

See the Error Codes documentation for the full list of errors that may be returned by the API.