Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the code macro with the following parameter(s): [theme]
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

Scroll export button
scopecurrent
template-id4fda9400-a7df-4ede-a95f-e4ae5fcf4796
captionDownload this Page
add-onScroll PDF Exporter

You can retrieve the SR details with custom attributes based on the Instance using the following API Request. 

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

Service NameHTTP Method
SR_GetServiceRequestListDetails

POST


Code Block
titleSample Request
linenumberstrue
collapsetrue
{
    "ServiceName": "SR_GetServiceRequestListDetails",
    "objCommonParameters": {
        "_ProxyDetails": {
            "TokenID": "",
            "OrgID": "1",
            "ReturnType": "JSON",
            "APIKey": "XXXXXXXXXXXX",
            "AuthType": "APIKEY",
            "ProxyID": 0
        },
        "objSR_SearchFilterParam": {
            "Executive": 1,
            "WorkgroupName": "",
            "CurrentPageIndex": 0,
            "PageSize": 1,
            "OrgID": "1",
            "Instance": "Info",
            "Status": "ALL",
            "strUpdatedFromDate": "",
            "strUpdatedToDate": "",
            "IsWebServiceRequest": true,
            "Catalog":null,
            "CatalogName":"",
            "IncludeCatalogAttributes": true
        }
    }
}

Request Parameters

Parameter NameTypeDescriptionNotes

Executive

Status
colourGrey
titleinteger

Is the requester an Analyst? 

The value is 1, if the requester is an Analyst.

WorkgroupName

Status
colourGreen
titleString

Name of the Workgroup for which the required Incidents belong to.

You can get multiple workgroup Incidents by using comma separation between the workgroup names without a space.

For Example:

"WorkgroupName": "WG1,WG2,WG3"

CurrentPageIndex *

Status
colourGrey
titleinteger

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.

PageSize *

Status
colourGrey
titleinteger

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

OrgID *

Status
colourGrey
titleinteger

Unique Identification number of the Organization.

The value must be always 1.

Instance *

Status
colourGreen
titleString

Name of the Instance.

For Example: Information Technology

Status

Status
colourGreen
titleString

Status of the Incidents that should be displayed.

Status can be Open, Reopened, New, Assigned, In-Progress, Pending, Resolved, Closed, and Cancelled.

You can get all Incidents with different status' by using comma separation between the status names without a space.

For Example:

"Status": "Open,New,Assigned,In-Progress"

strUpdatedFromDate

Status
colourGreen
titleString

You can select the date range to get the list of Incidents. Specify the From Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date.

strUpdatedToDate

Status
colourGreen
titleString

You can select the date range to get the list of Incidents. Specify the To Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date.

IsWebServiceRequest *

Status
colourBlue
titleBOOLEAN

Is the Web Service is a Request or not?

By default the value is always true.

Catalog

Status
colourGrey
titleinteger

Unique Identification number of the catalog.


CatalogName

Status
colourGreen
titleString

Name of the Catalog.

If both the Catalog and CatalogName values are specified, Catalog takes precedence over the CatalogName and displays the appropriate data in the response. 

IncludeCatalogAttributes

Status
colourBlue
titleBOOLEAN

Are the Catalog Attributes required to be retrieved in the Response?

  • If the value is true, the Catalog Attributes are retrieved in the response.
  • If the value is false, the Catalog Attributes are not retrieved in the response.
