This HTML5 document contains 12 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:set

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n5:isWebServiceOf

n6:this_ODSUserModuleAPI

n5:endPointURL

n4:set

schema:shortDescription

<p>Add and modify custom field values to an ODS user profile. </p>

n5:hasParameter

n7:_value n7:_fields n7:_property

schema:name

EntryPoint - user_customFields_set

schema:description

<p>ODS allows to store any additional details in a user profile. This is simply done by storing the data in a private graph of the Virtuoso triple store.</p><p>Clients can provide as many custom fields as required, ie. repeat the parameters below an arbitrary number of times. Alternatively custom fields can be provided in JSON format (see below for an example).</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>property</parametername> </parameternamelist> <parameterdescription> <p>The field name. The property to store typically this is a full URL denoting the RDF property to use. It can, however, also be a simple string identifier like <computeroutput>myCustomField</computeroutput>. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>value</parametername> </parameternamelist> <parameterdescription> <p>The value of the property. By default all values are stored as strings. If the value can be converted into an integer then it is stored as such. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>fields</parametername> </parameternamelist> <parameterdescription> <p>A JSON stream of custom fields. This needs to be a JSON object containing simple key/value pairs (see below for an example).</p></parameterdescription> </li> </ul> <bold>Example:</bold> <programlisting><codeline><highlight class="normal"><sp />http:</highlight><highlight class="comment">//web.ods.openlinksw.com/ods/api/user.udpate.customFields?property=myField&amp;value=Foobar&amp;property=myOtherField&amp;value=42</highlight></codeline> </programlisting></p><p><bold>JSON</bold> Example: <programlisting><codeline><highlight class="normal"><sp />{</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /></highlight><highlight class="stringliteral">"myField"</highlight><highlight class="normal">:<sp /></highlight><highlight class="stringliteral">"Foobar"</highlight><highlight class="normal">,</highlight></codeline> <codeline><highlight class="normal"><sp /><sp /><sp /></highlight><highlight class="stringliteral">"myOtherField"</highlight><highlight class="normal">:<sp />42</highlight></codeline> <codeline><highlight class="normal"><sp />}</highlight></codeline> </programlisting></p><p><simplesect kind="return"><p>An error code stating the success of the command execution as detailed in <ref kindref="member" refid="ods_response_format_1ods_response_format_result_code">ODS Error Result Codes</ref>.</p></simplesect> <simplesect kind="par"><title>Authentication</title><p>This function requries authentication via one of the supported authentication methods as described in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref>. </p></simplesect> </p>

schema:url

n4:set