Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

You can retrieve all Incidents that are logged on your name using the following API Request with details such as Instance, Caller, and Status of Incidents. 

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

Service NameHTTP Method
IM_GetMyIncidents

POST

Sample Request

Json Format
{
   "ServiceName":"IM_GetMyIncidents",
   "objCommonParameters":{
      "IncidentParam":{
         "Executive":0,
         "Workgroup":0,
         "OrgID":"1",
         "CurrentPageIndex":0,
         "Status":"OPEN",
         "PageSize":20,
         "Caller":"3454",
         "Instance":"IT"
      },
      "_ProxyDetails":{
         "AuthType":"APIKEY",
         "APIKey":"XXXXXXXXXXXXXXXXXX",
         "TokenID":"",
         "OrgID":"1",
         "ReturnType":"JSON",
         "ProxyID":0,
         "RequestType":"RemoteCall"
      },
      "InstanceCode":"IT"
   }
}

Request Parameters

Parameter NameTypeDescriptionMandatory

Executive

BOOLEAN

Is Executive or not?

The value is either 0 or 1. The executive is an Analyst.

  • If you want to get the Analyst Incidents, select the value as 1. 
  • If you want to get the End User Incidents, select the value as 0.

TRUE

Workgroup 

STRING

Workgroup defines a group of members in an Instance or a unit of an organization.

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

For Example:

"WorkgroupName": "WG1,WG2,WG3"

FALSE

OrgID

INTEGER

Unique Identification number of the Organization. By default, the value is 1.

TRUE

CurrentPageIndex 

BOOLEAN

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. The Response displays items from 1 to 10 when you specify the  CurrentPageIndex value as 1.

TRUE

Status

STRING

Status of the Incidents that should be displayed.

TRUE

PageSize

INTEGER

Number of records  displayed per page.

For Example:

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

TRUE

Caller

STRING

Unique identification number of the User.

TRUE

Instance

STRING

Instance defines a business unit, entity, or a department in an organizational hierarchy. 

For Example: Info

TRUE


Sample Response

Json Format
{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "1799BEE97A3A117E7A9497EE46EDAADF220BF69F13EE500BA29CEDD32B89808A80F78912760AA3BA84FD0D23D62545
DE765052D5F4529F5B0A1ECEFDDAF8E85C6F22ECC540FBA5DD4851639A89EDE69B6B50A2F0E01FA1DA1FACCDC691457DE24F3AB
C5624950BC9C0DFC2169BFC1D7646748970DAAD81C01F3CE7C5F8231BF67AF11CF2E78262A5B44048D1C34D2BAA7954E6C4538F424
66C7419155B3A6C8936881482",
    "OrgID": 0,
    "OutputObject": {
        "MyTickets": [],
        "GridViewDisplayColumns": [
            {
                "LabelName": "Ticket_ID",
                "Value": "Ticket_ID",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Incident ID",
                "Value": "Incident ID",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Logged Time",
                "Value": "Logged Time",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Status",
                "Value": "Status",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Caller",
                "Value": "CallerName",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Workgroup",
                "Value": "Workgroup Name",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Symptom",
                "Value": "Symptom",
                "Placeholder": null,
                "IsCustomField": false
            },
            {
                "LabelName": "Pending Reason",
                "Value": "Pending",
                "Placeholder": null,
                "IsCustomField": false
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.

  • No labels