* Indicates mandatory fields
Code Block
titleSample Response
collapsetrue
{
    "Errors": "",
    "Message": null,
    "Output": "",
    "TokenID": "84E24D926946CF7F6E2986BA368F4A68581501152518F992FC6F2FCA0FADE13203A0604E00D207911A8094689BBFAD992B91963077844E7429E2A964FBD1F9FFE
D93E303A328BDEBCCF621AC55784021DC6DE1EAD1297FE89F89D0D843BC12BFB438F93CAF52F761FF06B1686AE27488CBACA29C55AC2FE80BCC923DFDC0C133",
    "OrgID": 0,
    "OutputObject": {
        "MyTickets": [
            {
                "SRDetail": [
                    {
                        "ROWNUM": 1,
                        "Ticket_ID": "9L1tteR2ANnUySy81ZUMeg%3d%3d",
                        "SR ID": "SR5299",
                        "TotalRows": 304.0,
                        "Log Time": "2021-03-24 20:00:32",
                        "Status": "Assigned",
                        "Symptom": "New Service Request raised for -Business\\TestCaseCatalog",
                        "Description": "*This SR has been automatically created from CloudHUB according to on-prem self-service provisioning request 
raised by Anish.Anil@harman.com on Fri Feb 05 2021 10:14:00 GMT+0000 (Coordinated Universal Time).<br><br>CloudHub Order: https://cloud.harman.com/hybridprovisioning/reviewOrders/?orderId=1202736 .<br>The requested server has been already provisioned, 
please configure backup service. <br>The host name is: DEMDLX121DB001.Please refer CI ID 18303 in CMDB for the system details.",
                        "Workgroup Name": "SR Group",
                        "Executive Name": "-",
                        "Assigned_Engineer": null,
                        "Priority": "P2",
                        "PriorityColorCode": null,
                        "Resolution_SLA": 60.0,
                        "SLAName": "9 to 5",
                        "CallerName": "vivegan",
                        "UserTypeColor": null,
                        "UserTypeName": null,
                        "Resolution_Time": null,
                        "Age": 16.0,
                        "Resolution_ElapseTime": 548.0,
                        "SLAProgress": 913.0,
                        "IsParentRecord": 0,
                        "UserProfileImageName": "",
                        "CallerUpdate": false,
                        "IsChild": 0,
                        "IsParent": 0,
                        "AssignedToMe": 0,
                        "Reopened": false,
                        "Updated_Time": "2021-03-25T12:08:20",
                        "Customer": null,
                        "Location": "bangalore",
                        "IsAttExists": 0,
                        "Category": "Business",
                        "FullCategory": "Business\\TestCaseCatalog",
                        "CatalogName": "TestCaseCatalog",
                        "CatalogID": 214,
                        "Pending Reason": null,
                        "Vendor Incident ID": "",
                        "Vendor Name": "",
                        "Sup_Function": "Info",
                        "Impact_Name": "High",
                        "Urgency_Name": "urgency1234567890-",
                        "Classification_Name": "Test Node\\Test1\\Alpha",
                        "ScheduledDate": null,
                        "ResolutionCodeName": "",
                        "Response_Deadline": "2021-03-24 20:31:00",
                        "Resolution_Deadline": "2021-03-24 21:01:00",
                        "Response_voilation": null,
                        "Resolution_voilation": null,
                        "Vendor_status": "",
                        "VendorIncidentStartDate": null,
                        "VendorIncidentEndDate": null,
                        "PendingApproverName": "Approved",
                        "AgeClass": "green",
                        "AgingInfo": "0-2 Days",
                        "SLAPercent": "100",
                        "SLAProgressClass": "danger",
                        "Remaining SLA Time": null,
                        "Solution": null,
                        "User Log": null,
                        "Private Log": null,
                        "Caller_EmailId": "vivegan.jeyam@harman.com",
                        "Response_ElapseTime": 548.0,
                        "Closure_Code_Name": null,
                        "Response_SLA_Reason": "",
                        "Resolution_SLA_Reason": "",
                        "AttachmentNames": null
                    }
                ],
                "SRCustomAttribute": [
                    {
                        "ID": 2,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 129,
                        "SR_CtAttribute_Name": "Data",
                        "AttributeText": "ChangesetSRMV.txt"
                    },
                    {
                        "ID": 3,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 131,
                        "SR_CtAttribute_Name": "Text Check",
                        "AttributeText": "Testing this text box"
                    },
                    {
                        "ID": 4,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 132,
                        "SR_CtAttribute_Name": "Autofill Check",
                        "AttributeText": "Srilanka"
                    },
                    {
                        "ID": 5,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 133,
                        "SR_CtAttribute_Name": "Drop Check",
                        "AttributeText": "Lenovo"
                    },
                    {
                        "ID": 6,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 134,
                        "SR_CtAttribute_Name": "MultiDrop Check",
                        "AttributeText": "A3,C1,A1"
                    },
                    {
                        "ID": 7,
                        "ServiceTicketID": "SR5299",
                        "Group_Name": "General Area",
                        "IM_CtAttribute_ID": 135,
                        "SR_CtAttribute_Name": "Date CHeck",
                        "AttributeText": "Mar 31 2021  5:30AM"
                    }
                ],
                "CustomAttribute": [
                    {
                        "ID": 1,
                        "ServiceTicketID": 5299,
                        "Group_Name": "Default Group",
                        "SR_CtAttribute_ID": 455,
                        "SR_CtAttribute_Name": "Name",
                        "AttributeText": null
                    },
                    {
                        "ID": 2,
                        "ServiceTicketID": 5299,
                        "Group_Name": "In Group",
                        "SR_CtAttribute_ID": 459,
                        "SR_CtAttribute_Name": "Name1",
                        "AttributeText": null
                    }
                ],
                "MVCustomAttribute ": []
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |