Reject Solution

Overview

The Reject Solution API can be used to reject and add negative score to a solution of a Guided Help case.

Prerequisites

  • A Guided Help search session must be started before invoking this API.
SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

The ID of the portal being accessed.

A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example: PROD-1000
caseID
required
string [ 10 .. 15 ] characters ^[1-9]\d*$

The numerical ID of the Case for which details is to be fetched.

Example: 1000001085
header Parameters
x-egain-activity-id
string [ 4 .. 9 ] characters ^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237
x-ext-integration-id
string <= 40 characters ^[\w\W]+$

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
x-ext-interaction-id
string <= 40 characters ^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
Accept-Language
required
string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Example: en-US
Request Body schema: application/json
id
required
string (CasebaseReleaseId) = 15 characters ^[1-9]\d*$

The numerical ID of the Casebase Release.

name
required
string [ 1 .. 255 ] characters ^[\w\W]+$

name of the case or article

profileId
required
string (ProfileId) [ 1 .. 15 ] characters ^1$|^[1-9]\d{9,15}$

The ID of the guided help profile.
1 will always be the system profile.

Responses
201

Rating accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

415

Incorrect Content Type Header

500

Internal server error

post/portals/{portalID}/gh/cases/{caseID}/reject
Request samples
application/json
{
  • "id": "123101210000102",
  • "name": "HPE Solution Article",
  • "profileId": "100101210000002"
}
Response samples
application/json

Required query parameter is missing.

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}