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

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. 

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

Service NameHTTP Method
WO_CreateORUpdateWorkOrder 

POST

Ui tabs
Ui tab
titleAssigned
Sample Requesttrue

Assigned StatusRequest Parameters

Parameter NameTypeDescriptionMandatory

IsWebServiceRequest

GreenString

Is the Request from Web Service?

Greentrue

_Workorder_No

GreenString

The unique Identification number of a work order.

Greentrue

LoggedAnalystEmailID

GreenString

The e-mail Id of the logged-in analyst.

Note:
It is mandatory to provide LoggedAnalystEmailID
value.

Greentrue

_Sup_Function

GreenString

The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy.

For Example: Info

Greentrue

_Status

GreenString

The status of the work order. The value of the status should be assigned for this request

Greentrue

_Assigned_WorkGroup_Name

GreenString

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

Greentrue

_Classification_Name

GreenString

The name of the classification of work order.

GreyFALSE

Priority_Name

GreenString

The name of the priority of a of work order.

GreyFALSE

_UserLog

GreenString

The user communication of work order.

GreyFALSE

_InternalLog

GreenString

The internal log of work order.

GreyFALSE

CustomFields

GreenString

The custom fields of the specified work order. 
These custom fields include the following 
parameters: 

  • GroupName
  • AttributeName
  • AttributeValue

GreyFALSE

Sample Responsetrue
Ui tab
titleIn-Progress
Sample Requesttrue

In-Progress StatusRequest Parameters

Parameter NameTypeDescriptionMandatory
IsWebServiceRequest

BlueBoolean

Is the Request from Web Service? 

Greentrue

_Workorder_No

GreenString

The unique identification number of a work order.

Greentrue

LoggedAnalystEmailID

GreenString

E-mail Id of the logged-in analyst.

Note:
It is mandatory to provide LoggedAnalystEmailID
value.

Greentrue

_Sup_Function

GreenString

The name of the instance code. It defines a business unit, an entity, or a department in an organizational hierarchy.

For Example: Info

Greentrue

_Status 

GreenString

Status of the work order. The value of the Status should be Assigned for this Request.

Greentrue

_Assigned_Engineer_Email

GreenString

The e-mail id of the assigned engineer.

Greentrue

_Assigned_WorkGroup_Name

GreenString

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

Greentrue

_Classification_Name

GreenString

The name of the classification of work order.

GreyFALSE

Priority_Name

GreenString

The name of the priority of a of work order.

GreyFALSE

_UserLog

GreenString

The user communication of work order.

GreyFALSE

_InternalLog

GreenString

The internal log of work order.

GreyFALSE

CustomFields

GreenString

The custom fields of the specified work order. 
These custom fields include the following 
parameters: 

  • GroupName
  • AttributeName
  • AttributeValue

GreyFALSE

Sample Responsetrue
Ui tab
titlePending
Sample Requesttrue

Pending StatusRequest Parameters

Parameter NameTypeDescriptionMandatory

IsWebServiceRequest

GreenString

Is the Request from Web Service?

Greentrue

_Workorder_No

GreenString

The unique identification number of a work order.

Greentrue

LoggedAnalystEmailID

GreenString

The e-mail Id of the logged-in analyst.

Note:
It is mandatory to provide LoggedAnalystEmailID
value.

Greentrue

_Sup_Function

GreenString

The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy.

For Example: Info

Greentrue

_Status

GreenString

The status of the work order. The value of the status should be assigned for this request

Greentrue

_Assigned_Engineer_Email 

GreenString

The e-mail id of the assigned engineer.

Greentrue

_Assigned_WorkGroup_Name

GreenString

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

Greentrue

_PendingReason

GreenString

The pending reason for the work order. This is an mandatory field.

Greentrue

_Classification_Name

GreenString

The name of the classification of work order.

GreyFALSE

Priority_Name

GreenString

The name of the priority of a of work order.

GreyFALSE

_UserLog

GreenString

The user communication of work order.

GreyFALSE

_InternalLog

GreenString

The internal log of work order.

GreyFALSE

CustomFields

GreenString

The custom fields of the specified work order. 
These custom fields include the following 
parameters: 

  • GroupName
  • AttributeName
  • AttributeValue

GreyFALSE

Sample Responsetrue
Ui tab
titleResolved
Sample Requesttrue

Resolved StatusRequest Parameters

Parameter NameTypeDescriptionMandatory

IsWebServiceRequest

BlueBoolean

Is the Request from Web Service? 

Greentrue

_Workorder_No

GreenString

The unique Identification number of a work order.

Greentrue

LoggedAnalystEmailID

GreenString

The e-mail Id of the logged-in analyst.

Note:
It is mandatory to provide LoggedAnalystEmailID
value.

Greentrue

_Sup_Function

GreenString

The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy.

For Example: Info

Greentrue

_Status

GreenString

The status of the work order. The value of the status should be assigned for this request.

Greentrue

_Assigned_Engineer_Email

GreenString

The e-mail id of the assigned engineer.

Greentrue

_Assigned_WorkGroup_Name 

GreenString

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

Greentrue

_Closure_Code_Name

GreenString

The closure code is the status code used by analysts to resolve an Incident. It is applicable only for the auto closure.

Greentrue

_Solution

GreenString

The resolution comments of work order. 

Greentrue

_Classification_Name

GreenString

The name of the classification of work order.

GreyFALSE

Priority_Name

GreenString

The name of the priority of a of work order.

GreyFALSE

_UserLog

GreenString

The user communication of work order.

GreyFALSE

_InternalLog

GreenString

The internal log of work order.

GreyFALSE

CustomFields

GreenString

The custom fields of the specified work order. 
These custom fields include the following 
parameters: 

  • GroupName
  • AttributeName
  • AttributeValue

GreyFALSE

Sample Responsetrue
Ui tab
titleCancelled
Sample Requesttrue

Cancelled StatusRequest Parameters

Parameter NameTypeDescriptionMandatory

IsWebServiceRequest

BlueBoolean

Is the Request from Web Service?

Greentrue

_Workorder_No

GreenString

The unique Identification number of a work order.

Greentrue

LoggedAnalystEmailID

GreenString

The e-mail Id of the logged-in analyst.

Note: It is mandatory to provide LoggedAnalystEmailIDvalue

Greentrue

_Sup_Function

GreenString

The name of the Instance code. It defines a business unit, an entity, or a department in an organizational hierarchy.

For Example: Info

Greentrue

_Status 

GreenString

The status of the work order. The value of the Status should be assigned for this request.

Greentrue

_Assigned_Engineer_Email 

GreenString

The e-mail id of the assigned engineer.

Greentrue

_Assigned_WorkGroup_Name

GreenString

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

Greentrue

CancelRemarks

GreenString

The additional information about the Cancellation of a work order. 

Greentrue

_Classification_Name

GreenString

The name of the classification of work order.

GreyFALSE

Priority_Name

GreenString

The name of the Priority of a of work order.

GreyFALSE

_UserLog

GreenString

The user communication of work order.

GreyFALSE

_InternalLog

GreenString

The internal log of work order.

GreyFALSE

CustomFields

GreenString

The custom fields of the specified work order. 
These custom fields include the following 
parameters: 

  • GroupName
  • AttributeName
  • AttributeValue

GreyFALSE

Sample Responsetrue

Status and Error Codes

For more information, see: Status and Error Messages.

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |