Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All
     
     

    Get All Attachments for an End Customer Case

    Use this API to get all the attachments from an end customer case if cases are associated with the end customer case.

    URI

    https://[host]/api/juniper/servicenow/endcustomer-case-management/cases/{id}/ associatedAttachments/ (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the end-customer case for which information about attachments is to be retrieved

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.case-management.attachments+xml;version=1
    • application/vnd.juniper.servicenow.case-management.attachments+json;version=1

    Response Elements

    Element

    Type

    Description

    uri

    String

    Uri of the attachment

    id

    Integer

    ID of the attachment

    attachmentName

    String

    Name of the attachment

    size

    Integer

    Size of the attachment in bytes

    readStatus

    String

    Status of reading the attachment on the device

    Possible values:

    • Success
    • Failed

    remarks

    String

    Remarks, if any, about reading the attachments

    uploadStatus

    String

    Status of uploading the attachment to JSS.

    Possible values:

    • Uploaded
    • Not Uploaded

    Sample Output

    Sample XML Output

    <attachments uri="/api/juniper/servicenow/endcustomer-case-management/cases/169794/associatedAttachments">
    <attachment id="169829">
    <attachmentName>
    /var/tmp/srx-650-sn-20170604-063112599_ondemand_ais_jdc_196639.xml.gz
    </attachmentName>
    <size>1376</size>
    <readStatus>Success</readStatus>
    <remarks/>
    <uploadStatus>Not Uploaded</uploadStatus>
    </attachment>
    <attachment id="169832">
    <attachmentName>
    srx-650-sn-20170604-063144566_196639_attach_shd_xml.gz
    </attachmentName>
    <size>608</size>
    <readStatus>Success</readStatus>
    <remarks/>
    <uploadStatus>Not Uploaded</uploadStatus>
    </attachment>
    </attachments>
    

    Sample JSON Output

    {{
      "attachments": {
        "@uri": "/api/juniper/servicenow/endcustomer-case-management/cases/169794/associatedAttachments",
        "attachment": [
          {
            "@id": "169829",
            "attachmentName": "/var/tmp/srx-650-sn-20170604-063112599_ondemand_ais_jdc_196639.xml.gz",
            "size": 1376,
            "readStatus": "Success",
            "remarks": "",
            "uploadStatus": "Not Uploaded"
          },
          {
            "@id": "169832",
            "attachmentName": "srx-650-sn-20170604-063144566_196639_attach_shd_xml.gz",
            "size": 608,
            "readStatus": "Success",
            "remarks": "",
            "uploadStatus": "Not Uploaded"
          }
        ]
      }
    }
    
     
     

    Modified: 2017-07-18