users/insert_data_value

Namespace Name Admin Only Log Summary Generates Event Version Added
users insert_data_value no no no 1

Description

Save any random data to be associated with the currently logged-in user. This is useful to save/restore a cache of user settings that might be needed by the Web UI for instance.

This is different from the “set_data” API call in that the fields within the input arguments will be added to the current user data rather than replace it. Any input objects/variables with the same name as existing fields in the user data will overwrite those fields however.

Input Arguments

  • Required:
    • “key_path” and “key_value” pairs (“/” delimiter for object path)

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "dataobject/datafield1" : "1",
  "generic_data" : "sample_field"  
}

Reply Example

{
  "namespace" : "response",
  "name" : "insert_data_value",
  "id" : "some_id",
  "args" : {
    "result" : "success",
    "data" : {
      [COPY OF CURRENT DATA OBJECT]
    }
  }
}

Changes from Example

Original saved data:

{
  "dataobject" : {
    "A" : "a"
  },
  "dataobject2" : {
    "B" : "b"
  }
}

After change from the request above:

{
  "generic_data" : "sample field",
  "dataobject": {
    "datafield1" : "1",
    "A" : "a"
  },
  "dataobject2" : {
    "B" : "b"
  }
}

Log Summary

This API call does not generate a detailed log summary item

Events

This API call does not emit any middleware events.

See Also