Create a New Service Request

You can create a new Service Request using the following API Request with Catalog Fields or User Selectable Approvers or Custom Fields.

Service Name	HTTP Method
SR_LogServiceRequestCatalog	POST

SR with Catalog Fields

SR with User Selectable Approvers

SR with SR Custom Fields

Sample Request

{
  "ServiceName": "SR_LogServiceRequestCatalog",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXXX",
      "ProxyID": 0,
      "TokenID": "",
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "SR_TicketParame": {
      "Instance": "IT",
      "ServiceCatalogID": "13",
      "ServiceCatalogName": "",
      "RequesterEmailID": "Requester@email.com",
      "RequesterEmpID": "",
      "SRRemarks": "This is just for testing - please ignore",
      "LoggedByEmailID": "LoggedBy@email.com",
      "LoggedByEmpID": "",
      "CustomFields": [
        {
          "GroupName": "Contractor",
          "AttributeName": "Candidate Name",
          "AttributeValue": "Pawan"
        },
        {
          "GroupName": "Contractor",
          "AttributeName": "Gender",
          "AttributeValue": "Male"
        }
      ],
      "MVCustomFields": [
        {
          "GroupName": "MVDefault Group",
          "AttributeName": "DDValues",
          "AttributeValue": "AA",
          "RowID": "1"
        }
      ]
    }
  }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
Instance	STRING	Name of the Instance. For Example: Info	TRUE
ServiceCatalogID	INTEGER	Unique Identification number of the Service Catalog. Note: It is mandatory to provide either ServiceCatalogID or ServiceCatalogName value.	TRUE
ServiceCatalogName	STRING	Name of the Service Catalog.	TRUE If ServiceCatalogID value is provided then it is not mandatory.
RequesterEmailID	STRING	E-mail Id of the Requester. Note: It is mandatory to provide either RequesterEmailID or RequesterEmpID value.	TRUE
RequesterEmpID	STRING	Employee Id of the Requester.	TRUE If RequesterEmailIDvalue is provided then it is not mandatory.
SRRemarks	STRING	Remarks or comments about the SR. Note: It depends upon the Tenant level configuration. If you make it mandatory in Tenant level then it is True.	TRUE
LoggedByEmailID	STRING	E-mail Id of the logged-in User. Note: It is mandatory to provide either LoggedByEmailID or LoggedByEmpID value.	TRUE
LoggedByEmpID	STRING	Employee Id of the logged-in User.	TRUE If LoggedByEmailIDvalue is provided then it is not mandatory.
CustomFields	ARRAY	Custom Fields of the specified Service Catalog. These Custom Fields array includes the following parameters: GroupName AttributeName AttributeValue	FALSE
MVCustomFields	ARRAY	Specify the Multi-valued Custom Fields to display the various groups in multiple row. These Custom Fields array includes the following parameters: GroupName AttributeName AttributeValue RowID	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Successfully saved the service request. Service Request ID:  2854",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2113,
    "TicketNo": 2132
}

Sample Request

{
  "ServiceName": "SR_LogServiceRequestCatalog",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXX",
      "ProxyID": 0,
      "TokenID": "",
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "SR_TicketParame": {
      "Instance": "IT",
      "ServiceCatalogID": "13",
      "ServiceCatalogName": "",
      "RequesterEmailID": "Requester@email.com",
      "RequesterEmpID": "",
      "SRRemarks": "This is just for testing - please ignore",
      "LoggedByEmailID": "LoggedBy@email.com",
	  "LoggedByEmpID": "",
      "SRRemarks": "This is just for testing - please ignore",
      "CustomFields": [
        {
          "GroupName": "Contractor",
          "AttributeName": "Candidate Name",
          "AttributeValue": "Pawan"
        },
        {
          "GroupName": "Contractor",
          "AttributeName": "Gender",
          "AttributeValue": "Male"
        }
      ],
      "Approvals": [
        {
          "ApproverEmailId": "vive",
          "ApproverEmpId": "Name",
          "ApproverUserID": 0,
	      "ApproverMobileNo": ""
        }
      ],
      "MVCustomFields": [
        {
          "GroupName": "MVDefault Group",
          "AttributeName": "DDValues",
          "AttributeValue": "AA",
          "RowID": "1"
        }
      ]
    }
  }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
