Create Work Order for IM

Owned by Enterprise IT
May 29, 2024

You can create a Work Order for Incident Management (IM) using the following API Request. 

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

Service NameHTTP Method
WO_CreateORUpdateWorkOrder

POST


Sample Request
{
	"ServiceName": "WO_CreateORUpdateWorkOrder",
	"objCommonParameters": {
		"_ProxyDetails": {
			"ProxyID": 0,
			"OrgID": "1",
			"ReturnType": "JSON",
			"AuthType": "APIKey",
			"APIKey": "**************"
		},
		"oWorkorderParam": {
			"IsWebServiceRequest": true,
			"LoggedAnalystEmailID": "abc@xyz.in",
			"_Sup_Function": "Info",
			"_Status": "New",
			"Module": "IM",
			"ModuleTicketNumber": "123",
			"_Classification_Name": "Alpha",
            "_Assigned_WorkGroup_Name": "abc",
            "Priority_Name": "Priority-1",
			"Symptom": "Symptom",
			"_Description": "_Description",
			"CustomFields": [
				{
					"GroupName": "ServiceNow Details",
					"Attribute_Name": "Ticket No.",
					"Attribute_Value": "#Attribute_Value1#"
				}				
			]
		}
	}
}

Request Parameters

Parameter NameTypeDescriptionMandatory

IsWebServiceRequest

BOOLEAN

Is the Request from Web Service?

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

Module

STRING

The name of the module.

For Example: Incident Management (IM).

TRUE

ModuleTicketNumber

STRING

The module ticket number of Incident Management.

TRUE

_Classification_Name

STRING

The name of the classification of a Incident Management.

TRUE

Priority_Name

STRING

The name of the Priority of a of Incident Management.

TRUE

Symptom

STRING

The symptom of the Work Order.

TRUE

_Description

STRING

The description for the Work Order.

 TRUE

_Assigned_WorkGroup_Name

STRING

Workgroup defines a group of members in an Instance or a unit of an organization.

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": "",
    "Message": "Successfully WorkOrder Added : WO654",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": "10505968279EFE37030E29C050C9C8C332E6201838557D5260ACB41B909C15F6D47406ECFA46909C78C77E48977DD3059A7DC4266FDD8DEBCC8E51626F3277C167D0A384BDA3D4EFF7A6B4CFF5993106C1E4BE965E5660CEE1D8566C459887C53FCB955D16D999A80FDA5477B28E8515",
    "TicketID_Encrypted": null,
    "TicketID_Internal": 1651,
    "TicketNo": 654
}

Status and Error Codes

For more information, see Status and Error Messages.