Get Work Order Details API

Owned by Enterprise IT
Apr 23, 2024
15 min read

You can create a Get Work Order API using the following API Request. 

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

Service NameHTTP Method
GetWorkorderDetails

POST


Sample Request
{
    "ServiceName": "GetWorkorderDetails",
    "objCommonParameters": {
        "_ProxyDetails": {             
			"AuthType": "APIKey"
			"APIKey": "XXXXXXX",
            "ProxyID": 0,
            "ReturnType": "JSON",
            },
        "InstanceCode": "Info",
        "oWorkorderParam": {
            "_Workorder_No": "991"
        }
    }
}

Request Parameters

Parameter NameTypeDescriptionMandatory

_Workorder_No

STRING

Unique Identification of the Work Order.

TRUE

Sample Response
{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "F22ECD2B9D8AF26E474D3D4D6355E0B3B9491641ECF22F5E8135F4D6985D28AA285191B65821270CF51BAFE14D0DB215856159C1558EA3DB00C983D096D5373F54C017D564C064F541E571D1C7BC15B3FD170679226FCFF2AE24D5C0970029BC5A7D32D12C38C8F1BD24B37129F9081C",
    "OrgID": 0,
    "OutputObject": {
        "WorkorderDetails": {
            "WorkorderDetail": [
                {
                    "org_id": 1,
                    "workorder_id": 2998,
                    "Workorder No": "991",
                    "Reg_Time": "2021-11-25 17:20:09",
                    "status": "New",
                    "loggedby": 1282,
                    "ClassificationID": 929,
                    "Classification": "/エンタメ",
                    "Category": "/New",
                    "CategoryID": 10,
                    "Subject": "Symptom",
                    "pending_code": null,
                    "pendingreason": null,
                    "sla": null,
                    "sla_name": null,
                    "assigned_workgroup": 24,
                    "wg_name": "abc",
                    "Assigned_WorkGroup_Name": "abc",
                    "assigned_engineer": 435,
                    "Assigned_Engineer_Name": "Assetuser",
                    "Assigned_Engineer_Email": "Assetuser.2@symphonysummit.com",
                    "Assigned_Engineer_EmpID": null,
                    "Response_Time": "2021-11-25 17:20:09",
                    "Expected_Resolution_Time": null,
                    "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": false,
                    "Information": "_Description",
                    "solution": null,
                    "userlog": null,
                    "internallog": null,
                    "caller": 1282,
                    "Caller_Name": "Raviteja",
                    "sup_function": "Info",
                    "Sup_Function_Name": "Information Technology",
                    "kb": false,
                    "parentticketid": null,
                    "Updated_Time": "2021-11-25 17:20:10",
                    "CallerEmailID": "ravi@ravi.in",
                    "Dependant_Workorder_ID": null,
                    "Dependant_Workorder_No": null,
                    "Dependant_Workorder_Status": null,
                    "relation": null,
                    "workorder_source": "SR",
                    "ola_sourceid": 2497,
                    "ola_violated": null,
                    "OLA_Deadline": null,
                    "ola_response_violated": null,
                    "OLA_Response_Deadline": null,
                    "priority": 2,
                    "Priority_Name": null,
                    "number_of_minutes": null,
                    "assigned_engineer_comments": null,
                    "OLA_SourceNo": "2524",
                    "Reopen_Access": "True"
                }
            ],
            "WorkOrderRelation": [],
            "IncidentRelation": [],
            "SRRelation": [
                {
                    "ID": 2497,
                    "Service Request": "2524",
                    "Status": "In-Progress",
                    "Log Time": "2021-11-09 11:09:37",
                    "Symptom": "New Service Request raised f...",
                    "PriorityDisplay": "P2",
                    "CallerName": "Raviteja"
                }
            ],
            "ChangeRelation": [],
            "ProblemRelation": [],
            "AssetRelation": [],
            "UserAssetRelation": [],
            "ParentWorkorderRelation": [],
            "WorkorderChangeHistory": [
                {
                    "uid": 11174,
                    "column_name": "Status",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": null,
                    "new_Value": "New"
                },
                {
                    "uid": 11175,
                    "column_name": "Symptom",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": "",
                    "new_Value": "Symptom"
                },
                {
                    "uid": 11176,
                    "column_name": "Assigned Workgroup",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": null,
                    "new_Value": "abc"
                },
                {
                    "uid": 11177,
                    "column_name": "Assigned Engineer",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": null,
                    "new_Value": "Assetuser"
                },
                {
                    "uid": 11178,
                    "column_name": "Response Time",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": null,
                    "new_Value": "new_value"
                },
                {
                    "uid": 11179,
                    "column_name": "Priority",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": "",
                    "new_Value": "P2"
                },
                {
                    "uid": 11180,
                    "column_name": "Category",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": "",
                    "new_Value": "New"
                },
                {
                    "uid": 11181,
                    "column_name": "Classification",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": "",
                    "new_Value": "エンタメ"
                },
                {
                    "uid": 11182,
                    "column_name": "Caller",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": "",
                    "new_Value": ""
                },
                {
                    "uid": 11183,
                    "column_name": "Description",
                    "Change date": "2021-11-25 11:50:10",
                    "change_by": 1282,
                    "change_byName": "Raviteja",
                    "old_Value": null,
                    "new_Value": "_Description"
                }
            ],
            "CustomAttributesDetails": [
                {
                    "Group Name": "Default Group123",
                    "Attribute ID": 33,
                    "Attribute Name": "E-mail",
                    "Attribute Value": "3"
                }
            ]
        }
    },
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.