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

Application API / chatbotUpdateReqCustomFields

  • Article
  • 20 minutes to read

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Global
  • Class: Application
  • Required Privilege Level: user
  • Required Rights: Group H - executeSystemAPIs

Description

This operation updates custom fields against a Request. For use with chatbot integrations.

Request Parameters

The chatbotUpdateReqCustomFields API takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Required Description
requestId xs:string Yes This parameter must be set with the Id of a Request.
userId xs:string Yes This parameter must be set with the Id of the chatbot session user.
h_custom_a xs:string No The value that is written to the h_custom_a field.
h_custom_b xs:string No The value that is written to the h_custom_b field.
h_custom_c xs:string No The value that is written to the h_custom_c field.
h_custom_d xs:string No The value that is written to the h_custom_d field.
h_custom_e xs:string No The value that is written to the h_custom_e field.
h_custom_f xs:string No The value that is written to the h_custom_f field.
h_custom_g xs:string No The value that is written to the h_custom_g field.
h_custom_h xs:string No The value that is written to the h_custom_h field.
h_custom_i xs:string No The value that is written to the h_custom_i field.
h_custom_j xs:string No The value that is written to the h_custom_j field.
h_custom_k xs:string No The value that is written to the h_custom_k field.
h_custom_l xs:string No The value that is written to the h_custom_l field.
h_custom_m xs:string No The value that is written to the h_custom_m field.
h_custom_n xs:string No The value that is written to the h_custom_n field.
h_custom_o xs:string No The value that is written to the h_custom_o field.
h_custom_p xs:string No The value that is written to the h_custom_p field.
h_custom_q xs:string No The value that is written to the h_custom_q field.
h_custom_r xs:string No The value that is written to the h_custom_r field.
h_custom_s xs:string No The value that is written to the h_custom_s field.
h_custom_t xs:string No The value that is written to the h_custom_t field.
h_custom_21 xs:dateTime No The value that is written to the h_custom_21 field.
h_custom_22 xs:dateTime No The value that is written to the h_custom_22 field.
h_custom_23 xs:dateTime No The value that is written to the h_custom_23 field.
h_custom_24 xs:dateTime No The value that is written to the h_custom_24 field.
h_custom_25 xs:dateTime No The value that is written to the h_custom_25 field.
h_custom_26 xs:integer No The value that is written to the h_custom_26 field.
h_custom_27 xs:integer No The value that is written to the h_custom_27 field.
h_custom_28 xs:integer No The value that is written to the h_custom_28 field.
h_custom_29 xs:integer No The value that is written to the h_custom_29 field.
h_custom_30 xs:integer No The value that is written to the h_custom_30 field.
h_custom_31 xs:string No The value that is written to the h_custom_31 field.
h_custom_32 xs:string No The value that is written to the h_custom_32 field.
h_custom_33 xs:string No The value that is written to the h_custom_33 field.
h_custom_34 xs:string No The value that is written to the h_custom_34 field.
h_custom_35 xs:string No The value that is written to the h_custom_35 field.
h_custom_36 xs:string No The value that is written to the h_custom_36 field.
h_custom_37 xs:string No The value that is written to the h_custom_37 field.
h_custom_38 xs:string No The value that is written to the h_custom_38 field.
h_custom_39 xs:string No The value that is written to the h_custom_39 field.
h_custom_40 xs:string No The value that is written to the h_custom_40 field.
h_custom_41 xs:string No The value that is written to the h_custom_41 field.
h_custom_42 xs:string No The value that is written to the h_custom_42 field.
h_custom_43 xs:string No The value that is written to the h_custom_43 field.
h_custom_44 xs:string No The value that is written to the h_custom_44 field.
h_custom_45 xs:string No The value that is written to the h_custom_45 field.
h_custom_46 xs:string No The value that is written to the h_custom_46 field.
h_custom_47 xs:string No The value that is written to the h_custom_47 field.
h_custom_48 xs:string No The value that is written to the h_custom_48 field.
h_custom_49 xs:string No The value that is written to the h_custom_49 field.
h_custom_50 xs:string No The value that is written to the h_custom_50 field.
h_custom_51 xs:string No The value that is written to the h_custom_51 field.
h_custom_52 xs:string No The value that is written to the h_custom_52 field.
h_custom_53 xs:string No The value that is written to the h_custom_53 field.
h_custom_54 xs:string No The value that is written to the h_custom_54 field.
h_custom_55 xs:string No The value that is written to the h_custom_55 field.
h_custom_56 xs:string No The value that is written to the h_custom_56 field.
h_custom_57 xs:string No The value that is written to the h_custom_57 field.
h_custom_58 xs:string No The value that is written to the h_custom_58 field.
h_custom_59 xs:string No The value that is written to the h_custom_59 field.
h_custom_60 xs:string No The value that is written to the h_custom_60 field.
h_custom_61 xs:string No The value that is written to the h_custom_61 field.
h_custom_62 xs:string No The value that is written to the h_custom_62 field.
h_custom_63 xs:string No The value that is written to the h_custom_63 field.
h_custom_64 xs:string No The value that is written to the h_custom_64 field.
h_custom_65 xs:string No The value that is written to the h_custom_65 field.
h_custom_66 xs:string No The value that is written to the h_custom_66 field.
h_custom_67 xs:string No The value that is written to the h_custom_67 field.
h_custom_68 xs:string No The value that is written to the h_custom_68 field.
h_custom_69 xs:string No The value that is written to the h_custom_69 field.
h_custom_70 xs:string No The value that is written to the h_custom_70 field.
h_custom_71 xs:integer No The value that is written to the h_custom_71 field.
h_custom_72 xs:integer No The value that is written to the h_custom_72 field.
h_custom_73 xs:integer No The value that is written to the h_custom_73 field.
h_custom_74 xs:integer No The value that is written to the h_custom_74 field.
h_custom_75 xs:integer No The value that is written to the h_custom_75 field.
h_custom_76 xs:dateTime No The value that is written to the h_custom_76 field.
h_custom_77 xs:dateTime No The value that is written to the h_custom_77 field.
h_custom_78 xs:dateTime No The value that is written to the h_custom_78 field.
h_custom_79 xs:dateTime No The value that is written to the h_custom_79 field.
h_custom_80 xs:dateTime No The value that is written to the h_custom_80 field.
resumeBpmProcess xs:boolean No If the workflow running on the request should be resumed, defaults to 'false'.

Response Parameters

Name Type Description
outcome xs:string This parameter is set with the outcome of the operation. The options are "success" and "failure".
error xs:string This parameter is set with validation errors.

Code Examples

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document