Introduction

Overview

The Cisco Support Case API v3 provides a powerful, convenient, and simple way to interact with the Cisco Support Case Manager tool and aims to improve the partner and customer experience by enabling you to access case information instantly, programmatically, and in bulk.

The Cisco Support Case API is stateless, externally accessible, and delivered as a REST web service, which allows partners to build innovative case management applications and portals. Case API is available for Cisco Partner Support Service (PSS) partners.

Features

The Cisco Support Case API provides the following features:

• Includes web services that return:
• Detailed case information for specified case(s)
• Summary case information associated with the specified case(s), user ID(s), and contract ID(s)
• Supports RESTful interface.
• Supports JSON data format.

API Reference

This topic describes the methods provided by this API.

Notes:

• Pagination is supported for Get Cases By Contract Id and Get Cases By User Id; see Pagination Response Record for details on paging.
• For information on error codes returned by the API, see Error Codes.
• You can download the WADL for this API by clicking the following link: Cisco Case API v3 WADL.
• This API reference provides information related to the latest version of this API. Cisco encourages you to use the latest version of the Cisco Support APIs; however, if you use the legacy version of this API, refer to the Cisco Case API v1 Reference for details.

GET Case Summary

Returns brief information for the specified case or cases.

Request Parameters

Response Parameters

Sample Request

GET https://apix.cisco.com/case/v3/cases/case_ids/682299374?sort_by=STATUS

Sample Response

{
  "cases": [
    {
      "item_entry_id": 1,
      "user_id": "directcust4",
      "case_id": "682299374",
      "title": "SNTC : Day 2 : NOS Handover Collector Training :TARGET CORPORATION",
      "severity": "3",
      "contact_name": "CPRSMOKE TESTER",
      "status_flag": "C",
      "status": "Closed",
      "creation_date": "2017-05-09T20:08:45.000Z",
      "updated_date": "2017-05-12T18:51:54.000Z",
      "serial_number": "",
      "contract_id": "",
      "technology_name": "Smart Services Capabilities",
      "sub_technology_name": "Collector Deployment SNTC (Contract Required)",
      "rmas": [],
      "bugs": []
    }
  ],
  "count": 1
}

GET Case Details

Returns detailed information for the specified case.

Request Parameters

Response Parameters

Sample Request

GET https://apix.cisco.com/case/v3/cases/details/case_id/682299374

Sample Response

{
    "caseDetail": {
        "user_id": "DirectCust4",
        "case_id": "682299374",
        "title": "SNTC : Day 2 : NOS Handover Collector Training :TARGET CORPORATION",
        "severity": "3",
        "status": "Closed",
        "creation_date": "2017-05-09T20:08:45.000Z",
        "updated_date": "2017-05-12T18:51:54.000Z",
        "serial_number": "",
        "contract_id": "",
        "contact_user_id": "DirectCust4",
        "contact_name": "CPRSMOKE TESTER"
        "preferred_contact_method": "Email",
        "contact_email_ids": [
            "emailaddress@cisco.com"
        ],
        "contact_business_phone_numbers": [
            "31-1248789/2001"
        ],
        "contact_mobile_phone_numbers": [],
        "owner_name": "Josh Engineer",
        "owner_email": "emailaddress@cisco.com",
        "close_date": "2017-05-11T18:43:56.000Z",
        "technology_name": "Smart Services Capabilities",
        "sub_technology_name": "Collector Deployment SNTC (Contract Required)",
        "tracking_number": "",
        "problem_code_name": "Configuration Assistance",
        "request_type": "",
        "rmas": [],
        "bugs": [],
        "notes": [
            {
                "note": "",
                "note_detail": "Closed with Customer Permission",
                "created_by": "Josh Engineer",
                "creation_date": "2017-05-11T18:44:00.000Z"
            },
            {
                "note": "",
                "note_detail": "duplicate case, 682307531",
                "created_by": "Joshua Frumkin",
                "creation_date": "2017-05-11T18:44:00.000Z"
            }
        ],
    }
}

GET Cases by Contract ID

Returns summary information for cases associated with the specified contract or contracts.

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/case/v3/cases/contracts/contract_ids/1234567?date_created_from=2017-04-01T00:00:00Z&date_created_to=2017-04-30T23:59:59Z&sort_by=&status_flag=O&page_index=1

Sample Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 1,
    "self_link": "https://apix.cisco.com/case/v3/cases/contracts/contract_ids/1234567?date_created_from=2017-04-01T00:00:00Z&date_created_to=2017-04-30T23:59:59Z&sort_by=&status_flag=O&page_index=1,
    "title": "Get Cases By Contract Id",
    "total_records": 1
  },
  "cases": [
    {
      "item_entry_id": 1,
      "user_id": "directcust4",
      "case_id": "682299374",
      "title": "SNTC : Day 2 : NOS Handover Collector Training :TARGET CORPORATION",
      "severity": "3",
      "contact_name": "CPRSMOKE TESTER",
      "status_flag": "O",
      "status": "Cisco Pending",
      "creation_date": "2017-04-24T19:02:31.000Z",
      "updated_date": "2017-05-12T18:51:54.000Z",
      "serial_number": "",
      "contract_id": "1234567",
      "rmas": [],
      "bugs": []
    }
  ]
}

GET Cases by User ID

Returns summary information for cases associated with the specified user or users.

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/case/v3/cases/users/user_ids/directcust4?date_created_from=2017-04-01T00%3A00%3A00Z&date_created_to=2017-04-30T23%3A59%3A59Z&sort_by=&status_flag=O&page_index=1

Sample Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 1,
    "self_link": "self_link": "https://apix.cisco.com/case/v3/cases/users/user_ids/directcust4?page_index=1&sort_by=UPDATED_DATE&status_flag=O&date_created_from=2017-04-01T00:00:00Z&date_created_to=2017-04-30T23:59:59Z",
    "title": "Get Cases By User Id",
    "total_records": 1
  },
  "cases": [
    {
      "item_entry_id": 1,
      "user_id": "directcust4",
      "case_id": "682299374",
      "title": "SNTC : Day 2 : NOS Handover Collector Training :TARGET CORPORATION",
      "severity": "3",
      "contact_name": "CPRSMOKE TESTER",
      "status_flag": "O",
      "status": "Cisco Pending",
      "creation_date": "2017-04-24T19:02:31.000Z",
      "updated_date": "2017-05-12T18:51:54.000Z",
      "serial_number": "",
      "contract_id": "1234567",
      "rmas": [],
      "bugs": []
    }
  ]
}

Pagination Response Record

Provides information about the page requested and the total number of pages available to return.

Parameters

Sample JSON Response

{
  "pagination_response_record": {
    "last_index": 6,
    "page_index": 6,
    "page_records": 45,
    "self_link": "https://apicisco.com/case/v3/cases/contracts/contract_ids/1234567?page_index=6&sort_by=UPDATED_DATE",
    "title": "Get Cases By Contract Id",
    "total_records": 545
  },

Error Codes

This table describes the error codes returned by the Cisco Support Case API.