Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the bgcolor macro with the following parameter(s): [color]
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

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

Background Color
color#B1AEF2

POST

Request

Code Block
titleSample Request
linenumberstrue
collapsetrue
{
  "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 * 

Status
titleInteger



ToWorkorderNo 

Status
colourGreen
titleString



FromDate * 

Status
colourBlue
titleBoolean



ToDate * 

Status
colourBlue
titleBoolean



InstanceCode * 

Status
colourBlue
titleBoolean



Status * 

Status
colourBlue
titleBoolean



Workgroup * 

Status
colourBlue
titleBoolean



* Indicates mandatory fields
Tip
titleRun API
Go to the Web Services page in the SummiAI application to execute the APIs and see the response.



Response

Code Block
titleSample Response
collapsetrue
{
  "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
titleNote:
The Response Parameters are dynamic and based on the selections made by the user.

Status and Error Codes

See: Status and Error Messages

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

| |