Entities and Endpoints
Authentication
| API | Description |
|---|---|
| POST api/Authentication/login |
No documentation available. |
| POST api/Authentication/confirm-otp |
No documentation available. |
| POST api/Authentication/contact-authtoken |
No documentation available. |
| DELETE api/Authentication/delete-accesstoken |
No documentation available. |
Contact
Contacts are the person that can log on ServiceDesk.
| API | Description |
|---|---|
| GET api/Contact/SendPasswordReminder?domain={domain}&e_login={e_login} |
Send the password of this contact.e_login by email to his email address |
| PUT api/Contact/UpdateAccount?e_login={e_login}&new_e_password={new_e_password} |
Update the password of this contact.e_login |
| GET api/Contact/GetByAccount?e_login={e_login}&e_password={e_password} |
Get information base on account |
| GET api/Contact/GetCompanyLinkedContact?contact_id={contact_id} |
No documentation available. |
| GET api/Contact |
Retrieves all contacts you have access |
Contact Request
| API | Description |
|---|---|
| PUT api/ContactPlug/request-changepw |
No documentation available. |
| PUT api/ContactPlug/verify-changepw |
No documentation available. |
Contract Status
Contract statuses
| API | Description |
|---|---|
| GET api/ContractStatus/Translations |
No documentation available. |
| GET api/ContractStatus |
Retrieves all contract statuses available for ServiceDesk |
| GET api/ContractStatus(id) |
Retrieves the task type with the specified key |
Contract Type
Contract type
| API | Description |
|---|---|
| GET api/ContractType/Translations |
No documentation available. |
| GET api/ContractType |
Retrieves all contract type available for ServiceDesk |
| GET api/ContractType(id) |
Retrieves the task type with the specified key |
Contract View
Contract View
| API | Description |
|---|---|
| GET api/ContractView/ContractEntitlementsByProject?projectId={projectId} |
Retrieves contract entitlement information for a project |
Db Address
Addresses of companies. Project can use the default company address or a specific one
| API | Description |
|---|---|
| GET api/DbAddress/SearchByKeyword?keyword={keyword} |
No documentation available. |
| GET api/DbAddress |
Retrieves all db_address of companies the logged contact has access to |
Db File
Add files to a task
| API | Description |
|---|---|
| POST api/DbFile/Add?db_table_id={db_table_id}&id_in_table={id_in_table}&description={description} |
Uses to upload files to a entity (like a task) POST your file on request body with other params on query string. |
Db File View
Document system.Files can be linked to companies, tasks or Job (Job Approval)
| API | Description |
|---|---|
| GET api/DbFileView/GetFileContent/{id} |
Get the content of the file |
| GET api/DbFileView/GetFileThumbnail/{id}?maxWidth={maxWidth}&maxHeight={maxHeight} |
Get a thumbnail of a file (if JPG/PNG/BMP). Otherwhise the full content is retrieved |
| POST api/DbFileView/Download |
No documentation available. |
| POST api/DbFileView/DownloadAll |
No documentation available. |
| POST api/DbFileView/Search?withData={withData} |
No documentation available. |
| GET api/DbFileView/ListCreateYear |
No documentation available. |
| GET api/DbFileView/View/{id} |
No documentation available. |
| GET api/DbFileView |
Retrieves all files linked to Company/Task/Project and Job Aproval PDF for logged in contact. |
Db Report Type View
Job types (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/DbReportTypeView |
Retrieves all db report types available for ServiceDesk |
| GET api/DbReportTypeView(id) |
Retrieves the db report type with the specified key |
Equipment Brand
Equipment Brand
| API | Description |
|---|---|
| GET api/EquipmentBrand |
Retrieves all the equipment brand |
| GET api/EquipmentBrand(id) |
Retrieves the equipment brand with the specified key |
Equipment Family
Project types
| API | Description |
|---|---|
| GET api/EquipmentFamily |
Retrieves all the equipment_family objects |
| GET api/EquipmentFamily(id) |
Retrieves the equipment_family object with the specified key |
Equipment Model
Equipment Model
| API | Description |
|---|---|
| GET api/EquipmentModel |
Retrieves all the equipment models |
| GET api/EquipmentModel(id) |
Retrieves the equipment model with the specified key |
Invoices
Invoice View Controller - Read-only API for retrieving invoices
| API | Description |
|---|---|
| GET api/Invoices/View/{id} |
View Invoice PDF This endpoint returns the PDF representation of a single invoice. Returns the PDF file for the requested invoice. The system locates the PDF as follows: - If the invoice was created manually (source_id_in_table = '00000000-0000-0000-0000-000000000000'), the PDF is retrieved from the invoice_files table using dbFactory.invoice.GetInvoicePDF(invoice_id). - If the invoice was not created manually (source_id_in_table <> '00000000-0000-0000-0000-000000000000') and the source is a contract or work order, the PDF is retrieved via dbFactory.job_files.get(id). |
| POST api/Invoices/Download |
Download Invoice PDF(s) This endpoint downloads the PDF file for a specific selected invoice. Returns the PDF file for the specified invoice. The system locates the PDF as follows: - If the invoice was created manually (source_id_in_table = '00000000-0000-0000-0000-000000000000'), the PDF is retrieved from the invoice_files table using dbFactory.invoice.GetInvoicePDF(invoice_id). - If the invoice was not created manually (source_id_in_table <> '00000000-0000-0000-0000-000000000000') and the source is a contract or work order, the PDF is retrieved via dbFactory.job_files.get(id). |
| POST api/Invoices/DownloadAll |
Download All Invoice PDFs in a Date Range This endpoint downloads all invoice PDFs whose confirmation date falls within a specified range. Generates a downloadable file (such as a ZIP archive) containing the PDF files for all invoices whose dateutc_confirmation falls within the specified date range and file_type='INVOICEPDF' |
| GET api/Invoices |
Retrieves invoices by date range (OData endpoint) Example: /api/Invoices?$filter=dateutc_confirmation ge 2025-01-01T00:00:00Z and dateutc_confirmation le 2025-12-31T23:59:59Z and invoice_type eq 'Invoice' |
| GET api/Invoices(id) |
Retrieves the invoice with the specified key |
Job Approval
Contains all information about the Dialy or full work order approvals
| API | Description |
|---|---|
| GET api/JobApproval |
Retrieves all the job approvals |
| GET api/JobApproval(id) |
Retrieves the job approval with the specified key |
Job Planning View
Planning of jobs including foreign key values
| API | Description |
|---|---|
| GET api/JobPlanningView |
Retrieves all job_planning linked to jobs the logged contact has access to |
| GET api/JobPlanningView(id) |
Retrieves the job_planning with the specified key |
Job Status View
job statuses (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/JobStatusView/Translations |
No documentation available. |
| GET api/JobStatusView |
Retrieves all job statuses available for ServiceDesk |
| GET api/JobStatusView(id) |
Retrieves the task type with the specified key |
Jobs View
Work orders Main object
| API | Description |
|---|---|
| GET api/JobsView/GetPending |
Retrieves the root work order (no parent) with status NOT (Completed+Canceled) |
| GET api/JobsView/GetCompleted |
Retrieves the root work order (no parent) with status (Completed+Canceled) |
| GET api/JobsView/GetAllJobsLinkToProject?project_id={project_id} |
Retrieves all jobs that linked to a specific project don't care if it is root or child job |
| POST api/JobsView/SearchAllJobsOfLocation |
Retrieves all jobs of location |
| POST api/JobsView/SearchAllJobsLinkToProject |
Retrieves all jobs that linked to a specific project don't care if it is root or child job |
| GET api/JobsView/GetAllTechnicianRemarksOfJob?jobs_id={jobs_id} |
Retrieves all technician remarks of a specific job |
| POST api/JobsView/Search |
No documentation available. |
| GET api/JobsView |
Retrieves all the work orders the logged contact has cacess to |
| GET api/JobsView(id) |
Retrieves the work order with the specified key |
Job Type View
Job types (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/JobTypeView/Translations |
No documentation available. |
| GET api/JobTypeView |
Retrieves all job types available for ServiceDesk |
| GET api/JobTypeView(id) |
Retrieves the task type with the specified key |
Layout Settings
Layout settings contains like the Logo of the implementation
| API | Description |
|---|---|
| GET api/LayoutSettings/GetCustomizedLogo?width={width}&height={height} |
Retrieve the logo of the implementation (Response.Content and Response.Headers.ContentType).If no logo available, return a Byte[0] |
Project Bill Of Material
Projects (Equipments, Installation)
| API | Description |
|---|---|
| GET api/ProjectBillOfMaterial/GetByProject |
Retrieves the bill of materials for the specified project. |
| GET api/ProjectBillOfMaterial |
No documentation available. |
| GET api/ProjectBillOfMaterial(id) |
No documentation available. |
| POST api/ProjectBillOfMaterial |
No documentation available. |
| PUT api/ProjectBillOfMaterial(id) |
No documentation available. |
| DELETE api/ProjectBillOfMaterial(id) |
No documentation available. |
Project Status
Project status (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/ProjectStatus |
Retrieves all task types available for ServiceDesk |
| GET api/ProjectStatus(id) |
Retrieves the task type with the specified key |
Project View
Projects (Equipments, Installation)
| API | Description |
|---|---|
| GET api/ProjectView/GetContractOfProject?contractId={contractId} |
No documentation available. |
| POST api/ProjectView/Search?keyword={keyword}&projectReference={projectReference}&projectReferenceBackOffice={projectReferenceBackOffice}&companyID={companyID}&equipmentModelID={equipmentModelID}&equipmentBrandID={equipmentBrandID}&equipmentFamilyID={equipmentFamilyID}&projectStatusID={projectStatusID}&createdFrom={createdFrom}&createdTo={createdTo}&includesClosed={includesClosed}&parentOnly={parentOnly}&contactId={contactId}&rootParentId={rootParentId}&includeLocation={includeLocation} |
Project search support for gridview. |
| GET api/ProjectView/ListViewLocations?keyword={keyword} |
No documentation available. |
| GET api/ProjectView |
Retrieves all the projects the logged contact has access to |
| GET api/ProjectView(id) |
Retrieves the project with the specified key |
Settings
Task controller, used to create new task
| API | Description |
|---|---|
| GET api/Settings/GetServiceDeskInfo |
Retrieve the translated value of settings.code=SERVICE_DESK_FINO |
Task
Task controller, used to create new task
| API | Description |
|---|---|
| POST api/Task |
Create a new task |
Task Priority
Task Priorities (E.g. Low,Medium,High,Urgent)
| API | Description |
|---|---|
| GET api/TaskPriority |
Retrieves all task priorities available for ServiceDesk |
| GET api/TaskPriority(id) |
Retrieves the task priority with the specified key |
Task Status
Task statuses
| API | Description |
|---|---|
| GET api/TaskStatus/Translations |
No documentation available. |
| GET api/TaskStatus |
Retrieves all task statuses available for ServiceDesk |
| GET api/TaskStatus(id) |
Retrieves the task type with the specified key |
Task Type
Task Types (E.g. Call, Prepare Document)
| API | Description |
|---|---|
| GET api/TaskType/Translations |
No documentation available. |
| GET api/TaskType |
Retrieves all task types available for ServiceDesk |
| GET api/TaskType(id) |
Retrieves the task type with the specified key |
Task View
View used to retrieve task entity
| API | Description |
|---|---|
| GET api/TaskView/CountOpen |
Return the number of task Open (not archived) the logged contact has access to |
| GET api/TaskView/GetTaksByJobsId |
No documentation available. |
| GET api/TaskView/GetTaskById |
No documentation available. |
| POST api/TaskView/Search |
No documentation available. |
| GET api/TaskView/ListCreateYears |
No documentation available. |
| GET api/TaskView |
Retrieves all the tasks the logged contact has access to |
| GET api/TaskView(id) |
Retrieves the task with the specified key |