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}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Request Parameters - Additional Information

  • Article
  • 2 minutes to read

Request Parameters - Additional Information

questionFieldMap

The questionFieldMap input parameter enables the population of any of the available 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 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 questionFieldMap 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
}

connectionMap

The connectionMap input parameter enables the association of the request being created with users and contacts in the form of Request Connections.

The input is of type xs:string, but the API expects a string representation of a JSON array of objects, with key-value pairs in each object. The following example, when provided as a string to the connectionMap input parameter, would add two connections to the newly created request:

[
  {
    "connectionType": "connection.impacted",
    "userType": "account",
    "userId": "change",
    "comment": "I am impacted"
  },
  {
    "connectionType": "connection.interested",
    "userType": "contact",
    "userId": "42"
  }
]

The keys available to the connection objects are:

  • connectionType - Mandatory - Type: xs:string - The type of connection. Values to use can be found in the requestConnectionType Simple List.
  • userType - Mandatory - Type: xs:string - Can be account or contact, depending on whether the user being associated as a connection is a user of the Hornbill platform (basic or full), or an externally-supported organization contact.
  • userId - Mandatory - Type: xs:string - The ID of the user.
  • comment - Optional - Type: xs:string - A comment to associate to the connection.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document