Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Current »

Service Name: WO_UpdateWorkorderDetails | Description
Updates all the details of a Workorder

URL

http://<<Customer_URL>>/REST/Summit_RESTWCF.svc/RESTService/Common WS_JsonObjCall
Replace <Customer_URL> with the customer’s Host name.

Method

POST

Request

Sample Request 
{
  "ServiceName": "WO_UpdateWorkorderDetails",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXX",
      "ProxyID": 0,
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "oWorkorderParam": {
      "IsWebServiceRequest": true,
      "LoggedAnalystEmailID": "LoggedAnalyst@xyz.com",
      "_Sup_Function": "IT",
      "_Workorder_No": "212",
      "_Status": "Resolved",
      "_Assigned_Engineer_Email": "AssignedEngineer@xyz.com",
      "_Classification": null,
      "_Category": null,
      "Priority_Name": "Priority1",
      "_PendingReason": "Awaiting Response",
      "CancelRemarks": "cancelled",
      "_Closure_Code_Name": "Closed",
      "_Assigned_WorkGroup_Name": "Workgroup1",
      "CustomFields": [
        {
          "GroupName": "Default Group",
          "Attribute_Name": "GTB",
          "Attribute_Value": "gtbvalue23455",
          "GroupArea": "General Area"
        },
        {
          "GroupName": "Default Group",
          "Attribute_Name": "gDrp",
          "Attribute_Value": "3000",
          "GroupArea": "General Area"
        },
        {
          "GroupName": "Default Group",
          "Attribute_Name": "GDate",
          "Attribute_Value": "2018-08-23",
          "GroupArea": "General Area"
        },
        {
          "GroupName": "Default Group",
          "Attribute_Name": "GWebsite",
          "Attribute_Value": "https://docs.microsoft.com",
          "GroupArea": "General Area"
        },
        {
          "GroupName": "Default Group",
          "Attribute_Name": "GChk",
          "Attribute_Value": "true",
          "GroupArea": "General Area"
        },
        {
          "GroupName": "Default Group",
          "Attribute_Name": "Text",
          "Attribute_Value": "Text area data",
          "GroupArea": "General Area"
        }
      ],
      "EffortEstimation": {
        "NumberOfDays": "1",
        "NumberOfHours": "1",
        "NumberOfMinutes": "20",
        "EffortComments": "test from api"
      },
      "Communication": {
        "_Information": "information 1",
        "_UserLog": "_UserLog 1",
        "_InternalLog": "_InternalLog 1",
        "_Solution": "_Solution 1"
      },
      "SRCommunication": {
        "_UserLog": "SR_UserLog 1",
        "_InternalLog": "SR_InternalLog 1"
      }
    }
  }
}

Request Parameters

Parameter NameTypeDescriptionNotes

IsWebServiceRequest * 

BOOLEAN

Unique Identification of the Organization.


LoggedAnalystEmailID * 

STRING

Name of the Instance.

For Example: Information Technology

_Sup_Function * 

STRING



_Workorder_No * 

INTEGER



_Status * 

STRING



_Assigned_Engineer_Email * 

STRING



_Classification * 

STRING



_Category * 

STRING



Priority_Name * 

STRING



_PendingReason * 

STRING



CancelRemarks

STRING



_Closure_Code_Name

STRING



_Assigned_WorkGroup_Name

STRING



GroupName

STRING



Attribute_Name

STRING



Attribute_Value

INTEGER



GroupArea

STRING



* Indicates mandatory fields

Run API

Go to the Web Services page in the SummiAI application to execute the APIs and see the response.


Response

Sample Response 
{
  "Errors": "",
  "Message": "",
  "OrgID": 0,
  "Output": "Service request Details Updated Successfully.",
  "OutputObject": null,
  "TokenID": ""
}

Note:

The Response Parameters are dynamic and based on the selections made by the user.

Status and Error Codes

See: Status and Error Messages

  • No labels