Get Work Order List API

Owned by Enterprise IT
Last updated: Apr 23, 2024 by Shilpa K (Deactivated)Version comment
5 min read

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

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

Service NameHTTP Method
GetAllMyWkgWorkorders

POST


Sample Request
{
    "ServiceName": "GetAllMyWkgWorkorders",
    "objCommonParameters": {
        "_ProxyDetails": {
		"AuthType": "APIKey"
		"APIKey": "XXXXXXXXX",
            "ProxyID": 0,
            "ReturnType": "JSON",
       },
        "oWorkorderParam": {
            "FromWorkorderNo": 989,
            "ToWorkorderNo": 991,
            "FromDate": "",
            "ToDate": ""
        },
        "InstanceCode": "Info",
        "Status": "New,Closed",
        "Workgroup": "New WG,abc"
    }
}

Request Parameters

Parameter NameTypeDescriptionMandatory

FromWorkorderNo

STRING

Specify the number of the From Work Order.

TRUE

ToWorkorderNo

STRING

Specify the number of the Work Order.

TRUE

FromDate

STRING

You can select the date range to specify the From Date of the Get Work Order List API that you want to get displayed. The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date.

FALSE

ToDate

STRING

You can select the date range to specify the To Date of the Get Work Order List API that you want to get displayed. The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date.

FALSE

InstanceCode

STRING

Specify the unique code of an Instance.

TRUE

Status

STRING

Specify the status of the Work Order.

FALSE

Workgroup

STRING

Specify the Work Group of the Work Order.

FALSE

Sample Response
{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "84986858BC51D68808D99E3622FDCDDB31D3397ECB59989A8B0F366F8C643D22878AC1515E70D056E1711E50EE338F7890172AD573F0B18CB756482524DB52ACBF91A427B8F0963B9AA7AF64AC917499E17D48A73EF62D3179AC323AAF1BF26ABF53248A14171A412BEB6C231CDDFF80",
    "OrgID": 0,
    "OutputObject": [
        {
            "ROWNUM": "1",
            "Workorder_ID": "2998",
            "TotalRows": 3,
            "Workorder No": "991",
            "Logged Time": "2021-11-25 17:20:09",
            "Sup_Function": "Info",
            "Status": "New",
            "Caller": "Raviteja",
            "Workgroup": "abc",
            "Executive": "Assetuser",
            "Symptom": "Symptom",
            "Priority": "P2",
            "Workorder_Source": "SR",
            "SLAName": ""
        },
        {
            "ROWNUM": "2",
            "Workorder_ID": "2997",
            "TotalRows": 3,
            "Workorder No": "990",
            "Logged Time": "2021-11-25 16:43:23",
            "Sup_Function": "Info",
            "Status": "New",
            "Caller": "Raviteja",
            "Workgroup": "abc",
            "Executive": "Assetuser",
            "Symptom": "Symptom",
            "Priority": "P2",
            "Workorder_Source": "SR",
            "SLAName": ""
        },
        {
            "ROWNUM": "3",
            "Workorder_ID": "2996",
            "TotalRows": 3,
            "Workorder No": "989",
            "Logged Time": "2021-11-24 17:43:46",
            "Sup_Function": "Info",
            "Status": "New",
            "Caller": "Raviteja",
            "Workgroup": "New WG",
            "Executive": "Assetuser",
            "Symptom": "Symptom",
            "Priority": "-",
            "Workorder_Source": "IM",
            "SLAName": ""
        }
    ],
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.