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 End-customer Cases

    Use this API to retrieve all end-customer cases from Junos Space Service Now.

    URI

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

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.eccase-management.cases+xml;version=3
    • application/vnd.juniper.servicenow.eccase-management.cases+json;version=3

    Response

    Element

    Type

    Description

    uri

    String

    Link to the end-customer case collection

    size

    Intger

    Number of records in the collection

    case

    case

    An end-customer case

    href

    String

    Link to an individual end-customer case

    uri

    String

    URI of the end-customer case

    connectedMember

    String

    End customer for which the case was created

    caseId

    String

    ID of the end-customer case

    deviceSerialNumber

    String

    Serial number of the end-customer device for which this case was created

    caseStatus

    String

    Status of the case

    problemSynopsis

    String

    Brief description of the event that led to the creation of this case

    priority

    String

    Priority of the case

    The possible values are:

    • Critical
    • High
    • Medium
    • Low

    createTime

    String

    Date and time the case was created

    caseLink

    String

    Link to the case

    caseType

    String

    Type of case created:

    • Event—Case created for events that occurred on devices
    • Event RMA—Case created for Return Materials Authorization (RMA) events that occurred on device
    • On-demand—Case created for on-demand incidents
    • On-demand RMA—Case created for on-demand RMA incidents
    • BIOS Health Check—Case created for analyzing BIOS running on devices
    • AIS Health Check—Case created for AIS health check event on devices
    • Event (Low End)—Case created for events that occurred on low end devices, such as SRX100 or SRX220
    • Other—Case created for events not reported through Service Now

    Sample Output

    Sample XML Output

    <cases uri="/api/juniper/servicenow/endcustomer-case-management/cases" size="1">
       <case href="/api/juniper/servicenow/endcustomer-case-management/cases/3014664" uri="/api/juniper/servicenow/endcustomer-case-management/cases/3014664" key="3014664">
          <connectedMember>test</connectedMember>
          <caseId>test-123</caseId>
          <caseStatus>Created</caseStatus>
          <deviceSerialNumber>AJ4410AA0031</deviceSerialNumber>
          <problemSynopsis>Service Now on-demand case</problemSynopsis>
          <priority>Low</priority>
          <createTime>2014-12-18 10:57:16 IST</createTime>
          <caseType>On-demand</caseType>
       </case>
    </cases>
    

    Sample JSON Output

    {
      "cases": {
        "@uri": "/api/juniper/servicenow/endcustomer-case-management/cases",
        "@size": "1",
        "case": {
          "@href": "/api/juniper/servicenow/endcustomer-case-management/cases/3014664",
          "@uri": "/api/juniper/servicenow/endcustomer-case-management/cases/3014664",
          "@key": "3014664",
          "connectedMember": "test",
          "caseId": "test-123",
          "caseStatus": "Created",
          "deviceSerialNumber": "AJ4410AA0031",
          "problemSynopsis": "Service Now on-demand case",
          "priority": "Low",
          "createTime": "2014-12-18 10:57:16 IST",
          "caseType": "On-demand" 
         }
       }
    }

    Error Codes

    Message

    Description

    204 No Content

    No end-customer cases found.

    403 Forbidden

    Service Now is not running in Partner Proxy mode.

    Modified: 2016-08-11