Update Work Order

You can update an existing Work Order (WO) using the following API Request with details such as Status, Impact Name, Priority Name, Internal Log, and User Log.

Service Name	HTTP Method
WO_CreateORUpdateWorkOrder	POST

Assigned

In-Progress

Pending

Resolved

Cancelled

Sample Request

{
    "ServiceName": "WO_CreateORUpdateWorkOrder",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "OrgID": "1",
            "ReturnType": "JSON",
             "AuthType": "APIKEY",
            "APIKey": "XXXXXXXXXXXXXXX"
         },
        "oWorkorderParam": {
            "IsWebServiceRequest": true,
            "_Workorder_No": "980",
            "LoggedAnalystEmailID": "abc@xyz.in",
            "_Sup_Function": "Info",
            "_Status": "Cancelled",
            "_Assigned_Engineer_Email": "abc@xyz.in",
            "_Assigned_WorkGroup_Name": "abc",
			"_Classification_Name": "Alpha",
            "Priority_Name": "Priority-1",
             "Communication": {
                "CancelRemarks":"Ticket Cancelled",
                "_UserLog":"User Log",
                "_InternalLog":"Internal Log",
                "_Solution":""
              },
            "CustomFields": []
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
IsWebServiceRequest	BOOLEAN	Is the Request from Web Service?	TRUE
_Workorder_No	STRING	The unique Identification number of a work order.	TRUE
LoggedAnalystEmailID	STRING	The e-mail Id of the logged-in analyst. Note: It is mandatory to provide LoggedAnalystEmailIDvalue	TRUE
_Sup_Function	STRING	The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy. For Example: Info	TRUE
_Status	STRING	The status of the work order. The value of the Status should be assigned for this request.	TRUE
_Assigned_Engineer_Email	STRING	The e-mail id of the assigned engineer.	TRUE
_Assigned_WorkGroup_Name	STRING	The workgroup defines a group of members in an Instance or a unit of an organization.	TRUE
CancelRemarks	STRING	The additional information about the Cancellation of a work order.	TRUE
_Classification_Name	STRING	The name of the classification of work order.	FALSE
Priority_Name	STRING	The name of the Priority of a of work order.	FALSE
_UserLog	STRING	The user communication of work order.	FALSE
_InternalLog	STRING	The internal log of work order.	FALSE
CustomFields	STRING	The custom fields of the specified work order. These custom fields include the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "",
    "OrgID": 0,
    "Output": "Workorder Details Updated Successfully.",
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "BAF7831E2F0661E29FB4FF3D5D04A2D622157ADE7228B670B6785EB581B0C264B35E523C527C5FB257A05EC0F99E8B6DEAA44917956AD4366B8A3C19826F38348B7FE1DD8ADAE7640C3037A13D523628A6E07447DB2F053059A212E09ACF63A619499DD9E1C56A57240C1F80AE1EFF9A",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2985,
    "TicketNo": 978
}

Sample Request

{
    "ServiceName": "WO_CreateORUpdateWorkOrder",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "OrgID": "1",
            "ReturnType": "JSON",
            "AuthType": "APIKEY",
            "APIKey": "XXXXXXXXXXXXXXX"
         },
        "oWorkorderParam": {
            "IsWebServiceRequest": true,
            "_Workorder_No": "978",
            "LoggedAnalystEmailID": "abc@xyz.in",
            "_Sup_Function": "Info",
            "_Status": "Resolved",
            "_Assigned_Engineer_Email": "abc@xyz.in",
            "_Assigned_WorkGroup_Name": "abc",
            "_Closure_Code_Name":"Passed",
            "_Classification_Name": "Alpha",
            "Priority_Name": "Priority-1",
            "Communication": {
			    "_UserLog":"User Log",
                "_InternalLog":"Internal Log",
                "_Solution":"test resolve"
			},
            "CustomFields": []
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
IsWebServiceRequest	BOOLEAN	Is the Request from Web Service?	TRUE
_Workorder_No	STRING	The unique Identification number of a work order.	TRUE
LoggedAnalystEmailID	STRING	The e-mail Id of the logged-in analyst. Note: It is mandatory to provide LoggedAnalystEmailID value.	TRUE
_Sup_Function	STRING	The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy. For Example: Info	TRUE
_Status	STRING	The status of the work order. The value of the status should be assigned for this request.	TRUE
_Assigned_Engineer_Email	STRING	The e-mail id of the assigned engineer.	TRUE
_Assigned_WorkGroup_Name	STRING	The workgroup defines a group of members in an Instance or a unit of an organization.	TRUE
_Closure_Code_Name	STRING	The closure code is the status code used by analysts to resolve an Incident. It is applicable only for the auto closure.	TRUE
_Solution	STRING	The resolution comments of work order.	TRUE
_Classification_Name	STRING	The name of the classification of work order.	FALSE
Priority_Name	STRING	The name of the priority of a of work order.	FALSE
_UserLog	STRING	The user communication of work order.	FALSE
_InternalLog	STRING	The internal log of work order.	FALSE
CustomFields	STRING	The custom fields of the specified work order. These custom fields include the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "",
    "OrgID": 0,
    "Output": "Workorder Details Updated Successfully.",
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "BAF7831E2F0661E29FB4FF3D5D04A2D622157ADE7228B670B6785EB581B0C264B35E523C527C5FB257A05EC0F99E8B6DEAA44917956AD4366B8A3C19826F38348B7FE1DD8ADAE7640C3037A13D523628A6E07447DB2F053059A212E09ACF63A619499DD9E1C56A57240C1F80AE1EFF9A",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2985,
    "TicketNo": 978
}

