Not logged in : Login
(Sponging disallowed)

About: EntryPoint - user_customFields_set     Goto   Sponge   NotDistinct   Permalink

An Entity of Type : schema:EntryPoint, within Data Space : www.openlinksw.com associated with source document(s)
QRcode icon
http://www.openlinksw.com/describe/?url=http%3A%2F%2Fwww.openlinksw.com%2FDAV%2FVAD%2Fwa%2FAPI_user.ttl%23action_user.customFields.set

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.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). property 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 myCustomField. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes. value 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. fields A JSON stream of custom fields. This needs to be a JSON object containing simple key/value pairs (see below for an example). Example: http://web.ods.openlinksw.com/ods/api/user.udpate.customFields?property=myField&value=Foobar&property=myOtherField&value=42 JSON Example: { "myField":"Foobar", "myOtherField":42 } An error code stating the success of the command execution as detailed in ODS Error Result Codes. AuthenticationThis function requries authentication via one of the supported authentication methods as described in ODS Authentication.

AttributesValues
description
  • 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.

    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).

  • property

    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 myCustomField. In that case ODS will use a default namespace as a prefix. Qnames will be expanded for all known prefixes.

  • value

    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.

  • fields

    A JSON stream of custom fields. This needs to be a JSON object containing simple key/value pairs (see below for an example).

Example: http://web.ods.openlinksw.com/ods/api/user.udpate.customFields?property=myField&value=Foobar&property=myOtherField&value=42

JSON Example: { "myField":"Foobar", "myOtherField":42 }

An error code stating the success of the command execution as detailed in ODS Error Result Codes.

Authentication

This function requries authentication via one of the supported authentication methods as described in ODS Authentication.

title
  • EntryPoint - user_customFields_set
url
type
isWebServiceOf
hasParameter
contentType
  • text/xml
httpMethod
  • GET
oplwebservices:endPointURL
schema:shortDescription
  • Add and modify custom field values to an ODS user profile.

is target of
Faceted Search & Find service v1.17_git122 as of Jan 03 2023


Alternative Linked Data Documents: iSPARQL | ODE     Content Formats:   [cxml] [csv]     RDF   [text] [turtle] [ld+json] [rdf+json] [rdf+xml]     ODATA   [atom+xml] [odata+json]     Microdata   [microdata+json] [html]    About   
This material is Open Knowledge   W3C Semantic Web Technology [RDF Data] Valid XHTML + RDFa
OpenLink Virtuoso version 08.03.3330 as of Apr 5 2024, on Linux (x86_64-generic-linux-glibc25), Single-Server Edition (30 GB total memory, 26 GB memory in use)
Data on this page belongs to its respective rights holders.
Virtuoso Faceted Browser Copyright © 2009-2024 OpenLink Software