Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the hideelements-macro macro with the following parameter(s): []
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

truetruetruetrue

You can retrieve Service Requests that are in Open Status, assigned to an Engineer, or SRs between a date range using the following API Request. 

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

Service NameHTTP Method
SR_UpdateServiceRequest 

POST

Ui tabs
Ui tab
titleOpen SRs
DJangoSample Requesttrue

Assigned StatusRequest Parameters

Parameter NameTypeDescriptionMandatory

Executive 

BlueBOOLEAN

Is Executive or not?

The value is either 0 or 1. The executive is an Analyst.

  • If you want to get the Analyst Incidents, select the value as 1
  • If you want to get the End User Incidents, select the value as 0.

Greentrue

WorkgroupName 

GreenString

Name of the Work Group.

You can retrieve multiple workgroup Incidents using comma separation between the workgroup names without a space.

For Example:

"WorkgroupName": "WG1,WG2,WG3".

Greentrue

CurrentPageIndex 

BlueBOOLEAN

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.

Greentrue

PageSize

GreyINTEGER

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

Greyfalse

OrgID 

GreyINTEGER

Unique Identification number of the Organization.

Greentrue

Instance 

GreenString

Name of the Instance.

For Example: Info

Greentrue

Status 

GreenString

Status of the SRs that should be displayed.

The value must be Open for this Request.

Greentrue

strUpdatedFromDate

GreenString

You can select the date range to get the list of SRs. Specify the From Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date.

Greyfalse

strUpdatedToDate

GreenString

You can select the date range to get the list of SRs. Specify the To Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date.

Greyfalse

IsWebServiceRequest 

BlueBOOLEAN

Is the Request from Web Service?

Greentrue

DJangoSample Responsetrue
Ui tab
titleAssigned Engineer's SRs
DJangoSample Requesttrue

Request Parameters

Parameter NameTypeDescriptionMandatory

Executive 

BlueBOOLEAN

Is Executive or not?

The value is either 0 or 1. The executive is an Analyst.

  • If you want to get the Analyst Incidents, select the value as 1
  • If you want to get the End User Incidents, select the value as 0.

Greentrue

WorkgroupName 

GreenString

Name of the Work Group.

You can retrieve multiple workgroup Incidents using comma separation between the workgroup names without a space.

For Example:

"WorkgroupName": "WG1,WG2,WG3"

Greentrue

CurrentPageIndex 

BlueBOOLEAN

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.

Greentrue

PageSize 

GreyINTEGER

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

Greentrue

OrgID 

GreyINTEGER

Unique Identification number of the Organization.

Greentrue

Instance 

GreenString

Name of the Instance.

For Example: Info

Greentrue

Status

GreenString

Status of the SRs that should be displayed.

Greyfalse

ExecutiveEmailId 

GreenString

E-mail ID of the Assigned Engineer.

Greentrue

strUpdatedFromDate

GreenString

You can select the date range to get the list of SRs. Specify the From Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date.

Greyfalse

strUpdatedToDate

GreenString

You can select the date range to get the list of SRs. Specify the To Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date.

Greyfalse

DJangoSample Responsetrue
Ui tab
titleSRs in Date Range
DJangoSample Requesttrue

Request Parameters

Parameter NameTypeDescriptionMandatory

Executive 

BlueBOOLEAN

Is Executive or not?

The value is either 0 or 1. The executive is an Analyst.

  • If you want to get the Analyst Incidents, select the value as 1
  • If you want to get the End User Incidents, select the value as 0.

Greentrue

WorkgroupName 

GreenString

Name of the Work Group.

You can retrieve multiple workgroup Incidents using comma separation between the workgroup names without a space.

For Example:

"WorkgroupName": "WG1,WG2,WG3"

Greentrue

CurrentPageIndex 

BlueBOOLEAN

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.

Greentrue

PageSize 

GreyINTEGER

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

Greentrue

OrgID 

GreyINTEGER

Unique Identification number of the Organization.

Greentrue

Instance 

GreenString

Name of the Instance.

For Example: Info

Greentrue

Status

GreenString

Status of the SRs that should be displayed.

Greyfalse

strUpdatedFromDate 

GreenString

You can select the date range to get the list of SRs. Specify the From Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date.

Greentrue

strUpdatedToDate 

GreenString

You can select the date range to get the list of SRs. Specify the To Date of the Incidents that you want to be displayed.

The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date.

Greentrue

DJangoSample 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

| |