Detailed Description

Get Activity Attachments

Overview

This API allows the user to get details for all attachments belonging to a specific activity.

Since: 11.6.0.3

APIs

Method	URL	Description
GET	`/ws/v12/interaction/activity/{ID}/attachment`	Retrieve attachments belong to activity with ID: {ID}

Authentication

Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.

Permissions

All of the following are required:

'View Agent Console' action
All requested activities must belong to either the user's home department, or to the department where the user is a foreign user

Licenses

The logged in user must have the following licenses:

Any User Licenses

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`

Supported API specific query parameters

NONE

Supported common query parameters

NONE

Response

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`

Response body xml schemas:

schema-interaction-Attachments - used in case of success
schema-kb-WSError - used in case of error

Summary attributes

Summary attributes of Attachment Resource

HTTP status codes

Success Status codes:

200 (OK)

This response code is returned if the request is successful

204 (No content)

No attachments exist for the valid activity ID

Failure Status codes:

400 (Bad request)

Any query parameter is sent in the request

401 (Unauthorized)

X-egain-session header is missing
Session is invalid

403 (Forbidden)

The user does not have the appropriate permissions for this information

404 (Not found)

Activity ID is not provided in the URI
Activity ID supplied in the URI doesn't exist

500 (Internal server error)

There are any other errors while processing the request.

Examples:

Example 1 - Get all attachments for an activity