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

Service Name: GetWorkorderDetails | Description
Retrieves all the details of a Workorder

URL

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

Method

Background Color

POST

Request

Code Block
themeDJango
titleSample Request
linenumberstrue
collapsetrue
{
  "ServiceName": "GetWorkorderDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "ReturnType": "JSON"
    },
    "InstanceCode": "InfoTe",
    "oWorkorderParam": {
      "_Workorder_No": "509"
    }
  }
}

Request Parameters

Parameter NameTypeDescriptionNotes

InstanceCode * 

Status
titleInteger

Unique Identification of the Organization.


_Workorder_No 

Status
titleInteger

Name of the Instance.

For Example: Information Technology

* 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

Midnight
Code Block
theme
titleSample Response
collapsetrue
{"Errors":"","Message":"","Output":"","TokenID":null,"OrgID":0,"OutputObject":{"WorkorderDet ails":{"WorkorderDetail":[{"org_id":1,"workorder_id":519,"Workorder No":"509","Reg_Time":"2018-04-23
18:24:58","status":"New","loggedby":6,"ClassificationID":5,"Classification":"Node/Node_1","Cate gory":"Incident/Indnt_1","CategoryID":5,"Subject":"Hello.	First	WO	by	M	for	IM Symptom","pending_code":null,"pendingreason":null,"sla":null,"sla_name":null,"assigned_wor kgroup":3,"wg_name":"IT	Infrastructure","Assigned_WorkGroup_Name":"IT Infrastructure","assigned_engineer":null,"Assigned_Engineer_Name":null,"Assigned_Engineer
_Email":null,"Assigned_Engineer_EmpID":null,"Response_Time":null,"Expected_Resolution_Ti me":"2018-04-24
18:25:16","Actual_Resolution_Time":null,"resolution_sla_met":null,"resolution_sla_reason":null, "closure_code":null,"clcode_name":null,"repeat_ticket":false,"reopen_ticket":false,"attachments"
:null,"Information":"Hello.	First	WO	by	M	for	IM Description","solution":null,"userlog":null,"internallog":null,"caller":6,"Caller_Name":"Megha natraj","sup_function":"InfoTe","Sup_Function_Name":"Information Technology","kb":false,"parentticketid":null,"Updated_Time":"2018-04-23 18:25:01","CallerEmailID":"Louis@xyz.com","Dependant_Workorder_ID"
:null,"Dependant_Workorder_No":null,"Dependant_Workorder_Status":null,"relation":null,"w orkorder_source":"IM","ola_sourceid":3119,"ola_violated":null,"OLA_Deadline":null,"ola_respo nse_violated":null,"OLA_Response_Deadline":null,"priority":4,"Priority_Name":"P3","number_ of_minutes":null,"assigned_engineer_comments":null,"OLA_SourceNo":"3083","Reopen_Acces s":"True"}],"WorkOrderRelation":[{"ID":510,"Work Order":"500","Status":"New","Log Time":"2018-04-03	17:11:04","Symptom":"Hello. Second WO by IM for IM...","PriorityDisplay":"P3","CallerName":"prateek"}],"IncidentRelation":[{"ID":2622,"Incident": "2586","Status":"Assigned","Log Time":"2018-04-03 17:11:01","Symptom":"dfsrgdfsrgdfsrgdfsrgdfsrgdfsrg","PriorityDisplay":"P3","CallerName":"pr ateek"}],"SRRelation":[],"ChangeRelation":[],"ProblemRelation":[],"AssetRelation":[],"UserAsset Relation":[],"ParentWorkorderRelation":[],"WorkorderChangeHistory":[{"uid":4502,"column_na me":"Status","Change date":"2018-04-03 11:41:21","change_by":6,"change_byName":"Megha natraj","old_Value":null,"new_Value":"New"},{"uid":4503,"column_name":"Symptom","Change date":"2018-04-03 11:41:21","change_by":6,"change_byName":"Megha natraj","old_Value":"","new_Value":"Hello. First WO by IM for	 IM Symptom"},{"uid":4504,"column_name":"Assigned Workgroup","Change date":"2018-04-03 11:41:21","change_by":6,"change_byName":"Peter Paul","old_Value":null,"new_Value":"IT Infrastructure"},{"uid":4505,"column_name":"Commitment Deadline","Change date":"2018-04-03 11:41:21","change_by":6,"change_byName":"Megha natraj","old_Value":null,"new_Value":"new_value"},{"uid":4506,"column_name":"Description"," Change date":"2018-04-03 11:41:21","change_by":6,"change_byName":"Megha natraj","old_Value":null,"new_Value":"Hello. First WO by M for IM Description"}]}}}
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

| |