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 3 Next »

Service Name: GetAllMyWkgWorkorders | Description
Retrieves all the list of Workorders

URL

http://<<Customer_URL>>/REST/Summit_RESTWCF.svc/RESTService/Common WS_JsonObjCall
Replace <Customer_URL> with the customer’s Host name.

Method

POST

Request

Sample Request
{
  "ServiceName": "GetAllMyWkgWorkorders",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "ReturnType": "JSON"
    },
    "oWorkorderParam": {
      "FromWorkorderNo": 526,
      "ToWorkorderNo": 529,
      "FromDate": "2018-08-06 17:12:31",
      "ToDate": "2018-08-06 17:12:31"
    },
    "InstanceCode": "InfoTe",
    "Status": "New,Closed",
    "Workgroup": "IT Infrastructure,WG1"
  }
}

Request Parameters

Parameter NameTypeDescriptionNotes

FromWorkorderNo * 

INTEGER



ToWorkorderNo 

STRING



FromDate * 

BOOLEAN



ToDate * 

BOOLEAN



InstanceCode * 

BOOLEAN



Status * 

BOOLEAN



Workgroup * 

BOOLEAN



* Indicates mandatory fields

Run API

Go to the Web Services page in the SummiAI application to execute the APIs and see the response.



Response

Sample Response
{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": null,
  "OrgID": 0,
  "OutputObject": [
    {
      "ROWNUM": " 1",
      "Workorder_ID": "536",
      "TotalRows": "1",
      "Workorder No": "526",
      "Logged Time": "2018-08-06 17:12:31",
      "Sup_Function": "InfoTe",
      "Status": "New",
      "Caller": "Peter Paul",
      "Workgroup": "IT Infrastructure",
      "Executive": null,
      "Symptom": "(Finance)House Rent and Electricity Recovery",
      "Priority": "p1_1",
      "Workorder_Source": "SR",
      "SLAName": ""
    }
  ]
}

Note:

The Response Parameters are dynamic and based on the selections made by the user.

Status and Error Codes

See: Status and Error Messages

  • No labels