XTRF Home Portal API
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. <br>The documentation is generated from OpenAPI specification 3.0 available <a href="/home-api/openapi.json">here</a> <br> The API client/consumer code may be easily generated in 60+ programming languages using an open source code generator available at the time of writing this documentation at <a href='https://editor.swagger.io/'>https://editor.swagger.io/</a> Thank you for using XTRF Application Programming interface (XTRF API). By using the API you agree to the terms below. If you disagree with any of these terms, XTRF does not grant you a license to use the XTRF API. XTRF reserves the right to update and change these terms from time to time without a prior notice of API users. You can always find the most recent version of these terms here:
Base URL:
Auth: unknown
Endpoints: 93
Reachable: unknown
CORS: unknown
https://presentation.s.xtrf.eu/home-apiAuth: unknown
Endpoints: 93
Reachable: unknown
CORS: unknown
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/browser | Searches for data (ie. customer, task, etc) and returns it in a tabular form. | — | — | — |
GET |
/browser/csv | Searches for data (ie. customer, task, etc) and returns it in a CSV form. | — | — | — |
GET |
/browser/views/details/for/{className} | Returns current view's detailed information, suitable for browser. | — | — | — |
GET |
/browser/views/details/for/{className}/{viewId} | Returns view's detailed information, suitable for browser. | — | — | — |
POST |
/browser/views/details/for/{className}/{viewId} | Selects given view as current and returns its detailed information, suitable for browser. | — | — | — |
GET |
/browser/views/for/{className} | Returns views' brief. | — | — | — |
POST |
/browser/views/for/{className} | Creates view for given class. | — | — | — |
GET |
/browser/views/{viewId} | Returns all view's information. | — | — | — |
PUT |
/browser/views/{viewId} | Updates all view's information. | — | — | — |
GET |
/browser/views/{viewId}/columns | Returns columns defined in view. | — | — | — |
PUT |
/browser/views/{viewId}/columns | Updates columns in view. | — | — | — |
GET |
/browser/views/{viewId}/filter | Returns view's filter. | — | — | — |
PUT |
/browser/views/{viewId}/filter | Updates view's filter. | — | — | — |
PUT |
/browser/views/{viewId}/filter/{filterProperty} | Updates view's filter property. | — | — | — |
GET |
/browser/views/{viewId}/order | Returns view's order settings. | — | — | — |
PUT |
/browser/views/{viewId}/order | Updates view's order settings. | — | — | — |
GET |
/customers | Returns list of simple clients representations | — | — | — |
GET |
/customers/ids | Returns clients' internal identifiers. | — | — | — |
GET |
/customers/persons/ids | Returns persons' internal identifiers. | — | — | — |
GET |
/customers/persons/{personId} | Returns person details. | — | — | — |
GET |
/customers/persons/{personId}/contact | Returns contact of a given person. | — | — | — |
GET |
/customers/persons/{personId}/customFields | Returns custom fields of a given person. | — | — | — |
GET |
/customers/{customerId} | Returns client details. | — | — | — |
GET |
/customers/{customerId}/address | Returns address of a given client. | — | — | — |
GET |
/customers/{customerId}/categories | Returns categories of a given client. | — | — | — |
GET |
/customers/{customerId}/contact | Returns contact of a given client. | — | — | — |
GET |
/customers/{customerId}/correspondenceAddress | Returns correspondence address of a given client. | — | — | — |
GET |
/customers/{customerId}/customFields | Returns custom fields of a given client. | — | — | — |
GET |
/customers/{customerId}/customFields/{customFieldKey} | Returns custom field of a given client. | — | — | — |
GET |
/customers/{customerId}/industries | Returns industries of a given client. | — | — | — |
GET |
/dictionaries/active | Returns active dictionary entities for all types. | — | — | — |
GET |
/dictionaries/all | Returns dictionary entities for all types. Both active and not active ones. | — | — | — |
GET |
/dictionaries/currency/{isoCode}/exchangeRate | Returns currency exchange rates. | — | — | — |
GET |
/dictionaries/{type}/active | Returns active values from a given dictionary. | — | — | — |
GET |
/dictionaries/{type}/all | Returns all values (both active and not active) from a given dictionary. | — | — | — |
GET |
/dictionaries/{type}/{id} | Returns specific value from a given dictionary. | — | — | — |
GET |
/jobs/{jobId} | Returns job details by jobId. | — | — | — |
GET |
/jobs/{jobId}/files | Returns list of input and output files of a job. | — | — | — |
GET |
/jobs/{jobId}/files/{fileId} | Returns file metadata. | — | — | — |
GET |
/license | Returns license content. | — | — | — |
GET |
/projects/files/{fileId}/download | Downloads a file. | — | — | — |
GET |
/projects/ids | Returns projects' internal identifiers. | — | — | — |
GET |
/projects/{projectId} | Returns project details. | — | — | — |
GET |
/projects/{projectId}/contacts | Returns contacts of a given project. | — | — | — |
GET |
/projects/{projectId}/customFields | Returns custom fields of a given project. | — | — | — |
GET |
/projects/{projectId}/dates | Returns dates of a given project. | — | — | — |
GET |
/projects/{projectId}/finance | Returns finance of a given project. | — | — | — |
GET |
/projects/{projectId}/instructions | Returns instructions of a given project. | — | — | — |
GET |
/providers/ids | Returns providers' internal identifiers. | — | — | — |
GET |
/providers/persons/ids | Returns persons' internal identifiers. | — | — | — |
GET |
/providers/persons/{personId} | Returns person details. | — | — | — |
GET |
/providers/persons/{personId}/contact | Returns contact of a given person. | — | — | — |
GET |
/providers/persons/{personId}/customFields | Returns custom fields of a given person. | — | — | — |
GET |
/providers/{providerId} | Returns provider details. | — | — | — |
GET |
/providers/{providerId}/address | Returns address of a given provider. | — | — | — |
GET |
/providers/{providerId}/competencies | Returns competencies of a given provider. | — | — | — |
GET |
/providers/{providerId}/contact | Returns contact of a given provider. | — | — | — |
GET |
/providers/{providerId}/correspondenceAddress | Returns correspondence address of a given provider. | — | — | — |
GET |
/providers/{providerId}/customFields | Returns custom fields of a given provider. | — | — | — |
GET |
/quotes/ids | Returns quotes' internal identifiers. | — | — | — |
GET |
/quotes/{quoteId} | Returns quote details. | — | — | — |
GET |
/quotes/{quoteId}/customFields | Returns custom fields of a given quote. | — | — | — |
GET |
/quotes/{quoteId}/dates | Returns dates of a given quote. | — | — | — |
GET |
/quotes/{quoteId}/finance | Returns finance of a given quote. | — | — | — |
GET |
/quotes/{quoteId}/instructions | Returns instructions of a given quote. | — | — | — |
GET |
/reports/{reportId}/result/csv | Generates CSV content for a report. | — | — | — |
GET |
/reports/{reportId}/result/printerFriendly | Generates printer friendly content for a report. | — | — | — |
GET |
/services/active | Returns active services list | — | — | — |
GET |
/services/all | Returns services list | — | — | — |
GET |
/tasks/{taskId}/contacts | Returns contacts of a given task. | — | — | — |
GET |
/tasks/{taskId}/customFields | Returns custom fields of a given task. | — | — | — |
GET |
/tasks/{taskId}/dates | Returns dates of a given task. | — | — | — |
GET |
/tasks/{taskId}/files | Returns lists of files of a given task. | — | — | — |
GET |
/tasks/{taskId}/instructions | Returns instructions of a given task. | — | — | — |
GET |
/tasks/{taskId}/progress | Returns progress of a given task. | — | — | — |
GET |
/v2/jobs/for-external-id | — | — | — | — |
GET |
/v2/jobs/{jobId} | Returns details for a job. | — | — | — |
GET |
/v2/jobs/{jobId}/files/delivered | Returns list of files delivered in the job. | — | — | — |
GET |
/v2/jobs/{jobId}/files/sharedReferenceFiles | Returns list of files shared with the job as Reference Files. | — | — | — |
GET |
/v2/jobs/{jobId}/files/sharedWorkFiles | Returns list of files shared with the job as Work Files. | — | — | — |
GET |
/v2/projects/files/{fileId} | Returns details of a file. | — | — | — |
GET |
/v2/projects/files/{fileId}/download/{fileName} | Downloads a file content. | — | — | — |
GET |
/v2/projects/for-external-id/{externalProjectId} | Returns project details. | — | — | — |
GET |
/v2/projects/{projectId} | Returns project details. | — | — | — |
GET |
/v2/projects/{projectId}/catToolProject | Returns if cat tool project is created or queued. | — | — | — |
GET |
/v2/projects/{projectId}/clientContacts | Returns Client Contacts information for a project. | — | — | — |
GET |
/v2/projects/{projectId}/customFields | Returns a list of custom field keys and values for a project. | — | — | — |
GET |
/v2/projects/{projectId}/files | Returns list of files in a project. | — | — | — |
GET |
/v2/projects/{projectId}/files/deliverable | Returns list of files in a project, that are ready to be delivered to client. | — | — | — |
GET |
/v2/projects/{projectId}/finance | Returns finance information for a project. | — | — | — |
GET |
/v2/projects/{projectId}/jobs | Returns list of jobs in a project. | — | — | — |
GET |
/v2/projects/{projectId}/process | Returns process id. | — | — | — |
GET |
/v2/quotes/files/{fileId} | Returns details of a file. | — | — | — |
GET |
/v2/quotes/files/{fileId}/download/{fileName} | Downloads a file content. | — | — | — |
GET |
/v2/quotes/{quoteId} | Returns quote details. | — | — | — |
GET |
/v2/quotes/{quoteId}/clientContacts | Returns Client Contacts information for a quote. | — | — | — |
GET |
/v2/quotes/{quoteId}/customFields | Returns a list of custom field keys and values for a project. | — | — | — |
GET |
/v2/quotes/{quoteId}/files | Returns list of files in a quote. | — | — | — |
GET |
/v2/quotes/{quoteId}/finance | Returns finance information for a quote. | — | — | — |
GET |
/v2/quotes/{quoteId}/jobs | Returns list of jobs in a quote. | — | — | — |