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 User-Uploaded Attachments by Incident ID

    Use this API to retrieve details about attachments for an incident uploaded by a user to Junos Space Service Now.

    URI

    https://[host]/api/juniper/servicenow/incident-management/incidents/{id}/userUploadedAttachments (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the Incident for which details about user-uploaded attachments are to be retrieved

    Consumes

    None

    Produces

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

    Response Elements

    Element

    Type

    Description

    attachment

    attachment

    An attachment in the collection

    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 from the device

    Possible values—Success and Failure:

    remarks

    String

    Reason why Service Now could not read the attachment

    uploadStatus

    String

    Status of uploading the attachment to Juniper Support System (JSS)

    Possible values—Uploaded and Not Uploaded

    uploadedBy

    String

    User who uploaded the attachment.

    Sample Output

    Sample XML Output

    <attachments uri="/api/juniper/servicenow/incident-management/incidents/269623 /userUploadedAttachments">
    <attachment id="1048598">
    <attachmentName></attachmentName>
    <size>681</size>
    <readStatus>Success</readStatus>
    <remarks/>
    <uploadStatus>Not Uploaded</uploadStatus>
    <uploadedBy>super</uploadedBy>
    </attachment>
    </<attachments>
    

    Sample JSON Output

    {  
       "attachment":{  
          "uri":"/api/juniper/servicenow/incident-management/incidents/269623/userUploadedAttachments",
          "id":1048598,
          "attachmentName":"test.txt",
          "size":"681",
          "readStatus":"Success",
          "remarks":" ",
          "uploadStatus": "Not Uploaded ",
          "uploadedBy":"super”
               },
           }
    

    Modified: 2016-12-06