Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Request Parameters - Additional Information

  • Article
  • 1 minutes to read

Request Parameters - Additional Information

customFields

The customFields input parameter enables the update of any of the custom fields against your request records.

The input is of type xs:string, but the API expects a string representation of a JSON object, with key-value pairs for each custom field needing updating, where they keys are the database field names and the values are in their native datatypes. The following example, when provided as a string to the customFields input parameter, would prompt the API to update the h_custom_a, h_custom_p, h_custom_21 and h_custom_26 fields angainst the target request:

{
  "h_custom_a": "A VARCHAR(255) string to be written into h_custom_a",
  "h_custom_p": "A LONGTEXT string to be written into h_custom_p",
  "h_custom_21": "2023-11-01 15:07:42",
  "h_custom_26": 42
}
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document