Instance	STRING	Name of the Instance. For Example: Info	TRUE
ServiceCatalogID	STRING	Unique Identification number of the Service Catalog. Note: It is mandatory to provide either ServiceCatalogID or ServiceCatalogName value.	TRUE
ServiceCatalogName	STRING	Name of the Service Catalog	TRUE If ServiceCatalogID value is provided then it is not mandatory.
RequesterEmailID	STRING	E-mail Id of the Requester. Note: It is mandatory to provide either RequesterEmailID or RequesterEmpID value.	TRUE
RequesterEmpID	STRING	Employee Id of the Requester.	TRUE If RequesterEmailID value is provided then it is not mandatory.
SRRemarks	STRING	Remarks or comments about the SR. Note: It depends upon the Tenant level configuration. If you make it mandatory in Tenant level then it is True.	TRUE
LoggedByEmailID	STRING	E-mail Id of the logged-in User. Note: It is mandatory to provide either LoggedByEmailID or LoggedByEmpID value.	TRUE
LoggedByEmpID	STRING	Employee Id of the logged-in User.	TRUE If LoggedByEmailID value is provided then it is not mandatory.
CustomFields	ARRAY	Custom Fields of the specified Service Catalog. These Custom Fields include the following parameters: GroupName AttributeName AttributeValue	FALSE
Approvals	ARRAY	Specify this parameter to configure the Approval Levels for the Service Request. The Approvals array includes the following paramers: ApproverEmailId ApproverEmpId ApproverUserID ApproverMobileNo	TRUE
MVCustomFields	ARRAY	Specify the Multi-valued Custom Fields to display the various groups in multiple row. These Custom Fields array includes the following parameters: GroupName AttributeName AttributeValue	FALSE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Successfully saved the service request. Service Request ID:  2854",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2113,
    "TicketNo": 2132
}

{
  "ServiceName": "SR_LogServiceRequestCatalog",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXXX",
      "ProxyID": 0,
      "TokenID": "",
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "SR_TicketParame": {
      "Instance": "IT",
      "ServiceCatalogID": "13",
      "ServiceCatalogName": "",
      "RequesterEmailID": "Requester@email.com",
      "RequesterEmpID": "",
      "SRRemarks": "This is just for testing - please ignore",
      "LoggedByEmailID": "LoggedBy@email.com",
	  "LoggedByEmpID": "",
      "CustomFields": [
        {
          "GroupName": "Contractor",
          "AttributeName": "Candidate Name",
          "AttributeValue": "Pawan"
        },
        {
          "GroupName": "Contractor",
          "AttributeName": "Gender",
          "AttributeValue": "Male"
        }
      ],
      "Approvals": [
        {
          "ApproverEmailId": "vive",
          "ApproverEmpId": "Name",
          "ApproverUserID": 0,
	      "ApproverMobileNo": ""
        }
      ],
      "MVCustomFields": [
        {
          "GroupName": "MVDefault Group",
          "AttributeName": "DDValues",
          "AttributeValue": "AA",
          "RowID": "1"
        }
      ],
      "SRCustomFields": [
        {
          "GroupName": "Default Group",
          "AttributeName": "SOM Request Number",
          "AttributeValue": "SR2345"
        }
      ]
    }
  }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
Instance	STRING	Name of the Instance. For Example: Info	TRUE
ServiceCatalogID	STRING	Unique Identification number of the Service Catalog. Note: It is mandatory to provide either ServiceCatalogID or ServiceCatalogName value.	TRUE
ServiceCatalogName	STRING	Name of the Service Catalog	TRUE If ServiceCatalogID value is provided then it is not mandatory.
RequesterEmailID	STRING	E-mail Id of the Requester. Note: It is mandatory to provide either RequesterEmailID or RequesterEmpID value.	TRUE
RequesterEmpID	STRING	Employee Id of the Requester.	TRUE If RequesterEmailID value is provided then it is not mandatory.
SRRemarks	STRING	Remarks or comments about the SR. Note: It depends upon the Tenant level configuration. If you make it mandatory in Tenant level then it is True.	TRUE
LoggedByEmailID	STRING	E-mail Id of the logged-in User. Note: It is mandatory to provide either LoggedByEmailID or LoggedByEmpID value.	TRUE
LoggedByEmpID	STRING	Employee Id of the logged-in User.	TRUE If LoggedByEmailIDvalue is provided then it is not mandatory.
CustomFields	ARRAY	Custom Fields of the specified Service Catalog. These Custom Fields include the following parameters: GroupName AttributeName AttributeValue	FALSE
Approvals	ARRAY	Specify this parameter to configure the Approval Levels for the Service Request. The Approvals array includes the following paramers: ApproverEmailId ApproverEmpId ApproverUserID ApproverMobileNo	TRUE
MVCustomFields	ARRAY	Specify the Multi-valued Custom Fields to display the various groups in multiple row. These Custom Fields array includes the following parameters: GroupName AttributeName AttributeValue RowID	FALSE
SRCustomFields	ARRAY	Specify the Multi-valued Custom Fields to display the various groups in multiple row. These Custom Fields array includes the following parameters: GroupName AttributeName AttributeValue	TRUE

Sample Response

{
    "Errors": "",
    "Input": null,
    "Message": "Successfully saved the service request. Service Request ID:  2854",
    "OrgID": 0,
    "Output": null,
    "OutputID": 0,
    "OutputObject": null,
    "TokenID": null,
    "TicketID_Encrypted": null,
    "TicketID_Internal": 2113,
    "TicketNo": 2132
}