Sample Request

{
    "ServiceName": "WO_CreateORUpdateWorkOrder",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "OrgID": "1",
            "ReturnType": "JSON",
            "AuthType": "APIKEY",
           "APIKey": "XXXXXXXXXXXXXXX"
        },
        "oWorkorderParam": {
            "IsWebServiceRequest": true,
            "_Workorder_No": "978",
            "LoggedAnalystEmailID": "abc@xyz.in",
            "_Sup_Function": "Info",
            "_Status": "Pending",
            "_Assigned_Engineer_Email": "abc@xyz.in",
            "_Assigned_WorkGroup_Name": "abc",
            "_PendingReason":"No-Power", 
            "_Classification_Name": "Alpha",
            "Priority_Name": "Priority-1",
            "Communication": {
			    "_UserLog":"User Log",
                "_InternalLog":"Internal Log",
                "_Solution":""
			},
            "CustomFields": []
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
IsWebServiceRequest	STRING	Is the Request from Web Service?	TRUE
_Workorder_No	STRING	The unique identification number of a work order.	TRUE
LoggedAnalystEmailID	STRING	The e-mail Id of the logged-in analyst. Note: It is mandatory to provide LoggedAnalystEmailID value.	TRUE
_Sup_Function	STRING	The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy. For Example: Info	TRUE
_Status	STRING	The status of the work order. The value of the status should be assigned for this request	TRUE
_Assigned_Engineer_Email	STRING	The e-mail id of the assigned engineer.	TRUE
_Assigned_WorkGroup_Name	STRING	The workgroup defines a group of members in an Instance or a unit of an organization.	TRUE
_PendingReason	STRING	The pending reason for the work order. This is an mandatory field.	TRUE
_Classification_Name	STRING	The name of the classification of work order.	FALSE
Priority_Name	STRING	The name of the priority of a of work order.	FALSE
_UserLog	STRING	The user communication of work order.	FALSE
_InternalLog	STRING	The internal log of work order.	FALSE
CustomFields	STRING	The custom fields of the specified work order. These custom fields include the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "",
    "OrgID": 0,
    "Output": "Workorder Details Updated Successfully.",
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "BAF7831E2F0661E29FB4FF3D5D04A2D622157ADE7228B670B6785EB581B0C264B35E523C527C5FB257A05EC0F99E8B6DEAA44917956AD4366B8A3C19826F38348B7FE1DD8ADAE7640C3037A13D523628A6E07447DB2F053059A212E09ACF63A619499DD9E1C56A57240C1F80AE1EFF9A",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2985,
    "TicketNo": 978
}

Sample Request

