Get activity attachment details

Overview

Use this API to get details for a single attachment belonging to a specific activity.

Permissions

Actor Permission
User All of the following are required:
  • Must have 'View Agent Console' action on 'System' resource.
  • The requested activity must either belong to the user's home department, or to a department in which the user is a foreign user.
Client Application No additional permission required.
Customer
  • Only attachments of the activities that are visible to the customer (self, or customer sent in as query parameter) is returned. Refer 'API's for Core Case management' section for information about the activities visible to the customer.
  • If the query parameter customer={ID} is provided, the logged in customer must be authorized to perform this action on behalf of the customer specified through the "customer" query parameter. Otherwise, the application returns a 400 (bad request) response code.
    		•
    SecurityoAuthUser or oAuthClient or oAuthCustomer
    Request
    path Parameters
    ids
    required
    string <= 1500 characters

    Pass one id or comma separated list of id(s).

    Examples:
    Providing single ID.
    1001
    Providing multiple IDs.
    1001,1002
    attachmentID
    required
    string

    ID of attachment that belongs to activity with id as activityID

    Examples:
    1002
    query Parameters
    $attribute
    string

    Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

    Available values: all, contentUrl

    Examples:
    $attribute=
    Attribute 'contentUrl' is returned in server response.
    $attribute=contentUrl
    All the attributes are returned in server response.
    $attribute=all
    customer
    string
    Actor Description
    User / Client Application Not allowed.
    Customer The customer must be authorized to perform this action on behalf of the customer specified through the "customer" query parameter.
    header Parameters
    Accept
    required
    string
    Default: application/json

    Content type accepted by client.

    Enum: "application/json" "application/xml"
    Accept-Language
    required
    string
    Default: en-US

    Language locale accepted by 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"
    Responses
    200

    OK

    • The request was successfully executed.
    400

    Bad Request

    • Any unsupported query parameter is sent in the request.
    • In case actor is customer and the logged in customer does not have grants on the customer provided through the query parameter "customer".
    • In case actor is client application and activity type is not email or chat.
    401

    Unauthorized

    • In case actor is user or customer and :
      • X-egain-session request header is missing.
      • Session is invalid or expired.
    • In case actor is client application and :
      • Authorization header is not provided.
      • Authorization header format is incorrect.
      • Session does not exist corresponding to the provided authorization header.
      • The session identified through authorization header is not a client application session.
    403

    Forbidden

    • In case actor is user or customer and actor does not have sufficient permissions to view one or more of the requested resources.
    • In case actor is customer and attachment id supplied in the URI is blocked in the application.
    • In case actor is client application and client applications of type other than 'API' tries to access this API.
    404

    Not Found

    • Activity ID supplied in the URI doesn't exist.
    • Attachment ID supplied in the URI doesn't exist for the given activity.
    • In case actor is customer and activity ID supplied in the URI is not visible to the logged in customer.
    406

    Not Acceptable

    500

    Internal server error

    get/activity/{ids}/attachment/{attachmentID}
    Request samples
    Response samples
    application/json
      

    • GET /core/casemgr/v3/activity/1031/attachment/1032
      • 

    • This example demonstrates the following:
        

      • Getting details of an attachment of an activity without specifying any additional query parameters.
        • 

      

      • 

    

    {
    • "attachment": [
      ]
    }