CustomerObfuscateStatusPage Class Reference

More...

Detailed Description

Get Obfuscate Request Status

Overview

This API allows users to retrieve the status of a CSV file obfuscate request.

Since

12.6(1) ES2

APIs

Method	URL	Description
GET	/ws/v1/core/bulk/{id}	Initiate an obfuscate on customers identified by CSV file.

Permissions

One of the following are required:

• If logged in user is a partition user, the user must have one of following privileges: 'View partition resources', 'Manage partition resources'.
• If logged in user is a department, the user must have created the bulk request, identified by the ID path parameter.

Licenses

• If logged in user is a department user, the user must have any of the User Licenses.
• If logged in user is a system or global user, any of the User Licenses must be installed.

Request

Request headers

Name	Description	Allowed values	Default value
X-egain-session	Session ID obtained from Login API response header	N/A	N/A
Accept	Content type accepted by client	application/xml or application/json	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	default system language

Path parameters

Name	Description	Allowed values	Default value
id	The CSV obfuscate request ID	N/A	N/A

Query parameters

Name	Description	Allowed values	Default value
$attribute	Whether all or only successful entries to be returned	all or successful	all

Response

Response headers

Response headers

Name	Description	Possible values
X-egain-session	Session ID of the current user session	N/A
Content-Type	Media type of response body	application/xml or application/json

HTTP status codes

Success Status codes

200 - OK

• Successfully got the status of a CSV file obfuscate request.

Failure Status codes

400 - Bad Request

• Unsupported query parameter(s) supplied.
• Unsupported value for query parameter(s) provided in the request body.
• Required query parameter(s) missing in the request body.

401 - Unauthorized

• X-egain-session request header is missing.
• Session is invalid or expired.

403 - Forbidden

• The user does not have sufficient permissions. Refer Permissions section for details.

500 - Internal server error

Examples:

Example 1 - Get status of CSV file customer obfuscate request

---