Update Session Metadata
This command updates the metadata assigned to the specified session (the contents of either the title, description, or createdby field).
Authorizations: All
Request
updateSessionMetadata sessionId title|description|createdby value |
Parameters
| Parameter | Description/Values |
|---|---|
sessionId | The ID of a HMP session. |
fieldName | The metadata field to update, either title, description or createdby |
value | The contents of the metadata field. |
Result
Success
OK |
Error
| Error | Description |
|---|---|
ERROR|010003|Expected 3 parameter(s). | Calling updateSessionMetadata requires 3 parameters. |
ERROR|010001|'Y' is not a UUID | The sessionId provided must be a UUID. |
ERROR|010001|'Z' is an invalid field name | The fieldName provided is invalid. |
ERROR|040006|Session not found | A session with UUID 'sessionId' was not found. |
ERROR|070000|Internal Server Error | Updating the session failed. Please see calypso.log for details. |
Example
updateMetadata 71edd346-2cf0-4c62-b3d3-9d457b287394 createdby Test2 OK |