Endpoint Get Contracts
Name
get_contracts
Description
Related Tables
Parameters
| Parameter | Required | Options | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| name |
DT_WSTR
|
nvarchar(300)
|
300 | |
| owner_email_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| owner_is_technician |
DT_BOOL
|
bit
|
||
| owner_sms_mail |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_mobile |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_last_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| owner_user_scope |
DT_WSTR
|
nvarchar(100)
|
100 | |
| owner_sms_mail_id |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_cost_per_hour |
DT_WSTR
|
nvarchar(50)
|
50 | |
| owner_site_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| owner_phone |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_employee_id |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| owner_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| owner_photo_url |
DT_WSTR
|
nvarchar(100)
|
100 | |
| owner_is_vip_user |
DT_BOOL
|
bit
|
||
| owner_department |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| owner_first_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| owner_job_title |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| template_inactive |
DT_BOOL
|
bit
|
||
| template_name |
DT_WSTR
|
nvarchar(100)
|
100 | |
| template_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| is_definite |
DT_BOOL
|
bit
|
||
| cost_display_value |
DT_WSTR
|
nvarchar(50)
|
50 | |
| cost_currency_symbol |
DT_WSTR
|
nvarchar(50)
|
50 | |
| cost_value |
DT_I4
|
int
|
||
| cost_secondary_currency_display_value |
DT_I4
|
int
|
||
| cost_secondary_currency_currency_symbol |
DT_WSTR
|
nvarchar(50)
|
50 | |
| cost_secondary_currency_value |
DT_I4
|
int
|
||
| request_creation_days |
DT_WSTR
|
nvarchar(50)
|
50 | |
| display_id_display_value |
DT_WSTR
|
nvarchar(50)
|
50 | |
| display_id_value |
DT_WSTR
|
nvarchar(50)
|
50 | |
| sites |
DT_WSTR
|
nvarchar(500)
|
500 | |
| active_from_display_value |
DT_WSTR
|
nvarchar(50)
|
50 | |
| active_from_value |
DT_WSTR
|
nvarchar(100)
|
100 | |
| type |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| is_req_creation_required |
DT_BOOL
|
bit
|
||
| vendor_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| vendor_description |
DT_WSTR
|
nvarchar(100)
|
100 | |
| vendor_currency_symbol |
DT_WSTR
|
nvarchar(50)
|
50 | |
| vendor_currency_code |
DT_WSTR
|
nvarchar(50)
|
50 | |
| vendor_currency_exchange_rate |
DT_WSTR
|
nvarchar(50)
|
50 | |
| vendor_currency_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| vendor_currency_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| vendor_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| is_draft |
DT_BOOL
|
bit
|
||
| active_till_display_value |
DT_WSTR
|
nvarchar(50)
|
50 | |
| active_till_value |
DT_WSTR
|
nvarchar(100)
|
100 | |
| currency_symbol |
DT_WSTR
|
nvarchar(50)
|
50 | |
| currency_code |
DT_WSTR
|
nvarchar(50)
|
50 | |
| currency_exchange_rate |
DT_WSTR
|
nvarchar(50)
|
50 | |
| currency_is_frequent |
DT_BOOL
|
bit
|
||
| currency_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| currency_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| deleted_time |
DT_WSTR
|
nvarchar(1020)
|
1020 | |
| notes_present |
DT_BOOL
|
bit
|
||
| status_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| status_id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| type_color |
DT_WSTR
|
nvarchar(50)
|
50 | |
| type_name |
DT_WSTR
|
nvarchar(50)
|
50 | |
| type_id |
DT_WSTR
|
nvarchar(100)
|
100 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use ManageEngine ServiceDesk Plus (Zoho) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Contracts table, therefore it is better to use it, instead of accessing the endpoint directly:
| Optional Parameters | |
|---|---|
| ContineOn404Error | True |
API Destination
This Endpoint belongs to the Contracts table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get contracts:
| Optional Parameters | |
|---|---|
| ContineOn404Error | True |
ODBC application
Use these SQL queries in your ODBC application data source:
Read contracts
<p>Reads all contracts stored in the system. This helps in managing vendor agreements, software licenses, and maintenance contracts.</p> <p>The <code>Contracts</code> table lists all active and expired contracts, providing an overview of legal and financial obligations.</p>
SELECT * FROM Contracts
get_contracts endpoint belongs to
Contracts
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read contracts
<p>Reads all contracts stored in the system. This helps in managing vendor agreements, software licenses, and maintenance contracts.</p> <p>The <code>Contracts</code> table lists all active and expired contracts, providing an overview of legal and financial obligations.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Contracts';
EXEC (@MyQuery) AT [LS_TO_MANAGEENGINE_SERVICEDESK_PLUS_ZOHO_IN_GATEWAY];
get_contracts endpoint belongs to
Contracts
table(s), and can therefore be used via those table(s).