The following table provides the input and output information for QnA operations:
|
Operation (Function Used)
|
Input Required
|
Expected Output
|
|
Creating credential
(create())
|
- User name (userName).
- (Optional) Organization name (orgName).
- List of questions and answers (question and answer).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential. If it is not passed, then the default profile for the organization is used. If it is passed, then the profile name must be available at the organization.
- (Optional) Custom attributes that you have maintained for each credential in your application.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting credential (resetCredentail())
|
- User name (userName).
- (Optional) Organization name (orgName).
- List of questions and answers (question and answer).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential. If it is not passed, then the default profile for the organization is used. If it is passed, then the profile name must be available at the organization.
|
- CredentialDetails
- TransactionDetails
|
|
Fetching credential (fetch())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Fetching credential configuration (fetchQnAConfiguration())
|
- (Optional) Organization name (orgName).
- (Optional) Profile name of the credential. If it is not passed, then the default profile for the organization is used. If it is passed, then the profile name must be available at the organization.
- (Optional) Additional Input (AdditionalInput).
|
- QnAConfiguration
- TransactionDetails
|
|
Fetching credential configuration (fetchQnAConfiguration())
|
- (Optional) Organization name (orgName).
- (Optional) Profile name of the credential. If it is not passed, then the default profile for the organization is used. If it is passed, then the profile name must be available at the organization.
- (Optional) Additional Input (AdditionalInput).
- Questions to fetch (fetchQuestions)
|
- QnAConfiguration
- TransactionDetails
- questions
|
|
Reissuing credential (reissue())
|
- User name (userName).
- (Optional) Organization name (orgName).
- List of questions and answers (question and answer).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting credential validity (resetValidity())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- Time when the validity of the credential ends (validityEndTimeEx).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Resetting custom attributes (resetNotes())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Disabling credential (disable())
|
- User name (userName).
- (Optional) Organization name (orgName).
- (Optional) Additional Input (AdditionalInput).
- (Optional) Profile name of the credential.
|
- CredentialDetails
- TransactionDetails
|
|
Enabling credential (enable())
|
|
Deleting credential (delete())
|