UploadAttachment

Read Complete Release Notes

Use the following API to upload an attachment to an incident or IM Rules template. Specify different parameters in the API Request Payload to upload attachment for standard, custom and multi-valued attachment attributes.

To authenticate the below API, see API Authentication and Authorization.

Service Name	HTTP Method
Summit_UploadAttachment	POST

Scenario 1: Standard Attachment Attribute

Sample Request

{
    "ServiceName": "Summit_UploadAttachment",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "abc@xyz.com"
        },
        "eModule": "IM",
        "TicketID": 30751,
        "FileByte": [
            101,
            114,
            116,
            101,
            114,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101
        ],
        "AttachmentFileName": "IMattachment.txt"
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
eModule	STRING	The eModule for Standard attachment attribute will be IM.	TRUE
Ticket ID	INTEGER	To upload an attachment in the Standard attachment attribute, mention the Ticket ID in the Request API Payload.	TRUE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Uploaded Successfully",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "3FB3B6FADB0B1C332B9715F4B9284A2CC7CEEF10CC0022DC97C268E5B106AD87A411CE964CF0B9E45ED7891CA7069EBEF892D56F4DA15F911851AA4C38BA8E6EB29F115732863C382E5F53F9398C4152354B540CA749744CE3C53A47CF55777B209135E10D009D183E3DBA11AA9EFE606810ADE0214C940A4C7B01BF69CEFEABF92610DD2950975BAECEECBEAE53E143",
    "Priority": null,
    "ResolutionDeadLine": null,
    "Resolution_DeadLine": null,
    "SLA": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 0,
    "TicketNo": 0
}

Scenario 2: Custom Attribute

Sample Request

{
    "ServiceName": "Summit_UploadAttachment",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "abc@xyz.com"
        },
        "eModule": "IM_Dynamic",
        "TicketID": 30751,
        "AttributeID": "782",
        "FileByte": [
            101,
            114,
            116,
            101,
            114,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101
        ],
        "AttachmentFileName": "IMattachment.txt"
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
eModule	STRING	The eModule for Custom attachment attribute will be IM_Dynamic.	TRUE
Ticket ID	INTEGER	To upload an attachment in the Custom attachment attribute, mention the Ticket ID in the Request API Payload.	TRUE
Attribute ID	INTEGER	To upload an attachment in the Custom attachment attribute, mention the Attribute ID in the Request API Payload.	TRUE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Uploaded Successfully",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "3FB3B6FADB0B1C332B9715F4B9284A2CC7CEEF10CC0022DC97C268E5B106AD87A411CE964CF0B9E45ED7891CA7069EBEF892D56F4DA15F911851AA4C38BA8E6EB29F115732863C382E5F53F9398C4152354B540CA749744CE3C53A47CF55777B209135E10D009D183E3DBA11AA9EFE606810ADE0214C940A4C7B01BF69CEFEABF92610DD2950975BAECEECBEAE53E143",
    "Priority": null,
    "ResolutionDeadLine": null,
    "Resolution_DeadLine": null,
    "SLA": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 0,
    "TicketNo": 0
}

Scenario 3: Multi-value Attachment Attribute

Sample Request

{
    "ServiceName": "Summit_UploadAttachment",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "abc@xyz.com"
        },
        "eModule": "IM_Dynamic",
        "TicketID": 30751,
        "AttributeID": "777",
        "rowid": "5",
        "FileByte": [
            101,
            114,
            116,
            101,
            114,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            101,
            114,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101,
            116,
            114,
            101
        ],
        "AttachmentFileName": "IMattachment.txt"
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
eModule	STRING	The eModule for Custom attachment attribute will be IM_Dynamic.	TRUE
Ticket ID	INTEGER	To upload an attachment in the Custom attachment attribute, mention the Ticket ID in the Request API Payload.	TRUE
Attribute ID	INTEGER	To upload an attachment in the Custom attachment attribute, mention the Attribute ID in the Request API Payload.	TRUE
Row ID	INTEGER	Mention the Row ID in Request API Payload to upload an attachment in Multi-valued custom attribute.	TRUE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Uploaded Successfully",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "3FB3B6FADB0B1C332B9715F4B9284A2CC7CEEF10CC0022DC97C268E5B106AD87A411CE964CF0B9E45ED7891CA7069EBEF892D56F4DA15F911851AA4C38BA8E6EB29F115732863C382E5F53F9398C4152354B540CA749744CE3C53A47CF55777B209135E10D009D183E3DBA11AA9EFE606810ADE0214C940A4C7B01BF69CEFEABF92610DD2950975BAECEECBEAE53E143",
    "Priority": null,
    "ResolutionDeadLine": null,
    "Resolution_DeadLine": null,
    "SLA": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 0,
    "TicketNo": 0
}