{
    "ServiceName": "WO_CreateORUpdateWorkOrder",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "OrgID": "1",
            "ReturnType": "JSON",
            "AuthType": "APIKEY",
            "APIKey": "XXXXXXXXXXXXXXX"
         },
        "oWorkorderParam": {
            "IsWebServiceRequest": true,
            "_Workorder_No": "978",
            "LoggedAnalystEmailID": "abc@xyz.in",
            "_Sup_Function": "Info",
            "_Status": "In-Progress",
            "_Assigned_Engineer_Email": "abc@xyz.in",
            "_Assigned_WorkGroup_Name": "abc",
            "_Classification_Name": "Alpha",
            "Priority_Name": "Priority-1",
            "Communication": {
			    "_UserLog":"User Log",
                "_InternalLog":"Internal Log",
                "_Solution":""
			},
            "CustomFields": []
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
IsWebServiceRequest	BOOLEAN	Is the Request from Web Service?	TRUE
_Workorder_No	STRING	The unique identification number of a work order.	TRUE
LoggedAnalystEmailID	STRING	E-mail Id of the logged-in analyst. Note: It is mandatory to provide LoggedAnalystEmailID value.	TRUE
_Sup_Function	STRING	The name of the instance code. It defines a business unit, an entity, or a department in an organizational hierarchy. For Example: Info	TRUE
_Status	STRING	Status of the work order. The value of the Status should be Assigned for this Request.	TRUE
_Assigned_Engineer_Email	STRING	The e-mail id of the assigned engineer.	TRUE
_Assigned_WorkGroup_Name	STRING	The workgroup defines a group of members in an Instance or a unit of an organization.	TRUE
_Classification_Name	STRING	The name of the classification of work order.	FALSE
Priority_Name	STRING	The name of the priority of a of work order.	FALSE
_UserLog	STRING	The user communication of work order.	FALSE
_InternalLog	STRING	The internal log of work order.	FALSE
CustomFields	STRING	The custom fields of the specified work order. These custom fields include the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "",
    "OrgID": 0,
    "Output": "Workorder Details Updated Successfully.",
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "BAF7831E2F0661E29FB4FF3D5D04A2D622157ADE7228B670B6785EB581B0C264B35E523C527C5FB257A05EC0F99E8B6DEAA44917956AD4366B8A3C19826F38348B7FE1DD8ADAE7640C3037A13D523628A6E07447DB2F053059A212E09ACF63A619499DD9E1C56A57240C1F80AE1EFF9A",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2985,
    "TicketNo": 978
}

Sample Request

{
    "ServiceName": "WO_CreateORUpdateWorkOrder",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "OrgID": "1",
            "ReturnType": "JSON",              
            "AuthType": "APIKEY",
            "APIKey": "XXXXXXXXXXXXXXX"
         },
        "oWorkorderParam": {
            "IsWebServiceRequest": true,
            "_Workorder_No": "978",
            "LoggedAnalystEmailID": "abc@xyz.in",
            "_Sup_Function": "Info",
            "_Status": "Assigned",
            "_Assigned_WorkGroup_Name": "abc",
            "_Classification_Name": "Alpha",
            "Priority_Name": "Priority-1",
            "Communication": {
                "_UserLog":"User Log",
                "_InternalLog":"Internal Log",
                "_Solution":""
            },
            "CustomFields": []
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
IsWebServiceRequest	STRING	Is the Request from Web Service?	TRUE
_Workorder_No	STRING	The unique Identification number of a work order.	TRUE
LoggedAnalystEmailID	STRING	The e-mail Id of the logged-in analyst. Note: It is mandatory to provide LoggedAnalystEmailID value.	TRUE
_Sup_Function	STRING	The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy. For Example: Info	TRUE
_Status	STRING	The status of the work order. The value of the status should be assigned for this request	TRUE
_Assigned_WorkGroup_Name	STRING	The workgroup defines a group of members in an Instance or a unit of an organization.	TRUE
_Classification_Name	STRING	The name of the classification of work order.	FALSE
Priority_Name	STRING	The name of the priority of a of work order.	FALSE
_UserLog	STRING	The user communication of work order.	FALSE
_InternalLog	STRING	The internal log of work order.	FALSE
CustomFields	STRING	The custom fields of the specified work order. These custom fields include the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "",
    "OrgID": 0,
    "Output": "Workorder Details Updated Successfully.",
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "BAF7831E2F0661E29FB4FF3D5D04A2D622157ADE7228B670B6785EB581B0C264B35E523C527C5FB257A05EC0F99E8B6DEAA44917956AD4366B8A3C19826F38348B7FE1DD8ADAE7640C3037A13D523628A6E07447DB2F053059A212E09ACF63A619499DD9E1C56A57240C1F80AE1EFF9A",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2985,
    "TicketNo": 978
}

Documentation Index

Update Work Order