[space] Main [title] Webhooks [path] / Frontu is using AWS SNS to notify your system about data changes in your Frontu account. AWS SNS sends POST request to your defined ENDPOINT (verified https:443 or http:80) with JSON data in the request body. **If you would like to receive notifications - please write a request to Our Support team.** ### Supported message types: 1. Task created 2. Task status changed 3. Task finished (basic data) 4. Task finished (full data with all releations) 5. Task stopped 6. Task past due 7. Task reassigned 8. Task aborted 9. Task billed ### Subscription confirmation If you want to receive notifications you must confirm it. First arrived message will include "SubscribeURL" which have to be excuted. ### Subscription confirmation message example: ```json { "Type": "SubscriptionConfirmation", "MessageId": "6a78b9cc-bc85-4b45-8717-6dd0387cc581", "TopicArn": "arn:aws:sns:tasker-events", "SubscribeURL": "https://sns.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:tasker-events&Token=abc123" "...": "..." } ``` ### Created task message example: ```json { "Type" : "Notification", "MessageId" : "dae4d546-00a4-5f96-bc84-8d05dfba3554", "TopicArn" : "arn:aws:sns:eu-central-1:213451270288:sns-ec1-prod-webhook", "Message" : "{\"event\":\"task_created\",\"task\":{\"version\":1607064798,\"code\":\"E-B-2020-12-04-65QQ\",\"title\":\"new task\",\"clientName\":null,\"clientEmail\":null,\"rating\":null,\"agreement\":null,\"signatureType\":null,\"signatureFile\":null,\"description\":null,\"abortMessage\":null,\"clientNote\":null,\"clientNoteReply\":null,\"distance\":null,\"workPrice\":null,\"workPriceWithVat\":null,\"routePrice\":null,\"routePriceWithVat\":null,\"materialPrice\":null,\"materialPriceWithVat\":null,\"finalPrice\":null,\"finalPricePriceWithVat\":null,\"vat\":21,\"currency\":\"EUR\",\"synced\":false,\"status\":100,\"literalStatus\":\"Inactive\",\"stopStatusMessage\":null,\"plannedTime\":\"2020-12-04T06:53:19+0000\",\"plannedEndTime\":\"2020-12-04T07:53:19+0000\",\"fetched\":true,\"time\":null,\"ended\":null,\"pastDue\":false,\"duration\":null,\"durationFull\":null,\"billDate\":null,\"billStatus\":false,\"reassigned\":false,\"filesExists\":false,\"user\":{\"title\":\"Test User\",\"guid\":\"e57a6e87-763a-d376-d4a6-35e598311ca4\",\"systemId\":\"001\"},\"formerUser\":null,\"assignor\":{\"title\":\"Test User\",\"guid\":\"e57a6e87-763a-d376-d4a6-35e598311ca4\",\"systemId\":\"001\"},\"taskType\":{\"title\":\"Test Task Type\",\"guid\":\"1f17ccc8-465f-86b5-ede9-55c463e65558\",\"systemId\":\"001\"},\"workspace\":{\"title\":\"Test Workspace\",\"serialNumber\":\"TEST123\",\"guid\":\"186635a9-bc0c-6627-946e-4b3e2c7587b5\",\"systemId\":\"001\"},\"client\":{\"title\":\"Test Client\",\"companyCode\":\"00001\",\"guid\":\"a8331488-f253-d8e7-1178-a9b74c00d855\",\"systemId\":\"00001\"},\"taskRequest\":null,\"createdBy\":{\"title\":\"Test User\",\"guid\":\"e57a6e87-763a-d376-d4a6-35e598311ca4\",\"systemId\":\"001\"},\"requireObjectCode\":false,\"requireSignature\":false,\"taskTypePriority\":0,\"guid\":\"82fd2b4a-b2c5-482c-abc2-c4657d5a7a60\",\"created\":\"2020-12-04T06:53:19+0000\",\"updated\":\"2020-12-04T06:53:19+0000\",\"deleted\":false,\"systemId\":null}}", "Timestamp" : "2020-12-04T06:53:18.809Z", "SignatureVersion" : "1", "Signature" : "j5zirdPTdkkmj3d0Mev2W/w82p4oftlHKTvHAR7FGFh4upJNlrnMSDg8Q50UJNfQhh1XYbyO+TBLMmoCt7e648qWfU/seNNsxJzoWZCyliz5oy2SpNaCR+/UoanINrceGkCEn3FH7SMxPJ+Doy04nNmqXOpO0byjxXI6Y/bHJcWHGWSKG2a2b4RIRupjcZek0ijwrxVJ7ivQMzG9XgR6oFbTMxR3V2KY4BKeb6KPXiTa2OVWfbCH9HM8xOUpI7a+XLIIQ8U4ltS+EjJKFC7ipZ6eoC9L3oJ0tdkikasrwUX9McUx3ZTvTuJGm0TuDM/rXyzOzUdTLofZcRoV3aLJzA==", "SigningCertURL" : "https://sns.eu-central-1.amazonaws.com/SimpleNotificationService-010a507c1833636cd94bdb98bd93083a.pem", "UnsubscribeURL" : "https://sns.eu-central-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-central-1:213451270288:sns-ec1-prod-webhook:96098c40", "MessageAttributes" : { "domain" : {"Type":"String","Value":"domain"}, "type" : {"Type":"String","Value":"task_created"} } } ``` [title] SystemX -> Frontu (Clients + Objects) [path] / ### Clients + Objects `Client - entity which saves all the client information.` `Workspace - a particular managed facility, place, or equipment. If one site contains several facilities, each of them is registered as a separate object.` For example, you have a Client which is “**UAB Client**”, which has some additional data like company tax/VAT ID, Code/E.I.N number, address, city, phone number, email and etc. For example, Workspace has some information too, like workspace name which for example are “**Shop**”, address, customer (which means client), serial number, etc. So as you can see Client is “**UAB Client**” and it has a workspace where the task can be created, for example in the workspace “**Shop**”. ### Endpoints to use for the Clients and Objects First of all, before creating an object you need to create a client. So you need to use this endpoint - [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1clients/post). In this case fill all needed information like the title - client name, address - client address, etc. For the next steps you need to create object - [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1workspaces/post) In this case fill all needed information like title, client, which you created before (you need to pass the guid of the client). ### Real-world data mapping examples of most common cases First of all, you need to create Clients using POST method: ```json { "title": "UAB Client", "address": "4759 Chandler Drive", "city": "Joplin", "phone": 865744567, "email": "client@gmail.com", "companyVatCode": "12345678", "companyCode": "3546780", "deleted": false, "clientType": 2, "systemId": "CLIENT1" } ``` :::BlockQuote IMPORTANT: the title is a required field. ::: Then you will get a response: ```json { "version": 1622720578, "title": "UAB Client", "address": "4759 Chandler Drive", "city": "Joplin", "phone": "865744567", "email": "client@gmail.com", "creditStatus": null, "note": null, "companyCode": "3546780", "companyVatCode": "12345678", "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa", "created": "2021-06-03T11:42:58+0000", "updated": "2021-06-03T11:42:58+0000", "deleted": false, "clientType": 2, "systemId": "CLIENT1", "customValues": null } ``` In this case, you can take the client guid and use it in the object or you can use systemId, which defines unique data from your system and give it to the workspace. ### Workspace creation example: ```json { "title": "Shop", "client": "CLIENT1", "city": "Joplin", "deleted": false, "systemId": “WORKSPACE1”, } ``` :::BlockQuote IMPORTANT: title and the client is required fields. ::: Then you will get a response: ```json { "version": 1622721176, "title": "Shop", "serialNumber": null, "longitude": null, "latitude": null, "note": null, "address": null, "city": "Joplin", "apartmentNumber": null, "signatureCode": "4d5c63d2db40db14e3f9a7334cf2c83b", "objectCode": "7930df975d543069dc4f74c3a78c316b", "client": { "title": "UAB Client", "companyCode": "3546780", "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa", "systemId": "CLIENT1" }, "guid": "aee6c30b-196e-6363-4c25-f2599fe116b9", "created": "2021-06-03T11:52:56+0000", "updated": "2021-06-03T11:52:56+0000", "deleted": false, "systemId": “WORKSPACE1”, "warrantyIndicator": null, "warrantyRequired": false, "customValues": null } ``` And you can see that you have a relationship with the Workspace and Client by the systemId [title] Frontu->SystemX (Periodical check + Filters) [path] / ### For the periodical check you can use these endpoints : For task, in this endpoint, you will get all information about tasks in your system. [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1tasks/get) For workspaces, in this endpoint, you will get all information about workspaces in your system. [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1workspaces/get) For clients, in this endpoint, you will get all information about clients in your system. [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1clients/get) ### Filters could be used to receive only new and relative data For this endpoint: [https://developers.frontu.com/get-responsible-person-list](https://developers.frontu.com/get-responsible-person-list)you can use filters such as: guid, systemId, title, email, phone, companyCode, companyVatCode. Write it in the query params and it will filter data regarding these values. For this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1standartized_materials~1details/get) you can use filters such as: guid, systemId, title, serialNumber. Write it in the query params and it will filter data regarding these values. For this endpoint: [https://developers.frontu.com/get-standartizedwork-detail-information ](https://developers.frontu.com/get-standartizedwork-detail-information)you can use filters such as: guid, systemId, title. Write it in the query params and it will filter data regarding these values. For this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1tasks~1details/get) you can use filters such as: guid, systemId, billStatus, status, receivedByExternalSystem, code, version. Write it in the query params and it will filter data regarding these values. For this endpoint: [https://developers.frontu.com/get-taskstopreason](https://developers.frontu.com/get-taskstopreason)you can use filters such as: guid. Write it in the query params and it will filter data regarding these values. For this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1task_types~1details/get) you can use filters such as: guid, systemId, title. Write it in the query params and it will filter data regarding these values. For this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1workspaces~1details/get) you can use filters such as: guid, systemId, title, serialNumber, objectCode. Write it in the query params and it will filter data regarding these values. ### ReceivedByExternalSystem flag *receivedByExternalSystem* flag that shows if the task is received by the external system and the external system got it. [title] API usage rules [path] / 1. **Rate Limits** • Respect Rate Limits: The API allows up to 1000 requests per 5 minutes. Ensure there is a small delay between requests to avoid exceeding this limit. • Avoid Overloading: Implement rate-limiting logic in your application to manage the frequency of requests and prevent throttling. 2. **Incremental Data Sync** • Send Only Changes: When synchronizing data with the API, send only updated or changed information. Avoid sending the entire dataset unless explicitly required. • Optimize Payloads: Use filters and data-specific endpoints to minimize the size of requests and improve performance. 3. **Error Handling and Monitoring** • Handle Errors Gracefully: • Implement retry mechanisms with exponential backoff for temporary errors (e.g., rate limits or timeouts). • Log and address error responses like 4xx (client errors) and 5xx (server errors) appropriately. • Monitor API Usage: • Regularly monitor your API interactions to identify issues early. • Log all API requests and responses, excluding sensitive information, for debugging and performance analysis [title] API-Basics [path] / ### Authentication You can find the API key in the Frontu system by going to the Settings -> API tab and there you will find your API key, which you can use to authenticate with header authentication. Example: [https://somedomain.frontu.com/client/api/v2/evaluations/task](https://somedomain.frontu.com/client/api/v2/evaluations/task?access_token=MjE5ZWQ2YTFhZTczMjIxNjNhNTY3ZGRjNjNjM2JkZDdhMTM1ZGYyNDhmY2ZkYjA2M2Y4NTQzNzFlNTNhNjdkOA\&guid=f889fbe9-9d9b-3c8a-8549-e321ee7e3e34) For the header authentication you need to set: `KEY = Authorization` `VALUE = Bearer MjE5ZWQ2YTFhZTczMjIxNjNhNTY3ZGRjNjNjM2JkZDdhMTM1ZGYyNDhmY2ZkYjA2M2Y4NTQzNzFlNTNhNjdkOA ` ### GUID / SystemId logic - GUID - is a unique identifier generated by Frontu - SystemId - is a unique identifier from the system you’re integrating Frontu with. ### Question - why using systemId makes integration easier (easy mapping with systemX)? To make an integration easier we recommend to use the systemId field which should have the same value as it has in the system you’re integrating with. In this case you will not need to store and additionally map items between the systems. IMPORTANT: systemId is a unique value, so make sure you don’t have duplicate values in your system. ### Create / Update item While sending data using a POST method to the API, Frontu tries to identify it. In the first stage, Frontu tries to find an item by GUID if it is provided. Secondly - by systemId. If such an item exists in the Frontu database, it will be updated, or otherwise - created. ### Deleted FLAG Frontu provides only a soft delete option to keep data integrity. To make an item “archived” you have to change the value of the “deleted” field. 1 - means that item is archived. 0 - means that item is active. ### Version field logic Frontu gathers a big amount of data. To make sure you would not need to synchronize all of it every time - you can use the “version” field to filter it. “version” field value is a unix timestamp value (UTC timezone) which defines the last time an item has been updated. E.g.: 1623830251 ### Filters It allows to filter data via query params. For example, you want to get detailed info about tasks. In this case, you can fill in information like guid in the query params, systemId, bill status, task status, or flag which allows you to filter tasks if they are received by an external system, task code, and version. If you fill in information about one of these params you will get filtered data according to these parameters. ### POSTMAN collection Most comman used POST methods now is visible [here](https://drive.google.com/file/d/1Z3ti6BTzbsef6AYszeGsLEZulhY25CVh/view?usp=sharing). ### Limitation We are limiting the number of requests from one IP address -> up to 1000 requests from one IP within 5 min. [title] SystemX->Frontu (Clients + Objects + Equipments) [path] / ### Clients + Objects + Equipments `Client - entity which saves all the client information.` `Workspace - a particular managed facility, place, or equipment. If one site contains several facilities, each of them is registered as a separate object.` For example, you have a Client which is “**UAB Client**”, which has some additional data like company tax/VAT ID, Code/E.I.N number, address, city, phone number, email, etc. For example, Workspace has some information too, like workspace name which for example are “**Shop**”, address, customer (which means client), serial number and etc. For example, Equipment has some information too, like equipment name which for example are “**Fridge**”, Code, Equipment, Workspace, serial number and etc. So as you can see Client is “**UAB Client**” and it has an object where the task can be created, for example in the workspace “**Shop**” and object has the equipment “**Fridge**” ### Endpoints to use for the Clients + Objects + Equipments First of all, before creating an object you need to create a client. So you need to use this endpoint - [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1clients/post) In this case fill all needed information like the title - client name, address - client address and etc. In next steps you need to create object - [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1workspaces/post) And last step is to create equipment : [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1equipments/post) ### Real-world data mapping examples of most common cases First of all, you need to create Clients for example fill in this data. ```json { "title": "UAB Client", "address": "4759 Chandler Drive", "city": "Joplin", "phone": 865744567, "email": "client@gmail.com", "companyVatCode": "12345678", "companyCode": "3546780", "deleted": false, "clientType": 2, "systemId": "CLIENT1" } ``` :::BlockQuote IMPORTANT: the title is a required field. ::: Then you will get a response: ```json { "version": 1622720578, "title": "UAB Client", "address": "4759 Chandler Drive", "city": "Joplin", "phone": "865744567", "email": “client@gmail.com”, "creditStatus": null, "note": null, "companyCode": "3546780", "companyVatCode": "12345678", "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa", "created": "2021-06-03T11:42:58+0000", "updated": "2021-06-03T11:42:58+0000", "deleted": false, "clientType": 2, "systemId": null, "customValues": null } ``` In this case, you can take the client systemId or the guid and use it in the workspace. ### Workspace creation example: ```json { "title": "Shop", "client": "CLIENT1", "city": "Joplin", "systemId": "WORKSPACE1", "deleted": false } ``` :::BlockQuote IMPORTANT: title and the client is required fields. ::: Then you will get a response: ```json { "version": 1622721176, "title": "Shop", "serialNumber": null, "longitude": null, "latitude": null, "note": null, "address": null, "city": "Kaunas", "apartmentNumber": null, "signatureCode": "4d5c63d2db40db14e3f9a7334cf2c83b", "objectCode": "7930df975d543069dc4f74c3a78c316b", "client": { "title": "UAB Client", "companyCode": "3546780", "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa", "systemId": "CLIENT1" }, "guid": "aee6c30b-196e-6363-4c25-f2599fe116b9", "created": "2021-06-03T11:52:56+0000", "updated": "2021-06-03T11:52:56+0000", "deleted": false, "systemId": "WORKSPACE1", "warrantyIndicator": null, "warrantyRequired": false, "customValues": null } ``` And you can see that you have a relationship with the Workspace and Client. ### Equipment creation example: ```json { "title": "Fridge", "deleted": false, "workspace": "WORKSPACE1", "serialNumber": "312o3u4i", "warrantyExpirationDate": "2021-01-01", "nextMaintenanceDate": "2020-11-01" } ``` :::BlockQuote IMPORTANT: you can use the systemId for the workspace or the guid of the Frontu ::: Then you will get a response: ```json { "version": 1623061707, "title": "Fridge", "guid": "c383c988-20d3-de56-5b99-fba284bc9bac", "created": "2021-06-07T10:28:27+0000", "updated": "2021-06-07T10:28:27+0000", "deleted": false, "systemId": "EQUIPMENT1", "workspace": "WORKSPACE1", "equipmentModel": null, "serialNumber": "312o3u4i", "installDate": null, "warrantyExpirationDate": "2021-01-01", "nextMaintenanceDate": "2020-11-01", "note": null, "location": null, "customValues": null } ``` And you can see that you have a relationship with the Workspace and Equipment. [title] SystemX->Frontu (Custom fields) [path] / ### Custom fields ### Example how to use custom values: You need to specify it for example like this: first value is guid of the custom field (for this case you can select all custom fields in this endpoint - [https://developers.frontu.com/get-standartizedmaterialcustomfield-list](https://developers.frontu.com/get-standartizedmaterialcustomfield-list)), and second is value of the custom field. ```json "customValues": { "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34": "Custom Value", "f889fbe9-9d9b-3c8a-8549-e321ee7e3e35": "Custom Value 2", "f889fbe9-9d9b-3c8a-8549-e321ee7e3e38": "2" } ``` [title] SystemX->Frontu (Standartized Material Remains) [path] / ### Standartized Materials ### Endpoints to use for the Standartized materials For the creation of the standardized material remains you need to use this API endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MjA1ODY4MzI-create-update-standartized-material-remains) In the standardized material remais you need to use standartized material guid, so you can create it in this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjEwMA-create-update-standartized-material) Or get it from this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjA5OQ-get-standartized-material-list) Also in this endpoint you need to use workspace guid, so you can create it in this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjA5Nw-create-update-workspace) Or get it from this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjA5OA-get-workspace-detail-information) ### Real-world data mapping examples of most common cases First of all, as I mentioned you need to get a standartized material and workspaces guid or create a new ones. So for the get, you just use this endpoint for the standartized material [https://developers.frontu.com/get-detail-information-about-standartized-material-remains](https://developers.frontu.com/get-detail-information-about-standartized-material-remains), for the workspaces: [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjA5OA-get-workspace-detail-information) and you will get all standartized materials or the workspaces from these endpoints. If you want to create a new standartized material, please check this link : [](https://developers.frontu.com/docs/tasker-api-v2/ZG9jOjIwNDY1NTkw-system-x-frontu-standartized-materials) For the workspace creation this one : [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MzU4MjA5Nw-create-update-workspace) After the workspace and standartized material creation you can create the standartized remains. Make the POST method and fill in this information: ```json { "standartizedMaterial": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "workspace": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e35", "serialNumber": 83728347892374899, "quantity": 1, "systemId": "MAT009", "guid": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e39" } ``` And then you will get a response: ```json { "version": 1631185935, "standartizedMaterial": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "quantity": 2, "serialNumber": "83728347892374899", "workspace": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e351", "guid": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "created": "2021-09-09T11:12:15+0000", "updated": "2021-09-09T11:12:15+0000", "deleted": false, "systemId": "MAT001" } ``` For the GET endpoint and detail information please check this link : [](https://developers.frontu.com/docs/tasker-api-v2/b3A6MjA1ODY4MzM-get-detail-information-about-standartized-material-remains) :::BlockQuote IMPORTANT: Do not forget to use query params for the detail information ::: [title] SystemX->Frontu (Standartized Materials) [path] / ### Standartized Materials ### Endpoints to use for the Standartized materials For the creation of the standardized material you need to use this API endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1standartized_materials/post) In the standardized material you need to use material type guid, so you can create it in this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1material_types/post) Or get it from this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1material_types/get) ### Real-world data mapping examples of most common cases First of all, as I mentioned you need to get a material type guid or create a new one. So for the get, you just use this endpoint [https://developers.frontu.com/get-all-materialtypes](https://developers.frontu.com/get-all-materialtypes)and you will get all possible material types data. If you want to create a new one, you need to use this endpoint: [](https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1material_types/post) Make the POST method and fill in this information: ```json { "title": "Kilogram", "systemId": "MATERIALTYPE1", "delted":false } ``` :::BlockQuote IMPORTANT: title is required for this POST method ::: And then you will get a response: ```json { "version": 1623147256, "title": "Kilogram", "guid": "839f7481-f647-c8bb-7a89-ee4b2c136c33", "created": "2021-06-08T10:14:16+0000", "updated": "2021-06-08T10:14:16+0000", "deleted": false, "systemId": "MATERIALTYPE1" } ``` Then you can create the standardized material, fill in information like: ```json { "title": "Standartized material", "materialType": "MATERIALTYPE1", "serialNumber": 83728347892374892, "price": 99.99, "systemId": "STANDARTIZEDMATERIAL1" } ``` :::BlockQuote IMPORTANT: title, materialType and the price is required for this POST method ::: And then you will get a response: ```json { "version": 1623147552, "title": "Standartized material", "serialNumber": "83728347892374892", "hashtag": null, "materialType": { "title": "Kilogram", "guid": "d8ca96bd-b727-ad93-da21-d7786a11f9c9", "systemId": "MATERIALTYPE1", }, "guid": "2c92b3c9-ed65-7426-37a7-d5e66dce0a90", "created": "2021-06-08T10:19:12+0000", "updated": "2021-06-08T10:19:12+0000", "deleted": false, "systemId": "STANDARTIZEDMATERIAL1", "customValues": null } ``` [title] SystemX->Frontu (Task Request) [path] / ### Task Request ### Data witch you need to send to create a Task Request Creating task request you need to send this data: ```json { "title": "Technical review", "client": "CLIENT1", (this is client systemId) "workspace": "WORKSPACE1",(this is workspace systemId) "systemId": "TASKREQUEST1" (this is task request systemId) } ``` :::BlockQuote IMPORTANT: title is required for this POST method ::: ### You need to send only object serialNumber and object + client will be selected automatically If you decide to send just the workspace because in this time you want to select client by the object, then you can send body like this: ```json { "title": "Technical review 2", "workspace": "WORKSPACE1", "systemId": "TASKREQUEST1" } ``` And the system automatically assigns the client which is related to the object. [title] Task templates and task [path] / ```yaml stoplight-id: xx6fncg9orkm1 ``` If you have created some task templates in your backend environment and what from the client api choose for the task the template. Simply you can follow these steps: ### Real-world data mapping examples of most common cases First of all, you need to get the Task template list using GET /client/api/v2/task/templates method: ```json { "next_page": 0, "items": [ { "title": "Tast template", "guid": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "systemId": 'TTL001' } ] } ``` Then when you want to create the task simply in the task POST method you should assigned gotted guid or systemId value: ```json { "title": "Task title", "plannedTime": "2022-07-22T12:12:12", "client": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "workspace": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "taskType": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34", "createdBy": "f889fbe9-9d9b-3c8a-8569-e321ee7e3e34", "user": "f889fbe9-9d9b-3c8a-8569-e321ee7e3e34", "systemId": "TSK001", "taskTemplate": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34" } ``` :::BlockQuote IMPORTANT: All the required information from the task template will be transfer and assigned to the task such as - files, materials, works and notes. ::: [title] Abort Task [path] Frontu API Sandbox/ClientApi/Task/ { "id": "D4WQ0xTo8opHsHA_aFZoU", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://dev1.frontu.com//client/api/v2/tasks/abort", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks/abort" } ], "name": "Abort Task", "description": "

This endpoint updates the task values and sets task status equal 600, which means that task are aborted.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "

Task GUID/SystemId

", "format": "binary" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/TaskType [path] Frontu API Sandbox/ [title] ClientApi/TaskTemplate [path] Frontu API Sandbox/ [title] ClientApi/StandartizedWork [path] Frontu API Sandbox/ [title] ClientApi/Work [path] Frontu API Sandbox/ [title] Create / Update StandartizedWork [path] Frontu API Sandbox/ClientApi/StandartizedWork/ { "id": "EoCCnkhafqvbz09EM0nyv", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/standartized_works", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_works" } ], "name": "Create / Update StandartizedWork", "description": "

Allows to create or update standartized work object values.

\n

If you want to update Standartized Work using POST method you need to fill information for guid field or systemId field in request body.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1standartizedworks/get ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "rate", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "nightRate", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "workType", "kind": "optional", "type": "integer", "description": "

1 - hours, 2 - units. Defaults to 1 (hours) when omitted on create.

", "format": "int32" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Note [path] Frontu API Sandbox/ClientApi/Note/ { "id": "BflTunnWvAwEjMqM4BQGH", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/notes/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/notes/{guid}" } ], "name": "Get Note", "description": "This endpoind allows to return one note information", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "image", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskTemplate", "kind": "optional", "type": "string", "description": "" }, { "name": "user", "kind": "optional", "type": "string", "description": "" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Client detail information [path] Frontu API Sandbox/ClientApi/Client/ { "id": "wpCE-UjLYs-P7Nou7ecA3", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/clients/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/clients/details" } ], "name": "Get Client detail information", "description": "This endpoind allows to retrieve all information about one specific client and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "title", "type": "string", "description": "Title." }, { "kind": "optional", "name": "email", "type": "string", "description": "Email address." }, { "kind": "optional", "name": "phone", "type": "string", "description": "Phone number." }, { "kind": "optional", "name": "companyCode", "type": "string", "description": "Company identifier." }, { "kind": "optional", "name": "companyVatCode", "type": "string", "description": "Company VAT code." }, { "kind": "optional", "name": "tag", "type": "string", "description": "

Tag systemId, guid or title.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "Client name" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "creditStatus", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "" }, { "name": "companyVatCode", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "clientType", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "integer", "description": "Unique" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Tag titles assigned to the record.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "

You will get custom values for example \"guid\": \"version\"

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update ClientCustomField [path] Frontu API Sandbox/ClientApi/ClientCustomField/ { "id": "H4pDNkhrqoOVwIPXtu7EF", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/clients", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/clients" } ], "name": "Create / Update ClientCustomField", "description": "This endpoint allows to create or update client custom field values.\n\nIf you want to update Client Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number,\n* 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get CreditStatus [path] Frontu API Sandbox/ClientApi/CreditStatus/ { "id": "XD5V_fzARb2YjvJay3Vl1", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/creditstatuses/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/creditstatuses/details" } ], "name": "Get CreditStatus", "description": "This endpoind allows to retrieve all information about one specific credit status and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Task detail information [path] Frontu API Sandbox/ClientApi/Task/ { "id": "R_UjJfsk9YhBwumNqC_PF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/tasks/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks/details" } ], "name": "Get Task detail information", "description": "This endpoind allows to retrieve all information about one specific task and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "code", "type": "string", "description": "Task code identifier." }, { "kind": "optional", "name": "billStatus", "type": "string", "description": "Bill status." }, { "kind": "optional", "name": "status", "type": "string", "description": "

Task status, if it is finished or not.

" }, { "kind": "optional", "name": "receivedByExternalSystem", "type": "string", "description": "

Task status, if it is received by external system.

" }, { "kind": "optional", "name": "isChild", "type": "boolean", "description": "

true returns only tasks that are children of another task (parentId set), false only tasks without a parent. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.

" }, { "kind": "optional", "name": "hasChildren", "type": "boolean", "description": "

true returns only tasks that have at least one child task, false only tasks with no children. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "code", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientName", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientEmail", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "rating", "kind": "optional", "type": "number", "description": "" }, { "name": "agreement", "kind": "optional", "type": "boolean", "description": "" }, { "name": "signatureType", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "signatureFile", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "abortMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNote", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNoteReply", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "distance", "kind": "optional", "type": "number", "description": "" }, { "name": "workPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "workPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "routePrice", "kind": "optional", "type": "number", "description": "" }, { "name": "routePriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "vat", "kind": "optional", "type": "number", "description": "" }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "status", "kind": "optional", "type": "number", "description": "" }, { "name": "stopStatusMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedEndTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "fixedPlannedTime", "kind": "optional", "type": "boolean", "description": "" }, { "name": "fetched", "kind": "optional", "type": "boolean", "description": "" }, { "name": "time", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "ended", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "pastDue", "kind": "optional", "type": "boolean", "description": "" }, { "name": "duration", "kind": "optional", "type": "number", "description": "" }, { "name": "durationFull", "kind": "optional", "type": "number", "description": "" }, { "name": "billDate", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "billStatus", "kind": "optional", "type": "boolean", "description": "" }, { "name": "reassigned", "kind": "optional", "type": "boolean", "description": "" }, { "name": "filesExists", "kind": "optional", "type": "boolean", "description": "" }, { "name": "office", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "address", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "formerUser", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "assignor", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "client", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "createdBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "requireObjectCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "requireSignatureCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "taskTypePriority", "kind": "optional", "type": "number", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "version", "kind": "optional", "type": "number", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "receivedByExternalSystem", "kind": "optional", "type": "boolean", "description": "" }, { "name": "approvedBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid2", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "sla", "kind": "optional", "type": "object", "nullable": true, "description": "

SLA assigned to the task, or null when none is assigned. duration is in MINUTES - the admin UI displays it as hours (duration / 60).

", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "SLA duration in minutes." } ] }, { "name": "helpers", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "

Returned when the request contains no recognised filter parameter (e.g. guid or systemId), or when more than one entity matches.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"error\":\"At least one recognised filter parameter (e.g. guid or systemId) is required.\"}", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Equipment models list [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "f-DsRZQRsOo3QBeWS348f", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/equipment_models", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipment_models" } ], "name": "Get Equipment models list", "description": "This endpoint allows to get Equipment models list\n\nIf you want to update Equipment models value using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "required", "type": "number", "description": "" }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Equipment actions [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "lc6wRB6Xia2aIK_QIs8hG", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/equipmentactions", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipmentactions" } ], "name": "Create / Update Equipment actions", "description": "This endpoint allows to update or create equipment actions values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "example-1" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "equipment", "kind": "optional", "type": "string", "description": "Equipment identifier guid" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "action", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "message", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "errors", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "errors", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/TaskStatusHistory [path] Frontu API Sandbox/ [title] Create / Update Equipments [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "T-mxoWyFOHfBjDt97a-1b", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/equipments", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipments" } ], "name": "Create / Update Equipments", "description": "

This endpoint allows to update or create equipments values.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1equipments/post ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "Equipment title" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "Workspace identifier guid" }, { "name": "equipmentModel", "kind": "optional", "type": "string", "description": "Equipment model identifier guid" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "installDate", "kind": "optional", "type": "string", "description": "When the equipment are installed" }, { "name": "warrantyExpirationDate", "kind": "optional", "type": "string", "description": "When the warranty expiration" }, { "name": "nextMaintenanceDate", "kind": "optional", "type": "string", "description": "Next maintenance date" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "paidBy", "kind": "optional", "type": "string", "description": "" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" }, { "name": "location", "kind": "optional", "type": "string", "description": "Directions where to find equipment in the building" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "message", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "errors", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "errors", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update RouteHistory [path] Frontu API Sandbox/ClientApi/RouteHistory/ { "id": "fGbFHx3HG9-FTeC68BOaw", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/routehistories", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/routehistories" } ], "name": "Create / Update RouteHistory", "description": "This endpoint allows to create or update route history information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "

Identifier from Frontu(used only on update)

" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "duration", "kind": "optional", "type": "string", "description": "In seconds" }, { "name": "distance", "kind": "optional", "type": "integer", "description": "Distance in meters", "format": "int32" }, { "name": "price", "kind": "optional", "type": "integer", "description": "In cents", "format": "int32" }, { "name": "priceWithVat", "kind": "optional", "type": "integer", "description": "In cents", "format": "int32" }, { "name": "vat", "kind": "optional", "type": "number", "description": "Decimal number" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "task", "kind": "optional", "type": "string", "description": "GUID or systemId of a task" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of a user" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Client [path] Frontu API Sandbox/ [title] ClientApi/Task [path] Frontu API Sandbox/ [title] Create / Update ResponsiblePerson [path] Frontu API Sandbox/ClientApi/ResponsiblePerson/ { "id": "6n8L-ClO76MHp4J-hbTjL", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/responsible_persons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/responsible_persons" } ], "name": "Create / Update ResponsiblePerson", "description": "This enpoint allows to create or update the responsible person.\n\nIf you want to update Responsible person using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "firstName", "kind": "required", "type": "string", "description": "" }, { "name": "lastName", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "position", "kind": "optional", "type": "string", "description": "

e.g Manager, Director and etc.

" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "client", "kind": "optional", "type": "string", "description": "GUID or systemId of Client" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get task type list [path] Frontu API Sandbox/ClientApi/TaskType/ { "id": "gQ3CyMQtNFxEAW-hYw2Jr", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/task_types", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_types" } ], "name": "Get task type list", "description": "This endpoint allows to get all data about task types.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "mailList", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "requireObjectCode", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "requireSignatureCode", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "termsAgree", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Material [path] Frontu API Sandbox/ClientApi/Material/ { "id": "bYiIaeSRY1__oFmmIrytZ", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/materials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/materials" } ], "name": "Create / Update Material", "description": "This enpoind allows to create or update material values.\n\nIf you want to update Material using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "materialType", "kind": "optional", "type": "string", "description": "" }, { "name": "standartizedMaterial", "kind": "optional", "type": "string", "description": "GUID or systemId of Standartized Material" }, { "name": "task", "kind": "optional", "type": "string", "description": "GUID or systemId of Task" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "selfCost", "kind": "optional", "type": "string", "description": "" }, { "name": "vat", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "sfNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "price", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "priceWithVat", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "suggestedAmount", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "debited", "kind": "optional", "type": "boolean", "description": "

Mark if material is debited (1) or not debited (0). On an existing material the status must actually change: debiting an already debited material, or restoring one that is not debited, returns 400. Omit the field to leave the status as it is.

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/StandartizedMaterial [path] Frontu API Sandbox/ [title] ClientApi/TaskCustomField [path] Frontu API Sandbox/ [title] Get TaskRequest [path] Frontu API Sandbox/ClientApi/TaskRequest/ { "id": "dmfB6HiRb-AmsJ-cbNA2U", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/task_requests/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_requests/details" } ], "name": "Get TaskRequest", "description": "This endpoind allows to retrieve all information about one specific task request and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "client", "kind": "optional", "type": "string", "description": "" }, { "name": "object", "kind": "optional", "type": "string", "description": "" }, { "name": "createdBy", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "boolean", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "equipment", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get full Task data with works, materials, etc. [path] Frontu API Sandbox/ClientApi/Task/ { "id": "YihobQMWHfL9WmqsCb_9o", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/tasks/full", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks/full" } ], "name": "Get full Task data with works, materials, etc.", "description": "This endpoint allows to get task full information with all relations and all task information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "code", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientName", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientEmail", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "rating", "kind": "optional", "type": "number", "description": "" }, { "name": "agreement", "kind": "optional", "type": "boolean", "description": "" }, { "name": "signatureType", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "signatureFile", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "abortMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNote", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNoteReply", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "distance", "kind": "optional", "type": "number", "description": "" }, { "name": "workPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "workPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "routePrice", "kind": "optional", "type": "number", "description": "" }, { "name": "routePriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "vat", "kind": "optional", "type": "number", "description": "" }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "status", "kind": "optional", "type": "number", "description": "" }, { "name": "stopStatusMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedEndTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "fixedPlannedTime", "kind": "optional", "type": "boolean", "description": "" }, { "name": "fetched", "kind": "optional", "type": "boolean", "description": "" }, { "name": "time", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "ended", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "pastDue", "kind": "optional", "type": "boolean", "description": "" }, { "name": "duration", "kind": "optional", "type": "number", "description": "" }, { "name": "durationFull", "kind": "optional", "type": "number", "description": "" }, { "name": "billDate", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "billStatus", "kind": "optional", "type": "boolean", "description": "" }, { "name": "reassigned", "kind": "optional", "type": "boolean", "description": "" }, { "name": "filesExists", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "formerUser", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "assignor", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "approvedBy", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "taskType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "client", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "works", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "duration", "kind": "optional", "type": "number", "description": "" }, { "name": "suggestedDuration", "kind": "optional", "type": "number", "description": "" }, { "name": "price", "kind": "optional", "type": "number", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "standartizedWork", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "workType", "kind": "optional", "type": "number", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "equipment", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] } ] }, { "name": "materials", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "amount", "kind": "optional", "type": "number", "description": "" }, { "name": "suggestedAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "price", "kind": "optional", "type": "number", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "standartizedMaterial", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "debited", "kind": "optional", "type": "boolean", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "equipment", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] } ] }, { "name": "routeHistories", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "distance", "kind": "optional", "type": "number", "description": "" }, { "name": "duration", "kind": "optional", "type": "number", "description": "" }, { "name": "price", "kind": "optional", "type": "number", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "causes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "cause", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "createdBy", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "requireObjectCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "requireSignatureCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "taskTypePriority", "kind": "optional", "type": "number", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "version", "kind": "optional", "type": "number", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "receivedByExternalSystem", "kind": "optional", "type": "boolean", "description": "" }, { "name": "policyAgreement", "kind": "optional", "type": "string", "description": "" }, { "name": "policyDate", "kind": "optional", "type": "string", "description": "" }, { "name": "unsignedReason", "kind": "optional", "type": "string", "description": "" }, { "name": "additionalEvaluationForms", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "warrantyClaimNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "warrantyClaimDate", "kind": "optional", "type": "string", "description": "" }, { "name": "sla", "kind": "optional", "type": "object", "nullable": true, "description": "

SLA assigned to the task, or null when none is assigned. duration is in MINUTES - the admin UI displays it as hours (duration / 60).

", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "SLA duration in minutes." } ] }, { "name": "workspaceCautionCode", "kind": "optional", "type": "object", "nullable": true, "description": "

Assigned PIP (WorkspaceCautionCode). Only present when oem_integration feature is enabled.

", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "hasChildren", "kind": "optional", "type": "boolean", "description": "" }, { "name": "helpers", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "

Returned when the request contains no recognised filter parameter (e.g. guid or systemId), or when more than one entity matches.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"error\":\"At least one recognised filter parameter (e.g. guid or systemId) is required.\"}", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get standartized work list [path] Frontu API Sandbox/ClientApi/StandartizedWork/ { "id": "timyUVad5mItYtVOif2cD", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/standartized_works", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_works" } ], "name": "Get standartized work list", "description": "This endpoint allows to return all standartized work list.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "" }, { "name": "nightRate", "kind": "optional", "type": "integer", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/WorkspaceCustomField [path] Frontu API Sandbox/ [title] Get standartized material list [path] Frontu API Sandbox/ClientApi/StandartizedMaterial/ { "id": "GCSdhLLpVK5I3gAwJ7ZEW", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/standartized_materials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_materials" } ], "name": "Get standartized material list", "description": "This endpoint allows to get all standartized material list information. ", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "hashtag", "kind": "optional", "type": "string", "description": "" }, { "name": "materialType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update MaterialType [path] Frontu API Sandbox/ClientApi/MaterialType/ { "id": "sLTSY_i_BtJWcWPG3Jx2p", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/material_types", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/material_types" } ], "name": "Create / Update MaterialType", "description": "This enpoint allows to create or update material type.\n\nIf you want to update Material Type using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Material [path] Frontu API Sandbox/ [title] Get Equipments list [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "cLT8BQ-gg55qlW5yU6s-G", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/equipments", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipments" } ], "name": "Get Equipments list", "description": "This endpoint allows to get equipments list\n\nIf you want to update Equipments value using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "string", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "" }, { "name": "equipmentModel", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "installDate", "kind": "optional", "type": "string", "description": "" }, { "name": "warrantyExpirationDate", "kind": "optional", "type": "string", "description": "" }, { "name": "nextMaintenanceDate", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "paidBy", "kind": "optional", "type": "string", "description": "" }, { "name": "location", "kind": "optional", "type": "string", "description": "" }, { "name": "equipmentCode", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Place detail information [path] Frontu API Sandbox/ClientApi/Place/ { "id": "sdKTSGmIBEayp-LDvnil-", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/places/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/places/details" } ], "name": "Get Place detail information", "description": "This endpoind allows to retrieve all information about one specific place and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "scanCode", "kind": "optional", "type": "string", "description": "" }, { "name": "object", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "" }, { "name": "latitude", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update StandartizedMaterial [path] Frontu API Sandbox/ClientApi/StandartizedMaterial/ { "id": "aZJncHD65opGtjKE6W9sY", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/standartized_materials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_materials" } ], "name": "Create / Update StandartizedMaterial", "description": "

Allows to create or update standartized material object values.

\n

If you want to update Standartized Material using POST method you need to fill information for guid field or systemId field in request body.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1standartizedmaterials/get ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "materialType", "kind": "required", "type": "string", "description": "

e.g.: kg, l, inch

" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "Item price in cents" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/TaskRequest [path] Frontu API Sandbox/ [title] Get workspaces list [path] Frontu API Sandbox/ClientApi/Workspace/ { "id": "zhkX9tNQJg3tEGXOnnAzm", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/workspaces", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspaces" } ], "name": "Get workspaces list", "description": "Returns all workspaces", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" }, { "kind": "optional", "name": "tag", "type": "string", "description": "

Tag systemId, guid or title.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "

Workspace title (name)

" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "Workspace serial number" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "" }, { "name": "latitude", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "office", "kind": "optional", "type": "string", "description": "" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "apartmentNumber", "kind": "optional", "type": "integer", "description": "" }, { "name": "signatureCode", "kind": "optional", "type": "string", "description": "" }, { "name": "objectCode", "kind": "optional", "type": "string", "description": "" }, { "name": "client", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "unique" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "warrantyIndicator", "kind": "optional", "type": "integer", "description": "" }, { "name": "warrantyRequired", "kind": "optional", "type": "boolean", "description": "" }, { "name": "warrantyStartDate", "kind": "optional", "type": "string", "description": "Warranty start date" }, { "name": "warrantyEndDate", "kind": "optional", "type": "string", "description": "Warranty end date" }, { "name": "extendedWarrantyEndDate", "kind": "optional", "type": "string", "description": "Extended warranty end date" }, { "name": "warrantyIndicatorLimit", "kind": "optional", "type": "integer", "description": "Warranty indicator limit", "format": "int32" }, { "name": "extendedWarrantyIndicatorLimit", "kind": "optional", "type": "integer", "description": "Extended warranty indicator limit", "format": "int32" }, { "name": "warrantyResponsiblePerson", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "firstName", "kind": "optional", "type": "string", "description": "" }, { "name": "lastName", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "" }, { "name": "fullAddress", "kind": "optional", "type": "string", "description": "" }, { "name": "region", "kind": "optional", "type": "string", "description": "" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Tag titles assigned to the record.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity Not Found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Task [path] Frontu API Sandbox/ClientApi/Task/ { "id": "tqh1qbXJrpDz7agDCr-w9", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/tasks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks" } ], "name": "Create / Update Task", "description": "

This endpoint allows to create or update the task object.

\n

If you want to update Task using POST method you need to fill information for guid field or systemId field in request body.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1tasks/get ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "plannedTime", "kind": "required", "type": "string", "description": "" }, { "name": "plannedEndTime", "kind": "optional", "type": "string", "description": "" }, { "name": "fixedPlannedTime", "kind": "optional", "type": "boolean", "description": "

Planned time is agreed with the customer and must not be moved by route planning. Only accepted when the route optimisation feature is enabled, and ignored once the task is in progress, unsigned, done or aborted.

" }, { "name": "client", "kind": "required", "type": "string", "description": "GUID or systemId of Client" }, { "name": "payer", "kind": "optional", "type": "string", "description": "GUID or systemId of Client" }, { "name": "workspace", "kind": "required", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "taskType", "kind": "required", "type": "string", "description": "" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "createdBy", "kind": "optional", "type": "string", "description": "

GUID of the user which created the task. Optional on create — when omitted or empty, it defaults to the user authenticated by the access token making the request.

" }, { "name": "taskTypePriority", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "receivedByExternalSystem", "kind": "optional", "type": "boolean", "description": "Mark if this task is received by external system" }, { "name": "requireObjectCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "requireSignatureCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Task status, if it is finished or not.

" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "GUID or systemId of the parent Task" }, { "name": "taskTemplate", "kind": "optional", "type": "string", "description": "GUID or systemId of the parent Task template" }, { "name": "responsiblePerson", "kind": "optional", "type": "string", "description": "GUID or systemId of the Responsible person" }, { "name": "office", "kind": "optional", "type": "string", "description": "GUID or systemId of the office" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Array with tag strings", "example": "[\"Test Tag\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "smsPhoneNumber", "kind": "optional", "type": "string", "description": "Phone number in E.164 format for SMS notification" }, { "name": "stopStatusMessage", "kind": "optional", "type": "string", "description": "Message shown when task is stopped" }, { "name": "provisionStatus", "kind": "optional", "type": "string", "description": "Provision status of the task" }, { "name": "warrantyClaimNumber", "kind": "optional", "type": "string", "description": "Warranty claim number" }, { "name": "warrantyClaimDate", "kind": "optional", "type": "string", "description": "

Warranty claim date (format Y-m-d H:i

)

" }, { "name": "warrantyClaimStatus", "kind": "optional", "type": "boolean", "description": "Warranty claim status" }, { "name": "workspaceCautionCode", "kind": "optional", "type": "string", "description": "

GUID of the WorkspaceCautionCode (PIP) to assign. Only available when oem_integration feature is enabled. Send null to unassign.

" }, { "name": "additionalEvaluationForms", "kind": "optional", "type": "array", "description": "

GUIDs of additional evaluation forms to attach to the task. Only accepted when creating a task (ignored on update). Each form must be published, mandatory (required), not a compliance form and must not belong to the task's own task type — forms of the task type are attached automatically.

", "example": "[\"314c012e-92cc-11e7-bf70-080027c30a86\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get WorkspaceCustomField list [path] Frontu API Sandbox/ClientApi/WorkspaceCustomField/ { "id": "oMucaWKZ2ivqH9QjDYf-L", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces" } ], "name": "Get WorkspaceCustomField list", "description": "This endpoint allows to get workspaces custom fields", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Frontu API Sandbox [path] / [title] Create / Update CreditStatus [path] Frontu API Sandbox/ClientApi/CreditStatus/ { "id": "4CO2Cq7whE8LkjgfiRjBR", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/creditstatuses", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/creditstatuses" } ], "name": "Create / Update CreditStatus", "description": "This endpoint allows to create or update the credit status\n\nIf you want to update Credit Status using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/ResponsiblePerson [path] Frontu API Sandbox/ [title] Get task template list [path] Frontu API Sandbox/ClientApi/TaskTemplate/ { "id": "puAXsinDP-pME27nl4M6b", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/task/templates", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task/templates" } ], "name": "Get task template list", "description": "Returns a paginated list of task templates with basic information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "application/xml" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp (WHERE table.version >

).

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "default", "code": "// Task templates list example\n{\n \"next_page\": 0,\n \"items\": [\n {\n \"title\": \"Test task template title\",\n \"guid\": \"bb11c223-34de-455f-66g7-h7i8899j0011\",\n \"systemId\": \"TT001\"\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "0 if no more pages exist" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "Task template title" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Unique identifier generated by Frontu" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "External system identifier" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update TaskCustomField [path] Frontu API Sandbox/ClientApi/TaskCustomField/ { "id": "mci3bKWOALDQSFy3iOyHW", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks" } ], "name": "Create / Update TaskCustomField", "description": "This endpoint allows to create or update task custom field values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number,\n* 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get EquipmentsCustomField list [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "Mnx62f15lPTS40OKRTluN", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/equipments", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/equipments" } ], "name": "Get EquipmentsCustomField list", "description": "This endpoint allows to get equipment custom fields", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. * (WHERE table.version >

).

" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "type", "kind": "required", "type": "number", "description": "" }, { "name": "required", "kind": "required", "type": "boolean", "description": "" }, { "name": "visible", "kind": "required", "type": "boolean", "description": "" }, { "name": "data", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get workspace detail information [path] Frontu API Sandbox/ClientApi/Workspace/ { "id": "SEzoAs3amdAX51N3eesG-", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/workspaces/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspaces/details" } ], "name": "Get workspace detail information", "description": "This endpoint allows to retrieve all detailed information about one specific workspace and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "title", "type": "string", "description": "Title." }, { "kind": "optional", "name": "serialNumber", "type": "string", "description": "Serial number." }, { "kind": "optional", "name": "objectCode", "type": "string", "description": "Object code." }, { "kind": "optional", "name": "tag", "type": "string", "description": "

Tag systemId, guid or title.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "" }, { "name": "latitude", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "apartmentNumber", "kind": "optional", "type": "boolean", "description": "" }, { "name": "signatureCode", "kind": "optional", "type": "string", "description": "" }, { "name": "objectCode", "kind": "optional", "type": "string", "description": "" }, { "name": "client", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "warrantyIndicator", "kind": "optional", "type": "integer", "description": "" }, { "name": "warrantyRequired", "kind": "optional", "type": "boolean", "description": "" }, { "name": "warrantyStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "warrantyEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "extendedWarrantyEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "warrantyIndicatorLimit", "kind": "optional", "type": "integer", "description": "" }, { "name": "extendedWarrantyIndicatorLimit", "kind": "optional", "type": "integer", "description": "" }, { "name": "sendMaintenanceNotification", "kind": "optional", "type": "boolean", "description": "" }, { "name": "hoursNotificationSentAt", "kind": "optional", "type": "string", "description": "" }, { "name": "firstMaintenanceHours", "kind": "optional", "type": "integer", "description": "" }, { "name": "secondMaintenanceHours", "kind": "optional", "type": "integer", "description": "" }, { "name": "intervalMaintenanceHours", "kind": "optional", "type": "integer", "description": "" }, { "name": "office", "kind": "optional", "type": "string", "description": "" }, { "name": "region", "kind": "optional", "type": "string", "description": "" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Tag titles assigned to the record.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Work [path] Frontu API Sandbox/ClientApi/Work/ { "id": "dVCRK2ZgFbEywrSvOwAGH", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/works", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/works" } ], "name": "Create / Update Work", "description": "This enpoind allows to create or update work values.\n\nIf you want to update Work using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "standartizedWork", "kind": "optional", "type": "string", "description": "GUID or systemId of Starndartized Work" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "task", "kind": "optional", "type": "string", "description": "GUID or systemId of Task" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "vat", "kind": "optional", "type": "number", "description": "" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "price", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "priceWithVat", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "suggestedDuration", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "dateOfIntervention", "kind": "optional", "type": "string", "description": "

Date of intervention (ISO 8601). Optional; falls back to created when not set.

", "format": "date-time" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "workType", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "equipment", "kind": "optional", "type": "string", "description": "GUID or systemId of Equipment" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get TaskStatusHistory [path] Frontu API Sandbox/ClientApi/TaskStatusHistory/ { "id": "3h7QIMAKn8RY4PVIjMAKm", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/tasksstatushistory", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasksstatushistory" } ], "name": "Get TaskStatusHistory", "description": "

This endpoint allows us to get task status history information, oldest first (ordered by\ncreated ascending). Available in JSON and XML via the Accept header.

\n

Pass task to narrow the feed to a single task. Omit it to get the full history feed for every\ntask, as before. An identifier matching no task returns 200 with an empty items list.

\n

Pass status to narrow the feed to particular task statuses - for example status=300 returns\nonly the entries where work was stopped, each carrying the reason in stopStatusMessage. All\nfilters combine.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values", "Example of a stopped entry" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "task", "type": "string", "description": "

Narrow the results to one task. Accepts either the task GUID (generated by Frontu) or its systemId (identifier from an external system) - the endpoint detects which format was passed. Omit to return every task's history.

" }, { "kind": "optional", "name": "status", "type": "string", "example": "300,600", "description": "

Narrow the results to one or more task statuses. Accepts a single status (status=300) or a comma separated list (status=300,600). Statuses no record uses are simply not matched. Anything other than digits and commas returns 400. Omit to return entries of every status.

" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page. Values above 1000 are capped at 1000; 0 or a missing value falls back to 100.

" }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. (WHERE table.created >

). Strictly greater than, so records created in the boundary second are not returned. Omit to get the full history.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "status", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "coordinates", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "stopStatusMessage", "kind": "required", "type": "string", "nullable": true, "description": "

The reason work was stopped, as recorded on this entry. Free text taken from the stop reason the app user picked, so it is the reason title rather than a stable identifier from the taskstopreasons dictionary. Null on entries that do not record a stop.

" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Returned when the status filter is not an integer or a comma separated list of integers", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get StandartizedWork detail information [path] Frontu API Sandbox/ClientApi/StandartizedWork/ { "id": "RXdVI7Ml7ITHRtCAAQA1S", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/standartized_works/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_works/details" } ], "name": "Get StandartizedWork detail information", "description": "This endpoind allows to retrieve all information about one specific standartized work and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "title", "type": "string", "description": "Title." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "" }, { "name": "nightRate", "kind": "optional", "type": "integer", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get TaskCustomField information [path] Frontu API Sandbox/ClientApi/TaskCustomField/ { "id": "Z6JVFxko_NhL-q3cgLp76", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks/details" } ], "name": "Get TaskCustomField information", "description": "This endpoind allows to retrieve all information about one specific task with custom fields and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example with test values", "example-2" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get responsible person list [path] Frontu API Sandbox/ClientApi/ResponsiblePerson/ { "id": "8qgGtyfDhRBN62NQYiQNl", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/responsible_persons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/responsible_persons" } ], "name": "Get responsible person list", "description": "This endpoint allows to return all responsible person list.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" }, { "kind": "optional", "name": "deleted", "type": "integer", "description": "0 or 1" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "firstName", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "lastName", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "position", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "phone", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "email", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "note", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "client", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update TaskType [path] Frontu API Sandbox/ClientApi/TaskType/ { "id": "WCtqan7l2-mqsLGNWClh7", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/task_types", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_types" } ], "name": "Create / Update TaskType", "description": "This enpoind allows to create or update task type values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "mailList", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get ClientCustomField list [path] Frontu API Sandbox/ClientApi/ClientCustomField/ { "id": "VtMSsvWYvpBgZdgjQPONB", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/clients", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/clients" } ], "name": "Get ClientCustomField list", "description": "This endpoint allows to get client custom fields", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Equipment actions list [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "M_SVTHVysGkwTDW0L0ost", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/equipmentactions", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipmentactions" } ], "name": "Get Equipment actions list", "description": "This endpoint allows to get Equipment actions list\n\nIf you want to update Equipment actions value using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "required", "type": "number", "description": "" }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "equipment", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "note", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "action", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "user", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Workspace [path] Frontu API Sandbox/ [title] Get all MaterialTypes [path] Frontu API Sandbox/ClientApi/MaterialType/ { "id": "o41tCdkmMngXbsJsVhhTl", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/material_types", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/material_types" } ], "name": "Get all MaterialTypes", "description": "This endpoint allows to return all material types", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Workspace [path] Frontu API Sandbox/ClientApi/Workspace/ { "id": "3gw3luciNZlfS8P3gPhtd", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/workspaces", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspaces" } ], "name": "Create / Update Workspace", "description": "

This enpoint allows us to create or update workspace.

\n

If you want to update Workspace using POST method you need to fill information for guid field or systemId field in request body.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1workspaces/get ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "client", "kind": "required", "type": "string", "description": "GUID or systemId of Client" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "apartmentNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "latitude", "kind": "optional", "type": "number", "description": "" }, { "name": "longitude", "kind": "optional", "type": "number", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "objectCode", "kind": "optional", "type": "string", "description": "" }, { "name": "signatureCode", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "warrantyRequired", "kind": "optional", "type": "boolean", "description": "Mark if the warranty indicator is required" }, { "name": "warrantyIndicator", "kind": "optional", "type": "integer", "description": "Warranty indicator", "format": "int32" }, { "name": "warrantyStartDate", "kind": "optional", "type": "string", "description": "Warranty start date" }, { "name": "warrantyEndDate", "kind": "optional", "type": "string", "description": "Warranty end date" }, { "name": "extendedWarrantyEndDate", "kind": "optional", "type": "string", "description": "Extended warranty end date" }, { "name": "warrantyIndicatorLimit", "kind": "optional", "type": "integer", "description": "Warranty indicator limit", "format": "int32" }, { "name": "zipCode", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "string", "description": "

Which are type is object : warehouse or object

" }, { "name": "fullAddress", "kind": "optional", "type": "string", "description": "Full workspace address" }, { "name": "projectManager", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "technician", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "office", "kind": "optional", "type": "string", "description": "GUID or systemId of Office" }, { "name": "region", "kind": "optional", "type": "string", "description": "GUID or systemId of Region" }, { "name": "tags", "kind": "optional", "type": "array", "description": "

Tags to assign. Each value is matched against tag systemId, guid and title in that order; an unmatched value creates a new tag with that title.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Note list [path] Frontu API Sandbox/ClientApi/Note/ { "id": "XZ5MAtGf5H_TD1VUSnqGj", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/notes", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/notes" } ], "name": "Get Note list", "description": "This endpoint allows to get the note information", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "image", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskTemplate", "kind": "optional", "type": "string", "description": "" }, { "name": "user", "kind": "optional", "type": "string", "description": "" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Task Summary PDF [path] Frontu API Sandbox/ClientApi/Task/ { "id": "jT_pH3WtRcxvzYit5wAD3", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/tasks/summary", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks/summary" } ], "name": "Get Task Summary PDF", "description": "This endpoint allows to get task summary in the pdf file. Guid is required query parameter others are additionals.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found or Task is not finished", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get StandartizedMaterial detail information [path] Frontu API Sandbox/ClientApi/StandartizedMaterial/ { "id": "OVJqHogPXguqaTUGnKxYg", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/standartized_materials/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_materials/details" } ], "name": "Get StandartizedMaterial detail information", "description": "This endpoind allows to retrieve all information about one specific client and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "title", "type": "string", "description": "Title." }, { "kind": "optional", "name": "serialNumber", "type": "string", "description": "Serial number." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "hashtag", "kind": "optional", "type": "string", "description": "" }, { "name": "materialType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Creates a new Note from the submitted data. [path] Frontu API Sandbox/ClientApi/Note/ { "id": "8Ob-ycREVEmxGbi40lnbz", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/notes", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/notes" } ], "name": "Creates a new Note from the submitted data.", "description": "This endpoint allows to create the note information\n\nIf you want to update Note using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "task", "kind": "optional", "type": "string", "description": "GUID or systemId of Task" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Returned when the form has errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get TaskType [path] Frontu API Sandbox/ClientApi/TaskType/ { "id": "RwtJXDQuMrmzoxvqKvFfF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/task_types/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_types/details" } ], "name": "Get TaskType", "description": "This endpoind allows to retrieve all information about one specific task types and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "mailList", "kind": "optional", "type": "string", "description": "" }, { "name": "requireObjectCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "requireSignatureCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get MaterialType detail information [path] Frontu API Sandbox/ClientApi/MaterialType/ { "id": "AuNE9AkC6VOUExJdfGG32", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/material_types/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/material_types/details" } ], "name": "Get MaterialType detail information", "description": "This endpoind allows to retrieve all information about one specific material type and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/ClientCustomField [path] Frontu API Sandbox/ [title] ClientApi/CreditStatus [path] Frontu API Sandbox/ [title] Create / Update TaskRequest [path] Frontu API Sandbox/ClientApi/TaskRequest/ { "id": "fS87KPk_0204NSFpovjgZ", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/task_requests", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_requests" } ], "name": "Create / Update TaskRequest", "description": "This endpoint allows to create or update the task request data.\n\nIf you want to update Task request using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "client", "kind": "optional", "type": "string", "description": "GUID or systemId of Client" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "equipment", "kind": "optional", "type": "string", "description": "GUID or systemId of Equipment" }, { "name": "office", "kind": "optional", "type": "string", "description": "GUID or systemId of Office" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Array with tag strings", "example": "[\"Test Tag\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get task request list [path] Frontu API Sandbox/ClientApi/TaskRequest/ { "id": "Xr1U70cqkEr50V6cT9OHf", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/task_requests", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_requests" } ], "name": "Get task request list", "description": "This endpoint allows to get all data about task request.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp >

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "versionTo", "type": "integer", "description": "

Filter data by given timestamp <

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" }, { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "task", "type": "string", "description": "To get requests without tasks pass 0 as value" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "client", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "companyCode", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "type", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "createdBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] }, { "name": "task", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "equipment", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Note [path] Frontu API Sandbox/ [title] Create / Update Equipment models [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "4rV0npkeYupT6av6vh6nc", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/equipment_models", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/equipment_models" } ], "name": "Create / Update Equipment models", "description": "This endpoint allows to update or create equipment models values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Place [path] Frontu API Sandbox/ [title] ClientApi/MaterialType [path] Frontu API Sandbox/ [title] Get Material [path] Frontu API Sandbox/ClientApi/Material/ { "id": "T4bBIu7QB_XQPamrpvscf", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/materials/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/materials/details" } ], "name": "Get Material", "description": "This endpoind allows to retrieve all information about one specific material and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "vat", "kind": "optional", "type": "number", "description": "" }, { "name": "currency", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "" }, { "name": "suggestedAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "" }, { "name": "price", "kind": "optional", "type": "integer", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "integer", "description": "" }, { "name": "sfNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "selfCost", "kind": "optional", "type": "integer", "description": "" }, { "name": "materialType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "standartizedMaterial", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "debited", "kind": "optional", "type": "boolean", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "causalPart", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Place list [path] Frontu API Sandbox/ClientApi/Place/ { "id": "UNyHfDHpsKH95-sazNZvE", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/places", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/places" } ], "name": "Get Place list", "description": "This endpoint allows to return all places", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with real data" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "number", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "number", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "scanCode", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "type", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "note", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "longitude", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "latitude", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/RouteHistory [path] Frontu API Sandbox/ [title] Get CreditStatus list [path] Frontu API Sandbox/ClientApi/CreditStatus/ { "id": "_wVyRsMa-ESuqCjyrZ2Lh", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/creditstatuses", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/creditstatuses" } ], "name": "Get CreditStatus list", "description": "This endpoint allows to return credit status", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page", "default": "1" }, { "kind": "optional", "name": "version", "type": "string", "description": "Timestamp to limit data", "default": "0" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get TaskCustomField list [path] Frontu API Sandbox/ClientApi/TaskCustomField/ { "id": "_4eT_pJyeoxUj1Z1XWjA_", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/tasks" } ], "name": "Get TaskCustomField list", "description": "This endpoint allows to get task custom fields\n\nIf you want to update Task Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Set invoice status to true and define invoice number [path] Frontu API Sandbox/ClientApi/Task/ { "id": "LDH0ePGvZ_qSEThT7ljvi", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://dev1.frontu.com//client/api/v2/tasks/update-invoice-number", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks/update-invoice-number" } ], "name": "Set invoice status to true and define invoice number", "description": "This endpoint allows to update task invoice number. ", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "invoiceNumber", "kind": "optional", "type": "string", "description": "Invoice number" }, { "name": "systemId", "kind": "required", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "required", "type": "string", "description": "Identifier from Frontu" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Operation failed", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Task list [path] Frontu API Sandbox/ClientApi/Task/ { "id": "HABBlUx1CO1IT27UP7I8Q", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/tasks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/tasks" } ], "name": "Get Task list", "description": "

This endpoint allows to return task list

\n

In this case you can get 11 different task statuses.

\n

Task status inactive - 100

\n

Task status synced - 101

\n

Task status unassigned - 102

\n

Task status reopened - 110

\n

Task status in progress - 200

\n

Task status stopped - 300

\n

Task status done - 400

\n

Task status done with note - 401

\n

Task status approved - 402

\n

Task status unsigned - 500

\n

Task status aborted - 600

\n

Task status template - 900

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp >

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "versionTo", "type": "integer", "description": "

Filter data by given timestamp <

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" }, { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." }, { "kind": "optional", "name": "code", "type": "string", "description": "Task code identifier." }, { "kind": "optional", "name": "billStatus", "type": "string", "description": "Bill status." }, { "kind": "optional", "name": "status", "type": "string", "description": "

Task status, if it is finished or not.

" }, { "kind": "optional", "name": "taskType", "type": "string", "description": "

Tastype systemId / guid.

" }, { "kind": "optional", "name": "client", "type": "string", "description": "

Client systemId / guid.

" }, { "kind": "optional", "name": "workspace", "type": "string", "description": "

Workspace systemId / guid.

" }, { "kind": "optional", "name": "office", "type": "string", "description": "

Office systemId / guid.

" }, { "kind": "optional", "name": "tag", "type": "string", "description": "Tag." }, { "kind": "optional", "name": "receivedByExternalSystem", "type": "string", "description": "

Task status, if it is received by external system.

" }, { "kind": "optional", "name": "isChild", "type": "boolean", "description": "

true returns only tasks that are children of another task (parentId set), false only tasks without a parent. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.

" }, { "kind": "optional", "name": "hasChildren", "type": "boolean", "description": "

true returns only tasks that have at least one child task, false only tasks with no children. Also accepts 1/0. Omitted, empty or unrecognised values leave the list unfiltered.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "code", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientName", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientEmail", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "rating", "kind": "optional", "type": "number", "description": "" }, { "name": "agreement", "kind": "optional", "type": "boolean", "description": "" }, { "name": "signatureType", "kind": "optional", "type": "boolean", "description": "" }, { "name": "signatureFile", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "abortMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNote", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "clientNoteReply", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "distance", "kind": "optional", "type": "number", "description": "" }, { "name": "workPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "workPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "routePrice", "kind": "optional", "type": "number", "description": "" }, { "name": "routePriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "materialPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "finalPriceWithVat", "kind": "optional", "type": "number", "description": "" }, { "name": "vat", "kind": "optional", "type": "number", "description": "" }, { "name": "currency", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "status", "kind": "optional", "type": "number", "description": "" }, { "name": "stopStatusMessage", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "plannedEndTime", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "fixedPlannedTime", "kind": "optional", "type": "boolean", "description": "" }, { "name": "fetched", "kind": "optional", "type": "boolean", "description": "" }, { "name": "time", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "ended", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "pastDue", "kind": "optional", "type": "boolean", "description": "" }, { "name": "duration", "kind": "optional", "type": "number", "description": "" }, { "name": "durationFull", "kind": "optional", "type": "number", "description": "" }, { "name": "billDate", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "billStatus", "kind": "optional", "type": "boolean", "description": "" }, { "name": "reassigned", "kind": "optional", "type": "boolean", "description": "" }, { "name": "filesExists", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "formerUser", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "assignor", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "client", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "createdBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "requireObjectCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "requireSignatureCode", "kind": "optional", "type": "boolean", "description": "" }, { "name": "taskTypePriority", "kind": "optional", "type": "number", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "version", "kind": "optional", "type": "number", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "value", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "literalStatus", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "sla", "kind": "optional", "type": "object", "nullable": true, "description": "

SLA assigned to the task, or null when none is assigned. duration is in MINUTES - the admin UI displays it as hours (duration / 60).

", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "SLA duration in minutes." } ] }, { "name": "receivedByExternalSystem", "kind": "optional", "type": "boolean", "description": "" }, { "name": "helpers", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Task file [path] Frontu API Sandbox/ClientApi/Task/ { "id": "OmDhgq9iG0wwTM9bgEu2O", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/task_file/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/task_file/{guid}" } ], "name": "Create / Update Task file", "description": "This enpoind allows to update or create the task file information\n\nIf you want to update Task file using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "file", "kind": "optional", "type": "string", "description": "File to upload.", "format": "binary" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Work [path] Frontu API Sandbox/ClientApi/Work/ { "id": "YVG2U_rFnfIXO57MEFNWX", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/works/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/works/details" } ], "name": "Get Work", "description": "This endpoind allows to retrieve all information about one specific work and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "" }, { "name": "suggestedDuration", "kind": "optional", "type": "integer", "description": "" }, { "name": "currency", "kind": "optional", "type": "string", "description": "" }, { "name": "vat", "kind": "optional", "type": "string", "description": "" }, { "name": "rate", "kind": "optional", "type": "integer", "description": "" }, { "name": "price", "kind": "optional", "type": "integer", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "integer", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "standartizedWork", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "object", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "task", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "taskTemplate", "kind": "optional", "type": "string", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "dateOfIntervention", "kind": "optional", "type": "string", "description": "Date of intervention. Falls back to created when not set." }, { "name": "startTime", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "endTime", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "workType", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update EquipmentsCustomField [path] Frontu API Sandbox/ClientApi/Equipment/ { "id": "UGbEJNi4rGGQzTbGJMX54", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/equipments", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/equipments" } ], "name": "Create / Update EquipmentsCustomField", "description": "This endpoint allows to create or update equipments custom field values.\n\nIf you want to update Equipments Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number, * 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Client list [path] Frontu API Sandbox/ClientApi/Client/ { "id": "BvlBZuBhY2HFGOjq-RvjZ", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/clients", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/clients" } ], "name": "Get Client list", "description": "Returns all clients array.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "Filter data by given timestamp.", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "integer", "description": "

Items per page 100/200/300.

", "default": 100, "pattern": "(100|200|300)" }, { "kind": "optional", "name": "tag", "type": "string", "description": "

Tag systemId, guid or title.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "zipCode", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "" }, { "name": "companyVatCode", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "clientType", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "reportEmails", "kind": "optional", "type": "string", "description": "" }, { "name": "tags", "kind": "optional", "type": "array", "description": "Tag titles assigned to the record.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customValues", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "Unique" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Copy a Note to another Task [path] Frontu API Sandbox/ClientApi/Note/ { "id": "hVK_K3h7BkjIg72XFs4X-", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/note/copy", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/note/copy" } ], "name": "Copy a Note to another Task", "description": "This endpoint allows to copy an existing note to another task.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "note", "kind": "required", "type": "string", "description": "GUID or ID of the Note to copy" }, { "name": "task", "kind": "required", "type": "string", "description": "GUID or ID of the target Task" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successfully created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "image", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "images", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "task", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "taskTemplate", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "evaluationNote", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Form validation errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get RouteHistory list [path] Frontu API Sandbox/ClientApi/RouteHistory/ { "id": "dw0YNS2K95U91jBelSmdT", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/routehistories", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/routehistories" } ], "name": "Get RouteHistory list", "description": "This endpoint allows to get route histories", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. (WHERE table.version >

)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "distance", "kind": "optional", "type": "string", "description": "" }, { "name": "duration", "kind": "optional", "type": "string", "description": "" }, { "name": "vat", "kind": "optional", "type": "string", "description": "" }, { "name": "price", "kind": "optional", "type": "string", "description": "" }, { "name": "priceWithVat", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "user", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get ClientCustomField information [path] Frontu API Sandbox/ClientApi/ClientCustomField/ { "id": "q7krHiuSaC_s_d10AG3cY", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/clients/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/clients/details" } ], "name": "Get ClientCustomField information", "description": "This endpoind allows to retrieve all information about one specific client and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get ResponsiblePerson detail information [path] Frontu API Sandbox/ClientApi/ResponsiblePerson/ { "id": "2aHDHfk-AB-CpepAlzvAS", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/responsible_persons/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/responsible_persons/details" } ], "name": "Get ResponsiblePerson detail information", "description": "This endpoind allows to retrieve all information about one specific responsible person and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "firstName", "kind": "optional", "type": "string", "description": "" }, { "name": "lastName", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "client", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Place [path] Frontu API Sandbox/ClientApi/Place/ { "id": "XvBsfh4Fwr5L_CUeWE9SP", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/places", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/places" } ], "name": "Create / Update Place", "description": "This enpoint allows to create or update place.\n\nIf you want to update Place using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "scanCode", "kind": "required", "type": "string", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "workspace", "kind": "required", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "" }, { "name": "latitude", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Works list [path] Frontu API Sandbox/ClientApi/Work/ { "id": "TTtbN_u6YujIeT1Re6nlL", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/works", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/works" } ], "name": "Get Works list", "description": "This endpoint allows to get all data about works.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "duration", "kind": "required", "type": "number", "description": "" }, { "name": "suggestedDuration", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "unit", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "workType", "kind": "required", "type": "number", "description": "" }, { "name": "workTimeType", "kind": "required", "type": "number", "description": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "vat", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "rate", "kind": "required", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "priceWithVat", "kind": "required", "type": "number", "description": "" }, { "name": "description", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "standartizedWork", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "defaultDuration", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] }, { "name": "workspace", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "type", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "task", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "code", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "taskTemplate", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "dateOfIntervention", "kind": "optional", "type": "string", "description": "Date of intervention. Falls back to created when not set." }, { "name": "startTime", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "endTime", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "equipment", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Client [path] Frontu API Sandbox/ClientApi/Client/ { "id": "YYu3RKb5VwBU94YAXReWb", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/clients", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/clients" } ], "name": "Create / Update Client", "description": "

Request to create or update the Client.

\n

If you want to update Client using POST method you need to fill information for guid field or systemId field in request body.

\n

Example how to use custom values:

\n

You need to specify it for example like this:

\n

first value is guid of the custom field (for this case you can select all custom fields in this endpoint - https://tasker.stoplight.io/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1customfields~1clients/get ), and second is value of the custom field.\n\"customValues\":\n{\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\": \"Custom Value\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e35\": \"Custom Value 2\",\n\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e38\": \"2\"\n}

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "example-1" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "Client name" }, { "name": "address", "kind": "optional", "type": "string", "description": "Client address" }, { "name": "city", "kind": "optional", "type": "string", "description": "Client city" }, { "name": "zipCode", "kind": "optional", "type": "string", "description": "Client postal code" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Client phone number" }, { "name": "email", "kind": "optional", "type": "string", "description": "

Client E-mail

" }, { "name": "creditStatus", "kind": "optional", "type": "string", "description": "Credit status guid or systemId" }, { "name": "companyVatCode", "kind": "optional", "type": "string", "description": "" }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "clientType", "kind": "optional", "type": "integer", "description": "

1 - physical, 2 - juridical

", "format": "int32" }, { "name": "customValues", "kind": "optional", "type": "string", "description": "

JSON object for custom field data (for example \"guid\": \"value\")

" }, { "name": "reportEmails", "kind": "optional", "type": "string", "description": "It is a additional fields for the client emails" }, { "name": "tags", "kind": "optional", "type": "array", "description": "

Tags to assign. Each value is matched against tag systemId, guid and title in that order; an unmatched value creates a new tag with that title.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "errors", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Equipment [path] Frontu API Sandbox/ [title] Get materials list [path] Frontu API Sandbox/ClientApi/Material/ { "id": "zwewcNFKIBuHvRxbr6wd8", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/materials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/materials" } ], "name": "Get materials list", "description": "This endpoint allows to get all data about materials.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "vat", "kind": "required", "type": "number", "description": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "amount", "kind": "required", "type": "number", "description": "" }, { "name": "suggestedAmount", "kind": "required", "type": "number", "description": "" }, { "name": "rate", "kind": "required", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "priceWithVat", "kind": "required", "type": "number", "description": "" }, { "name": "sfNumber", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "selfCost", "kind": "required", "type": "number", "description": "" }, { "name": "materialType", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "standartizedMaterial", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "serialNumber", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "user", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "debited", "kind": "required", "type": "boolean", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "causalPart", "kind": "required", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Event [path] Frontu API Sandbox/ [title] Create / Update WorkspaceCustomField [path] Frontu API Sandbox/ClientApi/WorkspaceCustomField/ { "id": "6YYbVMQADREBcz5OlhJwR", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces" } ], "name": "Create / Update WorkspaceCustomField", "description": "This endpoint allows to create or update workspace custom field values.\n\nIf you want to update Workspace Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number,\n* 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Copy a File to another Task [path] Frontu API Sandbox/ClientApi/File/ { "id": "_xsCwMsrTN8Xsb9jEvnAW", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/files/copy", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files/copy" } ], "name": "Copy a File to another Task", "description": "This endpoint allows to copy an existing file to another task.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "file", "kind": "required", "type": "string", "description": "GUID or ID of the File to copy" }, { "name": "task", "kind": "required", "type": "string", "description": "GUID or ID of the target Task" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successfully created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "originalName", "kind": "optional", "type": "string", "description": "" }, { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "checksum", "kind": "optional", "type": "string", "description": "" }, { "name": "contentLength", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskRequest", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "companyDetails", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Form validation errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update StandartizedWorkCustomField [path] Frontu API Sandbox/ClientApi/StandartizedWorkCustomField/ { "id": "ak1EcKkkjytjQKcR5o2sG", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks" } ], "name": "Create / Update StandartizedWorkCustomField", "description": "This endpoint allows to create or update standartized work custom field values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number,\n* 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Gets evaluations forms [path] Frontu API Sandbox/ClientApi/EvaluationForm/ { "id": "GDSkb6Yw0cNl62rFeZU3K", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/" } ], "name": "Gets evaluations forms", "description": "This endpoint allows to get evaluations forms information", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page", "default": "1" }, { "kind": "optional", "name": "version", "type": "string", "description": "Timestamp to limit data", "default": "0" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "taskType", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "published", "kind": "optional", "type": "boolean", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "questions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "orderId", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "criterias", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "customAnswer", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" } ] } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Returned when the Client is not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/TaskStopReason [path] Frontu API Sandbox/ [title] Get users list [path] Frontu API Sandbox/ClientApi/User/ { "id": "-pC2rTB911deqSL2iEkKi", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/users", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/users" } ], "name": "Get users list", "description": "This endpoint allows to get all users list", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "surname", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "description": "" }, { "name": "driverId", "kind": "optional", "type": "string", "description": "" }, { "name": "jobTitle", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get StandartizedMaterialCustomField information [path] Frontu API Sandbox/ClientApi/StandartizedMaterialCustomField/ { "id": "1FfYIXE6jyALgpyoOpnhF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials/details" } ], "name": "Get StandartizedMaterialCustomField information", "description": "This endpoind allows to retrieve all information about one specific standartized material with custom fields and query params are used to retreive the one specific client. ", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get StandartizedMaterialCustomField list [path] Frontu API Sandbox/ClientApi/StandartizedMaterialCustomField/ { "id": "iCfcJJhU-pMsWaEHfw2cu", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials" } ], "name": "Get StandartizedMaterialCustomField list", "description": "This endpoint allows to get standartized material custom fields\n\nIf you want to update Standartized Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get StandartizedWorkCustomField information [path] Frontu API Sandbox/ClientApi/StandartizedWorkCustomField/ { "id": "7g5zal3t33BMYTsUfFtWm", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks/details" } ], "name": "Get StandartizedWorkCustomField information", "description": "This endpoind allows to retrieve all information about one specific standartized work with custom fields and query params are used to retreive the one specific client. ", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get File [path] Frontu API Sandbox/ClientApi/File/ { "id": "ceeQ-FzKk_Abrwcgs4-J1", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/files/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files/{guid}" } ], "name": "Get File", "description": "This endopoint allows to get file via guid", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "originalName", "kind": "optional", "type": "string", "description": "" }, { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "checksum", "kind": "optional", "type": "string", "description": "" }, { "name": "contentLength", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Upload task request file [path] Frontu API Sandbox/ClientApi/File/ { "id": "IOxj2hzTUSHOEl5P9ubul", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/files/task_request/upload", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files/task_request/upload" } ], "name": "Upload task request file", "description": "

This endpoint allows to upload a file for a task request using multipart/form-data.

", "contentType": "multipart/form-data", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [ { "name": "file", "kind": "required", "type": "string", "description": "", "format": "binary" }, { "name": "taskRequest", "kind": "required", "type": "string", "description": "" } ], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "originalName", "kind": "optional", "type": "string", "description": "" }, { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "checksum", "kind": "optional", "type": "string", "description": "" }, { "name": "contentLength", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Travel [path] Frontu API Sandbox/ClientApi/Travels/ { "id": "Quir9O5c93QnL-3aIfF2P", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/travels", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/travels" } ], "name": "Create / Update Travel", "description": "This endpoint allows to create or update travel information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "task", "kind": "optional", "type": "string", "description": "GUID or systemId of Task" }, { "name": "user", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "started", "kind": "optional", "type": "string", "description": "Time when the travel started" }, { "name": "ended", "kind": "optional", "type": "string", "description": "Time when the travel ended" }, { "name": "startLongitude", "kind": "optional", "type": "string", "description": "Travel start longitude" }, { "name": "startLatitude", "kind": "optional", "type": "string", "description": "Travel start latitude" }, { "name": "endLongitude", "kind": "optional", "type": "string", "description": "Travel end longitude" }, { "name": "endLatitude", "kind": "optional", "type": "string", "description": "Travel end latitude" }, { "name": "vehicle", "kind": "optional", "type": "string", "description": "Vehicle guid" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create or update an event (upsert by guid or systemId) [path] Frontu API Sandbox/ClientApi/Event/ { "id": "3YXWoEox-SXku8YxbN5kW", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/events", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/events" } ], "name": "Create or update an event (upsert by guid or systemId)", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "maxLength": 50 }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "startDateTime", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "endDateTime", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "type", "kind": "required", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "name": "busy", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "required", "type": "string", "description": "

User identifier — guid or systemId.

" }, { "name": "task", "kind": "optional", "type": "string", "description": "

Task identifier — guid or systemId.

" }, { "name": "resource", "kind": "optional", "type": "string", "description": "

Resource identifier — guid or systemId.

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Updated", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Event", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "name": "busy", "kind": "optional", "type": "boolean", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "task", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "resource", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "created", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "format": "date-time" } ], "modelRef": "#/components/schemas/Event", "isExpanded": true } ] }, { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Event", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "name": "busy", "kind": "optional", "type": "boolean", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "task", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "resource", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "created", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "format": "date-time" } ], "modelRef": "#/components/schemas/Event", "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get File list [path] Frontu API Sandbox/ClientApi/File/ { "id": "YaxrIbWudEBWCwS0aqn8j", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/files", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files" } ], "name": "Get File list", "description": "This endopint allows to get file list", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. (WHERE table.version >

)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "originalName", "kind": "optional", "type": "string", "description": "" }, { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "checksum", "kind": "optional", "type": "string", "description": "" }, { "name": "contentLength", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/StandartizedMaterialRemains [path] Frontu API Sandbox/ [title] Get evaluations by tasks status [path] Frontu API Sandbox/ClientApi/Evaluations/ { "id": "fb-R4OYc4iWJPOlmhztVK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/evaluations/task/status", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/evaluations/task/status" } ], "name": "Get evaluations by tasks status", "description": "Gets evaluations by task status.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "status", "type": "string", "description": "task statuses separated by comma" }, { "kind": "optional", "name": "version", "type": "integer", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": 0, "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number.", "default": 1, "pattern": "\\d+" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "number", "description": "" }, { "name": "items", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "form", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "question", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "required", "kind": "required", "type": "boolean", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "answers", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "customAnswer", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "criteria", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "customAnswer", "kind": "required", "type": "boolean", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ] }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get WorkspaceCustomField information [path] Frontu API Sandbox/ClientApi/WorkspaceCustomField/ { "id": "i7vVLgr0qsLvhu65dVOp1", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/workspaces/details" } ], "name": "Get WorkspaceCustomField information", "description": "This endpoind allows to retrieve all information about one specific workspace with custom fields and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/File/Download [path] Frontu API Sandbox/ [title] Create / Update User [path] Frontu API Sandbox/ClientApi/User/ { "id": "dnYvU-foqI_NDyOCDXbxx", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/users", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/users" } ], "name": "Create / Update User", "description": "This endpoint allows to create or update users\n\nIf you want to update User using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email of the user" }, { "name": "name", "kind": "required", "type": "string", "description": "Name of the user" }, { "name": "surname", "kind": "required", "type": "string", "description": "Surname of the user" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Phone of the user" }, { "name": "locale", "kind": "optional", "type": "string", "description": "

Two lowercase symbol string. If not set, default locale will be used.

" }, { "name": "roles", "kind": "required", "type": "array", "description": "

Only 1 is allowed. ROLE_BACKEND - web user, ROLE_DEVICE - mobile app user, ROLE_MATE - mobile app helper user

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "permissionsGroup", "kind": "optional", "type": "string", "description": "

GUID or systemId of a web user permissions group. Only required for ROLE_BACKEND users.

" }, { "name": "office", "kind": "required", "type": "string", "description": "GUID or systemId of an office" }, { "name": "emailAuthEnabled", "kind": "optional", "type": "boolean", "description": "

If true, 2-factor authentication will be enabled for the user.

" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from an external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "sendPassword", "kind": "optional", "type": "boolean", "description": "

If true, password creation link will be sent to user email

" }, { "name": "driverId", "kind": "optional", "type": "string", "description": "Identifier from an external system for fleet drivers" }, { "name": "jobTitle", "kind": "optional", "type": "string", "description": "Job title of the user" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "

Edit-only flag to soft-delete or restore an existing user. Ignored when creating a new user.\nSet true to soft-delete the user (mirrors the admin delete action, including UserVoter checks).\nSet false to restore a previously soft-deleted user (mirrors the admin restore action).\nWhen the requested state matches the current state, the flag is a no-op.\nToggling this flag also flips the user's enabled state accordingly.

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "

Data contains errors, or the deleted transition was rejected by UserVoter.\nVoter rejection responses include one of: user_has_tasks_error_message,\nuser_delete_admin_error_message, user_is_deleted_error_message,\nuser_no_permission_error_message, base_cannot_restore_error_message.

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update StandartizedMaterialCustomField [path] Frontu API Sandbox/ClientApi/StandartizedMaterialCustomField/ { "id": "pqK9ru4EhKLbCrX6jO388", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedmaterials" } ], "name": "Create / Update StandartizedMaterialCustomField", "description": "This endpoint allows to create or update standartized material custom field values.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "" }, { "name": "type", "kind": "required", "type": "integer", "description": "

(0 - text, 1 - select, 2 - date, 3 - number,\n* 4 - checkbox, 5 - autocomplete, 6 - email, 7 - phone)

", "format": "int32" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "

For 'Select' and 'Autocomplete' custom fields, enter serialized array of comma-separated options here, e.g. \"[\"One\",\"Two\",\"Three\"]\"

" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get UserTaskTime detail view [path] Frontu API Sandbox/ClientApi/UserTaskTimes/ { "id": "EfTGgYGhpwOKPRYa3xlf2", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/user/task/time/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/user/task/time/details" } ], "name": "Get UserTaskTime detail view", "description": "This endpoint allows to get user task time detail view", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Entity identifier from external system." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "realDuration", "kind": "required", "type": "number", "description": "" }, { "name": "timeFrom", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "timeTo", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "user", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/StandartizedMaterialCustomField [path] Frontu API Sandbox/ [title] Upload task file [path] Frontu API Sandbox/ClientApi/File/ { "id": "tofnXLtrFdDNV3LgoWq5F", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/files/upload", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files/upload" } ], "name": "Upload task file", "description": "

This endpoint allows to upload a file for a task using multipart/form-data.

", "contentType": "multipart/form-data", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [ { "name": "file", "kind": "required", "type": "string", "description": "", "format": "binary" }, { "name": "task", "kind": "required", "type": "string", "description": "" } ], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "originalName", "kind": "optional", "type": "string", "description": "" }, { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "checksum", "kind": "optional", "type": "string", "description": "" }, { "name": "contentLength", "kind": "optional", "type": "string", "description": "" }, { "name": "task", "kind": "optional", "type": "string", "description": "" }, { "name": "taskRequest", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] List events [path] Frontu API Sandbox/ClientApi/Event/ { "id": "GwiHm__ZOipBQQPNCjwqD", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/events", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/events" } ], "name": "List events", "description": "

Returns a paginated list of events. By default returns all events (including soft-deleted). Pass ?deleted=0 to exclude soft-deleted events.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "user", "type": "string", "description": "

Match events for a user — accepts the user's guid or systemId.

" }, { "kind": "optional", "name": "from", "type": "string", "description": "

Lower bound — events whose endDateTime is strictly greater than this value.

", "format": "date-time" }, { "kind": "optional", "name": "to", "type": "string", "description": "

Upper bound — events whose startDateTime is strictly less than this value.

", "format": "date-time" }, { "kind": "optional", "name": "type", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "kind": "optional", "name": "deleted", "type": "integer", "description": "

Filter on soft-deleted state. Omit to return all.

", "enum": [ "0", "1" ] }, { "kind": "optional", "name": "version", "type": "integer", "description": "

Sync cursor; returns events with version strictly greater than this value.

" }, { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "items", "type": "integer", "description": "", "default": 100, "maximum": 500 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Paginated list", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

Next page number, or 0 if there is no next page.

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Event", "customType": "Event[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "name": "busy", "kind": "optional", "type": "boolean", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "task", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "resource", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "created", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "format": "date-time" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Region [path] Frontu API Sandbox/ [title] ClientApi/Evaluations [path] Frontu API Sandbox/ [title] ClientApi/Travels [path] Frontu API Sandbox/ [title] Create an integration log entry [path] Frontu API Sandbox/ClientApi/IntegrationLog/ { "id": "HWVT4AHbGeGwq83Wco2-F", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/integration/log", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/integration/log" } ], "name": "Create an integration log entry", "description": "

Records an integration log entry. Posting an integration_error entry queues a delayed (~5 min) notification job that e-mails unsent errors to the office and marks them sent. Omitted boolean fields are stored as false — send new=true explicitly so the entry is counted as a new error in the admin panel.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable summary.

" }, { "name": "data", "kind": "optional", "type": "string", "description": "

Free-form payload string (embed JSON as an escaped string).

" }, { "name": "level", "kind": "required", "type": "string", "description": "", "enum": [ "integration_info", "integration_debug", "integration_error" ] }, { "name": "action", "kind": "required", "type": "string", "description": "

Direction of the integration action, e.g. import or export.

" }, { "name": "new", "kind": "optional", "type": "boolean", "description": "Send true so the entry counts as a new error in the admin panel." }, { "name": "sent", "kind": "optional", "type": "boolean", "description": "

Leave out or false; true suppresses the error e-mail.

" }, { "name": "office", "kind": "optional", "type": "string", "description": "Optional Office GUID to scope the error notification." } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "

Returned when successfully created, with the serialized entry

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "level", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "data", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "action", "kind": "optional", "type": "string", "description": "" }, { "name": "new", "kind": "optional", "type": "boolean", "description": "" }, { "name": "sent", "kind": "optional", "type": "boolean", "description": "" }, { "name": "office", "kind": "optional", "type": "string", "nullable": true, "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Form validation errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Image [path] Frontu API Sandbox/ClientApi/Image/ { "id": "TroE7xsIWujN9buwmHUUI", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/images/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/images/{guid}" } ], "name": "Get Image", "description": "This endopint allows to get image information via guid.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. (WHERE table.version >

)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "scanCode", "kind": "optional", "type": "string", "description": "" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "" }, { "name": "note", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] List integration logs [path] Frontu API Sandbox/ClientApi/IntegrationLog/ { "id": "eWnsZUTv7Zx3n0AU17PK5", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/integration/log", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/integration/log" } ], "name": "List integration logs", "description": "

Returns integration log entries ordered oldest first. Integration logs record import/export activity and errors reported by external integrations. Supports pagination and optional level/action filters. Integration logs have no GUID — entries are identified by an integer id, and the version field is the created unix timestamp (feed the last seen version back in for incremental pulls).

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "integer", "description": "Unix timestamp. Only entries created at or after it are returned." }, { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "items", "type": "integer", "description": "", "default": 100 }, { "kind": "optional", "name": "level", "type": "string", "description": "Filter by log level.", "enum": [ "integration_info", "integration_debug", "integration_error" ] }, { "kind": "optional", "name": "action", "type": "string", "description": "

Filter by action (direction), e.g. import or export.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Paginated list of integration logs", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"next_page\":0,\"items\":[{\"id\":42,\"version\":1783958661,\"created\":\"2026-07-13T16:04:21+0000\",\"level\":\"integration_error\",\"message\":\"Order import failed: client 123 not found\",\"data\":\"{\\\"orderId\\\": 123}\",\"action\":\"import\",\"new\":true,\"sent\":false,\"office\":null}]}", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

Next page number, 0 when there are no more pages.

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "Created unix timestamp." }, { "name": "created", "kind": "optional", "type": "string", "description": "ISO 8601 datetime." }, { "name": "level", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "data", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "action", "kind": "optional", "type": "string", "description": "" }, { "name": "new", "kind": "optional", "type": "boolean", "description": "" }, { "name": "sent", "kind": "optional", "type": "boolean", "description": "" }, { "name": "office", "kind": "optional", "type": "string", "nullable": true, "description": "

Office title, null when not scoped to an office.

" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/WorkspaceCautionCode [path] Frontu API Sandbox/ [title] Get available PIPs for a workspace [path] Frontu API Sandbox/ClientApi/WorkspaceCautionCode/ { "id": "aVKHKOMqqfOffYKv6NPW8", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/workspace_cautioncodes/pips", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspace_cautioncodes/pips" } ], "name": "Get available PIPs for a workspace", "description": "

Returns available (unassigned) PIP WorkspaceCautionCodes for a given workspace. Only returns PIPs with severity matching PIP%, not deleted, and not assigned to any task. Requires oem_integration feature to be enabled (returns 403 if disabled).

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "workspace", "type": "string", "description": "GUID of the workspace to get available PIPs for." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"items\":[{\"guid\":\"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\",\"code\":\"PIP-123\",\"description\":\"Pressure issue on cylinder 3\"}]}", "description": "", "schema": [ { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "Feature not enabled", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Workspace not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/EvaluationForm [path] Frontu API Sandbox/ [title] Soft-delete an event [path] Frontu API Sandbox/ClientApi/Event/ { "id": "ChT-9avYBh9WNBXcKLOm3", "type": "api-oas-v2", "data": { "method": "DELETE", "url": "https://dev1.frontu.com//client/api/v2/events/{identifier}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/events/{identifier}" } ], "name": "Soft-delete an event", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "identifier", "type": "string", "description": "Event guid or systemId." } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "204", "description": "Deleted", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Already deleted", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Retrieve a single event by guid or systemId [path] Frontu API Sandbox/ClientApi/Event/ { "id": "3nYQq0aBc3zxbJitmGBAX", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/events/{identifier}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/events/{identifier}" } ], "name": "Retrieve a single event by guid or systemId", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "identifier", "type": "string", "description": "Event guid or systemId." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Event", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "custom_event", "work_hour" ] }, { "name": "busy", "kind": "optional", "type": "boolean", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "user", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "task", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "resource", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "created", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "format": "date-time" } ], "modelRef": "#/components/schemas/Event", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get TaskStopReason [path] Frontu API Sandbox/ClientApi/TaskStopReason/ { "id": "NmO9E9IHt3KB9S6Uo_6ic", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons/details" } ], "name": "Get TaskStopReason", "description": "This endpoind allows to retrieve all information about one task stop reason and query params are used to retreive the one specific client. \n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "example-2" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "GUID format entity identifier generated by Frontu." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "string", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "action", "kind": "optional", "type": "string", "nullable": true, "description": "

Action the app enforces when a work order is stopped with this reason; null means no action.

", "enum": [ "signature", "replan", "start_trip" ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get user details [path] Frontu API Sandbox/ClientApi/User/ { "id": "rGpu3w14mpyidz8qAWcWZ", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/users/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/users/details" } ], "name": "Get user details", "description": "

Retrieve a single user by identifier. The endpoint tries the provided query parameters in the\nfollowing order until a match is found: guid, systemId, email, then both name and\nsurname. At least one identifier must be provided, and when name or surname is used\nthey must be supplied together.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "User GUID. Checked first when provided.", "format": "uuid" }, { "kind": "optional", "name": "systemId", "type": "string", "description": "External system identifier. Checked if no GUID match." }, { "kind": "optional", "name": "email", "type": "string", "description": "User email. Checked if GUID and systemId do not match.", "format": "email" }, { "kind": "optional", "name": "name", "type": "string", "description": "

User name. Used together with surname as the final fallback.

" }, { "kind": "optional", "name": "surname", "type": "string", "description": "

User surname. Used together with name as the final fallback.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "User found", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "success", "code": "{\n \"version\": 1420114332,\n \"name\": \"Petras\",\n \"surname\": \"Petras\",\n \"email\": \"test@frontu.dev\",\n \"office\": \"f889fbe9-9d9b-3c8a-8549-e321ee7e3e34\",\n \"roles\": [\n \"ROLE_ADMIN\",\n \"ROLE_USER\"\n ],\n \"guid\": \"f889fbe9-9d9b-3c8a-8549-e321ee7e3e31\",\n \"created\": \"2015-01-01T12:12:12+0000\",\n \"updated\": \"2015-01-01T12:12:12+0000\",\n \"deleted\": false,\n \"systemId\": null,\n \"phone\": \"+37011111111\",\n \"jobTitle\": \"Technician\",\n \"warehouse\": null,\n \"company_details\": null,\n \"enabled\": true,\n \"driverId\": \"DRV001\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "surname", "kind": "optional", "type": "string", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "office", "kind": "optional", "type": "string", "description": "" }, { "name": "roles", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "" }, { "name": "jobTitle", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "warehouse", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "company_details", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Missing required identifier", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "User not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/StandartizedWorkCustomField [path] Frontu API Sandbox/ [title] Get TaskStopReason list [path] Frontu API Sandbox/ClientApi/TaskStopReason/ { "id": "Q6B6VKR1LqnQDr3wAIgBM", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons" } ], "name": "Get TaskStopReason list", "description": "

This endpoint allows to get task stop reason list

\n

To update a task stop reason using the POST method, send its guid in the request body.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page", "default": "1" }, { "kind": "optional", "name": "version", "type": "string", "description": "Timestamp to limit data", "default": "0" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "action", "kind": "optional", "type": "string", "nullable": true, "description": "

Action the app enforces when a work order is stopped with this reason; null means no action.

", "enum": [ "signature", "replan", "start_trip" ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Download File [path] Frontu API Sandbox/ClientApi/File/Download/ { "id": "Z9ASZeKjyxQ4Pso4mMgpf", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/files/{guid}/download", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/files/{guid}/download" } ], "name": "Download File", "description": "This endpoint allows to download file via guid", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "File not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Post TaskStopReason [path] Frontu API Sandbox/ClientApi/TaskStopReason/ { "id": "EkBT39uyoQMSQXql5V2zR", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/taskstopreasons" } ], "name": "Post TaskStopReason", "description": "

This endpoint updates the task stop reason whose guid matches the guid in the request body, otherwise it creates a new one.

\n

When updating, fields omitted from the request body keep their current values.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "

GUID of an existing task stop reason to update. When omitted or not found, a new reason is created.

" }, { "name": "title", "kind": "optional", "type": "string", "description": "

Required when creating a reason; optional when updating one by guid (omitted keeps the current title).

" }, { "name": "action", "kind": "optional", "type": "string", "nullable": true, "description": "

Action the app enforces when a work order is stopped with this reason; null or omitted on create means no action. Any other value returns 400.

", "enum": [ "signature", "replan", "start_trip" ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Data contains errors", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get UserTaskTime list [path] Frontu API Sandbox/ClientApi/UserTaskTimes/ { "id": "T2aobOUUTYRfTGCEiqy1o", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/user/task/times", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/user/task/times" } ], "name": "Get UserTaskTime list", "description": "This endpoint allows to get user task times list", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. * (WHERE table.version >

).

" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

" }, { "kind": "optional", "name": "task", "type": "string", "description": "

Filter user task times by the related task GUID (generated by Frontu) or systemId (identifier from external system).

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "realDuration", "kind": "required", "type": "number", "description": "" }, { "name": "timeFrom", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "timeTo", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "user", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/WorkspaceResponsiblePerson [path] Frontu API Sandbox/ [title] Download Image [path] Frontu API Sandbox/ClientApi/Image/Download/ { "id": "HJ2EUY1SEpXbNwFW8GITk", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/images/{guid}/download", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/images/{guid}/download" } ], "name": "Download Image", "description": "This endpoint allows to download image via guid.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Image not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get evaluations by tasks or by evaluation guid [path] Frontu API Sandbox/ClientApi/Evaluations/ { "id": "Jjzw4AMEgkyYtHu6hC9LK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/evaluations/task", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/evaluations/task" } ], "name": "Get evaluations by tasks or by evaluation guid", "description": "

Gets evaluations by task info or by evaluation guid.

\n

In this case you need to select the filter or the task side - guid or systemId, or the evaluation guid.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "Identifier from Frontu about task" }, { "kind": "optional", "name": "systemId", "type": "string", "description": "Identifier from external system" }, { "kind": "optional", "name": "evaluationGuid", "type": "string", "description": "Identifier from Frontu about evaluation" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "schema": [ { "name": "form", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "question", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "required", "kind": "required", "type": "boolean", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] }, { "name": "answers", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "customAnswer", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "criteria", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "customAnswer", "kind": "required", "type": "boolean", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ] } ] }, { "name": "note", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 } ], "itemType": "object", "customType": "object[]", "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/UserTaskTimes [path] Frontu API Sandbox/ [title] Get Travels list [path] Frontu API Sandbox/ClientApi/Travels/ { "id": "j6TmDZfYdqDqbK_UxYoQ7", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/travels", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/travels" } ], "name": "Get Travels list", "description": "This endpoint allows to get travels list", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "string", "description": "Page number." }, { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. (WHERE table.version >

)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "required", "type": "number", "description": "" }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "required", "type": "number", "description": "" }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "user", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "started", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "ended", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "startLongitude", "kind": "required", "type": "number", "description": "" }, { "name": "startLatitude", "kind": "required", "type": "number", "description": "" }, { "name": "endLongitude", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "endLatitude", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "systemId", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "vehicle", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "distance", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get detail information about workspace responsible person [path] Frontu API Sandbox/ClientApi/WorkspaceResponsiblePerson/ { "id": "zYmLZfaxsnQKH9KzhnpFU", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_person/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_person/details" } ], "name": "Get detail information about workspace responsible person", "description": "Get detail information about workspace responsible person", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "guid", "type": "string", "description": "Identifier from Frontu" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "required", "type": "string", "description": "" }, { "name": "workspace", "kind": "required", "type": "string", "description": "" }, { "name": "responsiblePerson", "kind": "required", "type": "string", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "" }, { "name": "created", "kind": "required", "type": "string", "description": "" }, { "name": "updated", "kind": "required", "type": "string", "description": "" }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create / Update Workspace Responsible Person [path] Frontu API Sandbox/ClientApi/WorkspaceResponsiblePerson/ { "id": "0qJp5HKIcgSEjMDTKzb3c", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_persons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_persons" } ], "name": "Create / Update Workspace Responsible Person", "description": "This endpoint allows to create or update workspace responsible person information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "responsiblePerson", "kind": "optional", "type": "string", "description": "GUID or systemId of Responsible Person" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of Workspace" }, { "name": "deleted", "kind": "optional", "type": "string", "description": "

Mark if entity is archived (1) or active (0)

" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Travels by guid [path] Frontu API Sandbox/ClientApi/Travels/ { "id": "eYU4ko3AL27XjX43WDKPK", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/travels/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/travels/{guid}" } ], "name": "Get Travels by guid", "description": "Get information about travels form by guid", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "id", "kind": "required", "type": "number", "description": "" }, { "name": "version", "kind": "required", "type": "number", "description": "" }, { "name": "task", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "user", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "started", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "ended", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "duration", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "startLongitude", "kind": "required", "type": "number", "description": "" }, { "name": "startLatitude", "kind": "required", "type": "number", "description": "" }, { "name": "endLongitude", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "endLatitude", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "systemId", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "vehicle", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "distance", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Region list [path] Frontu API Sandbox/ClientApi/Region/ { "id": "luczyF3EXO5CBcS9cHQVd", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/regions", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/regions" } ], "name": "Get Region list", "description": "This endpoint allows to return all regions", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with real data" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "number", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "number", "description": "" }, { "name": "title", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "address", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "description", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "guid", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "created", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "minLength": 1 }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "", "minLength": 1 } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get detail information about workspace responsible persons [path] Frontu API Sandbox/ClientApi/WorkspaceResponsiblePerson/ { "id": "yAO2XApPUPGmsgESEk6i5", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_persons", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/workspace_responsible_persons" } ], "name": "Get detail information about workspace responsible persons", "description": "This endpoint allows to get all workspace responsible persons information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp. * (WHERE table.version >

).

" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "string", "description": "" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "string", "description": "" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "" }, { "name": "responsiblePerson", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create or update evaluation form [path] Frontu API Sandbox/ClientApi/EvaluationForm/ { "id": "ZTJE_z-0-ZPjI4j5yS4RJ", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/" } ], "name": "Create or update evaluation form", "description": "

Idempotent upsert of an EvaluationForm with nested questions and criterias. Lookup by guid; creates when not found, updates in place when found. Returns 201 on create, 200 on update, 400 on validation failure. Missing questions or criterias in the payload are preserved (no delete); entries matched by guid are updated, entries without a matching guid are created.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "

EvaluationForm guid; present → update, absent → create

" }, { "name": "title", "kind": "required", "type": "string", "description": "", "maxLength": 500 }, { "name": "taskType", "kind": "optional", "type": "string", "nullable": true, "description": "

TaskType guid; required when compliance=true

" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "", "default": true }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "", "default": true }, { "name": "incident", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "compliance", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "questions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "maxLength": 500 }, { "name": "type", "kind": "required", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [], "schema": [] }, { "name": "required", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "imageRequired", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "orderId", "kind": "optional", "type": "integer", "description": "" }, { "name": "criterias", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "title", "kind": "required", "type": "string", "description": "", "minLength": 1, "maxLength": 255 }, { "name": "customAnswer", "kind": "optional", "type": "boolean", "description": "", "default": false } ] } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when an existing form was updated", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] }, { "statusCode": "201", "description": "Returned when a new form was created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "taskType", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "published", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "version", "kind": "optional", "type": "integer", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "questions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "imageRequired", "kind": "optional", "type": "boolean", "description": "" }, { "name": "orderId", "kind": "optional", "type": "integer", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "criterias", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "customAnswer", "kind": "optional", "type": "boolean", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation failed", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "errors", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Image/Download [path] Frontu API Sandbox/ [title] Create / Update Standartized Material Remains [path] Frontu API Sandbox/ClientApi/StandartizedMaterialRemains/ { "id": "-otcG7IF6YjDm6U7RvsNV", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://dev1.frontu.com//client/api/v2/standartized_material_remains", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_material_remains" } ], "name": "Create / Update Standartized Material Remains", "description": "This endpoint allows to create or update standartized material remains information.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "schema": [ { "name": "standartizedMaterial", "kind": "optional", "type": "string", "description": "GUID or systemId of Standartized Material" }, { "name": "workspace", "kind": "optional", "type": "string", "description": "GUID or systemId of User" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "string", "description": "" }, { "name": "systemId", "kind": "optional", "type": "string", "description": "Identifier from external system" }, { "name": "guid", "kind": "optional", "type": "string", "description": "Identifier from Frontu" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/IntegrationLog [path] Frontu API Sandbox/ [title] Get StandartizedWorkCustomField list [path] Frontu API Sandbox/ClientApi/StandartizedWorkCustomField/ { "id": "59eb74DKl4LKqfdJfnQ6c", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/customfields/standartizedworks" } ], "name": "Get StandartizedWorkCustomField list", "description": "This endpoint allows to get standartized work custom fields\n\nIf you want to update Standartized Custom Field values using POST method you need to fill information for guid field or systemId field in request body.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "version", "type": "string", "description": "

Filter data by given timestamp.\n* (WHERE table.version >

).

", "default": "0", "pattern": "\\d+" }, { "kind": "optional", "name": "page", "type": "string", "description": "Page number.", "default": "1", "pattern": "\\d+" }, { "kind": "optional", "name": "items", "type": "string", "description": "

Items per page 100/200/300.

", "default": "100", "pattern": "(100|200|300)" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "

0 if no more pages\n* exists

" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "integer", "description": "" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "" }, { "name": "visible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "data", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get EvaluationForm by guid [path] Frontu API Sandbox/ClientApi/EvaluationForm/ { "id": "hkRb6nLL7NUNtmmHugTJX", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/{guid}", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/evaluations/forms/{guid}" } ], "name": "Get EvaluationForm by guid", "description": "Get information about evaluation form by guid", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "guid", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with custom values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Returned when successful", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "taskType", "kind": "optional", "type": "string", "description": "" }, { "name": "deleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "published", "kind": "optional", "type": "string", "description": "" }, { "name": "required", "kind": "optional", "type": "string", "description": "" }, { "name": "version", "kind": "optional", "type": "string", "description": "" }, { "name": "created", "kind": "optional", "type": "string", "description": "" }, { "name": "updated", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "questions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "required", "kind": "optional", "type": "string", "description": "" }, { "name": "orderId", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" }, { "name": "criterias", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "customAnswer", "kind": "optional", "type": "string", "description": "" }, { "name": "guid", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Entity not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/Image [path] Frontu API Sandbox/ [title] ClientApi/File [path] Frontu API Sandbox/ [title] Get detail information about standartized material remains [path] Frontu API Sandbox/ClientApi/StandartizedMaterialRemains/ { "id": "fe21NlLTl5wVV-3MMvU-h", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://dev1.frontu.com//client/api/v2/standartized_material_remains/details", "servers": [ { "url": "https://dev1.frontu.com//client/api/v2/standartized_material_remains/details" } ], "name": "Get detail information about standartized material remains", "description": "Get detail information about standartized material remains", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "Example", "Example with test values" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "version", "kind": "required", "type": "integer", "description": "" }, { "name": "standartizedMaterial", "kind": "required", "type": "string", "description": "" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "" }, { "name": "serialNumber", "kind": "required", "type": "string", "description": "" }, { "name": "workspace", "kind": "required", "type": "string", "description": "" }, { "name": "guid", "kind": "required", "type": "string", "description": "" }, { "name": "created", "kind": "required", "type": "string", "description": "" }, { "name": "updated", "kind": "required", "type": "string", "description": "" }, { "name": "deleted", "kind": "required", "type": "boolean", "description": "" }, { "name": "systemId", "kind": "required", "type": "string", "description": "" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] ClientApi/User [path] Frontu API Sandbox/ [space] Celsis (/celsis) [title] Get list [path] Celsis integration API/Material(cls_I01_TaskD)/ { "id": "AfN_jo5kQCVM-tFomgS1z", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/materials", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/materials" } ], "name": "Get list", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "items", "type": "integer", "description": "", "default": 100 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "", "example": 0 }, { "name": "items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/cls_I01_TaskD", "customType": "cls_I01_TaskD[]", "schema": [ { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I01_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I01_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I01_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I12_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "0" }, { "name": "I01_Kodas_Ps", "kind": "optional", "type": "string", "description": "", "example": "PS001" }, { "name": "I01_Kodas_Is", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I01_Kodas_Os", "kind": "optional", "type": "string", "description": "", "example": "OS001" }, { "name": "I01_Serija", "kind": "optional", "type": "string", "description": "", "example": "SER001" }, { "name": "I01_Kodas_Us", "kind": "optional", "type": "string", "description": "", "example": "US001" }, { "name": "I01_Kiekis", "kind": "optional", "type": "string", "description": "", "example": "10.0000" }, { "name": "I01_Kiekis1", "kind": "optional", "type": "string", "description": "", "example": "5.0000" }, { "name": "I01_Pav", "kind": "optional", "type": "string", "description": "", "example": "Test Material One" }, { "name": "I01_Kodas_Gs", "kind": "optional", "type": "string", "description": "", "example": "GS001" }, { "name": "I01_Pastaba", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Material note" }, { "name": "I01_Sort", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_Foto", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_SerNr_Sablonas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_EAN13", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Modelis", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Task(cls_I00_TaskH) [path] Celsis integration API/ [title] Get by I00_ID [path] Celsis integration API/Task(cls_I00_TaskH)/ { "id": "4p6AgJ4qDMIop1iYEjb3f", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks/{id}", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks/{id}" } ], "name": "Get by I00_ID", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "integer", "example": 248474, "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ], "modelRef": "#/components/schemas/cls_I00_TaskH", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Entity Not Found!" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Celsis integration API [path] / [title] Material(cls_I01_TaskD) [path] Celsis integration API/ [title] Create [path] Celsis integration API/Task(cls_I00_TaskH)/ { "id": "NvajvtLfuKvxRd6iQ-ify", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks" } ], "name": "Create", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "TaskRequest", "schema": [ { "name": "tipas", "kind": "required", "type": "string", "description": "", "example": "OP", "maxLength": 2 }, { "name": "kodasPo", "kind": "required", "type": "string", "description": "", "example": "PO001", "maxLength": 12 }, { "name": "dokNr", "kind": "required", "type": "string", "description": "", "example": "DOK-0001", "maxLength": 20 }, { "name": "opTip", "kind": "required", "type": "integer", "description": "", "example": 1, "minimum": -128, "maximum": 127 }, { "name": "taskTipas", "kind": "required", "type": "integer", "description": "", "example": 2, "minimum": -128, "maximum": 127 }, { "name": "data", "kind": "required", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "klientas", "kind": "required", "type": "string", "description": "", "example": "UAB Test Client", "maxLength": 70 }, { "name": "klientoKodas", "kind": "required", "type": "string", "description": "", "example": "KL001", "maxLength": 12 }, { "name": "objektoAdresas", "kind": "required", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius", "maxLength": 80 }, { "name": "pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note", "maxLength": 1000 }, { "name": "timestamp00", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "timestamp01", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp02", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp03", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp04", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "prioritetas", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32" }, { "name": "mspav", "kind": "required", "type": "string", "description": "

Required. Creator's first and last name, separated by a space (\"Vardas Pavardė\"), stored in I00_Ms_Pav. A missing or blank value is rejected with 400. The importer resolves it to the Frontu user with that name and surname; a row that still has no name and surname is not imported but reported in the integration log and retried on the next run once the field is filled in.

", "example": "Jonas Jonaitis", "maxLength": 40 }, { "name": "atrinko", "kind": "optional", "type": "string", "description": "", "example": "", "maxLength": 40 }, { "name": "kodasIs", "kind": "optional", "type": "string", "description": "", "example": "IS001", "maxLength": 12 }, { "name": "kodasNr", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01", "maxLength": 20 }, { "name": "sandUseris", "kind": "optional", "type": "string", "description": "", "example": "", "maxLength": 12 }, { "name": "priskirtaRinkti", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "rinkimoLaikas", "kind": "optional", "type": "integer", "description": "", "example": "" } ], "modelRef": "#/components/schemas/TaskRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ], "modelRef": "#/components/schemas/cls_I00_TaskH", "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation errors", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "TaskError", "schema": [ { "name": "errors", "kind": "optional", "type": "object", "description": "", "example": "{\"data\":[\"This value should not be null.\"],\"klientas\":[\"This value is too long. It should have 70 characters or less.\"]}", "schema": [] }, { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/cls_I00_TaskH", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "modelRef": "#/components/schemas/TaskError", "isExpanded": true } ] }, { "statusCode": "409", "description": "

A record with the same key (I00_Tipas + I00_Kodas_Po + I00_Kodas_Nr) already exists. Nothing is created; the response carries the existing record and its I00_ID.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Duplicate entry" }, { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/cls_I00_TaskH", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get list [path] Celsis integration API/Task(cls_I00_TaskH)/ { "id": "XSeUoiSBtoLfo0j0Z9Zzu", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks" } ], "name": "Get list", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "items", "type": "integer", "description": "", "default": 100 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "", "example": 2 }, { "name": "items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/cls_I00_TaskH", "customType": "cls_I00_TaskH[]", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Create [path] Celsis integration API/Material(cls_I01_TaskD)/ { "id": "Wtx4zGhXINn2oIlrft7jO", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://celsis.frontu.dev/client/api/v2/integration/materials", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/materials" } ], "name": "Create", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "MaterialRequest", "schema": [ { "name": "tipas", "kind": "required", "type": "string", "description": "", "example": "OP", "maxLength": 2 }, { "name": "kodasPo", "kind": "required", "type": "string", "description": "", "example": "PO001", "maxLength": 12 }, { "name": "eilNr", "kind": "required", "type": "string", "description": "", "example": "1" }, { "name": "komplEilNr", "kind": "required", "type": "string", "description": "", "example": "0" }, { "name": "kodasPs", "kind": "required", "type": "string", "description": "", "example": "PS001", "maxLength": 12 }, { "name": "kodasIs", "kind": "required", "type": "string", "description": "", "example": "IS001", "maxLength": 12 }, { "name": "kodasOs", "kind": "required", "type": "string", "description": "", "example": "OS001", "maxLength": 12 }, { "name": "serija", "kind": "required", "type": "string", "description": "", "example": "SER001", "maxLength": 12 }, { "name": "kodasUs", "kind": "required", "type": "string", "description": "", "example": "US001", "maxLength": 12 }, { "name": "kiekis", "kind": "required", "type": "string", "description": "", "example": "10.0000" }, { "name": "kiekis1", "kind": "required", "type": "string", "description": "", "example": "5.0000" }, { "name": "pav", "kind": "required", "type": "string", "description": "", "example": "Test Material One", "maxLength": 150 }, { "name": "kodasGs", "kind": "required", "type": "string", "description": "", "example": "GS001", "maxLength": 12 }, { "name": "pastaba", "kind": "optional", "type": "string", "description": "", "example": "Material note", "maxLength": 1000 }, { "name": "sort", "kind": "required", "type": "string", "description": "", "example": "1" }, { "name": "foto", "kind": "optional", "type": "string", "description": "", "example": "", "maxLength": 1000 }, { "name": "kodasNr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "sablonasRegex", "kind": "optional", "type": "string", "description": "", "example": "SN-*", "maxLength": 1000 }, { "name": "ean13", "kind": "optional", "type": "string", "description": "", "example": "1234567890123", "maxLength": 1000 }, { "name": "modelis", "kind": "optional", "type": "string", "description": "", "example": "MOD100", "maxLength": 1000 } ], "modelRef": "#/components/schemas/MaterialRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I01_TaskD", "schema": [ { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I01_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I01_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I01_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I12_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "0" }, { "name": "I01_Kodas_Ps", "kind": "optional", "type": "string", "description": "", "example": "PS001" }, { "name": "I01_Kodas_Is", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I01_Kodas_Os", "kind": "optional", "type": "string", "description": "", "example": "OS001" }, { "name": "I01_Serija", "kind": "optional", "type": "string", "description": "", "example": "SER001" }, { "name": "I01_Kodas_Us", "kind": "optional", "type": "string", "description": "", "example": "US001" }, { "name": "I01_Kiekis", "kind": "optional", "type": "string", "description": "", "example": "10.0000" }, { "name": "I01_Kiekis1", "kind": "optional", "type": "string", "description": "", "example": "5.0000" }, { "name": "I01_Pav", "kind": "optional", "type": "string", "description": "", "example": "Test Material One" }, { "name": "I01_Kodas_Gs", "kind": "optional", "type": "string", "description": "", "example": "GS001" }, { "name": "I01_Pastaba", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Material note" }, { "name": "I01_Sort", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_Foto", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_SerNr_Sablonas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_EAN13", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Modelis", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ], "modelRef": "#/components/schemas/cls_I01_TaskD", "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation errors", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "MaterialError", "schema": [ { "name": "errors", "kind": "optional", "type": "object", "description": "", "example": "{\"tipas\":[\"This value should not be blank.\"]}", "schema": [] }, { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/cls_I01_TaskD", "customType": "cls_I01_TaskD", "schema": [ { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I01_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I01_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I01_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I12_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "0" }, { "name": "I01_Kodas_Ps", "kind": "optional", "type": "string", "description": "", "example": "PS001" }, { "name": "I01_Kodas_Is", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I01_Kodas_Os", "kind": "optional", "type": "string", "description": "", "example": "OS001" }, { "name": "I01_Serija", "kind": "optional", "type": "string", "description": "", "example": "SER001" }, { "name": "I01_Kodas_Us", "kind": "optional", "type": "string", "description": "", "example": "US001" }, { "name": "I01_Kiekis", "kind": "optional", "type": "string", "description": "", "example": "10.0000" }, { "name": "I01_Kiekis1", "kind": "optional", "type": "string", "description": "", "example": "5.0000" }, { "name": "I01_Pav", "kind": "optional", "type": "string", "description": "", "example": "Test Material One" }, { "name": "I01_Kodas_Gs", "kind": "optional", "type": "string", "description": "", "example": "GS001" }, { "name": "I01_Pastaba", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Material note" }, { "name": "I01_Sort", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_Foto", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_SerNr_Sablonas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_EAN13", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Modelis", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "modelRef": "#/components/schemas/MaterialError", "isExpanded": true } ] }, { "statusCode": "409", "description": "

A record with the same key (I01_Tipas + I01_Kodas_Po + I01_Kodas_Nr + I01_Eil_Nr + I12_Eil_Nr) already exists. Nothing is created; the response carries the existing record and its I01_ID.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Duplicate entry" }, { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/cls_I01_TaskD", "customType": "cls_I01_TaskD", "schema": [ { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I01_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I01_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I01_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I12_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "0" }, { "name": "I01_Kodas_Ps", "kind": "optional", "type": "string", "description": "", "example": "PS001" }, { "name": "I01_Kodas_Is", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I01_Kodas_Os", "kind": "optional", "type": "string", "description": "", "example": "OS001" }, { "name": "I01_Serija", "kind": "optional", "type": "string", "description": "", "example": "SER001" }, { "name": "I01_Kodas_Us", "kind": "optional", "type": "string", "description": "", "example": "US001" }, { "name": "I01_Kiekis", "kind": "optional", "type": "string", "description": "", "example": "10.0000" }, { "name": "I01_Kiekis1", "kind": "optional", "type": "string", "description": "", "example": "5.0000" }, { "name": "I01_Pav", "kind": "optional", "type": "string", "description": "", "example": "Test Material One" }, { "name": "I01_Kodas_Gs", "kind": "optional", "type": "string", "description": "", "example": "GS001" }, { "name": "I01_Pastaba", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Material note" }, { "name": "I01_Sort", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_Foto", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_SerNr_Sablonas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_EAN13", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Modelis", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get by I02_ID [path] Celsis integration API/SerialNumber(cls_I02_TaskD_SerNr)/ { "id": "f5Iyp-8sSn9blMyecXnKU", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/serial-numbers/{id}", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/serial-numbers/{id}" } ], "name": "Get by I02_ID", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "integer", "example": 1, "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I02_TaskD_SerNr", "schema": [ { "name": "I02_ID", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "I02_ID01", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I02_SerNr", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "SN-0001" } ], "modelRef": "#/components/schemas/cls_I02_TaskD_SerNr", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Entity Not Found!" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] SerialNumber(cls_I02_TaskD_SerNr) [path] Celsis integration API/ [title] Update by I00_ID [path] Celsis integration API/Task(cls_I00_TaskH)/ { "id": "AvMQLl8Ci6b-1DM4uw8ah", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks/{id}", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/tasks/{id}" } ], "name": "Update by I00_ID", "description": "

Partial update — only the fields present in the body are changed, omitted fields keep their stored values.

\n

Rows are consumed by the frontu

importer, which picks up records where I00_TimeStamp00 is set and I00_TimeStamp01 is null, then stamps I00_TimeStamp01 on pickup. Editing a row that has already been imported changes the staging record only — send \"timestamp01\": null alongside the edit to requeue it so the change reaches the Frontu task.

\n

I00_Tipas, I00_Kodas_Po and I00_Kodas_Nr form the table primary key and identify the imported task (customCode / customNumber). Changing them to a combination that already exists fails with a 500; changing them to a free combination detaches the row from the task it was imported into.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "integer", "example": 248474, "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

Same fields as TaskRequest, all optional — omitted fields keep their stored values.

", "customType": "TaskUpdateRequest", "schema": [ { "name": "tipas", "kind": "optional", "type": "string", "description": "", "example": "OP", "maxLength": 2 }, { "name": "kodasPo", "kind": "optional", "type": "string", "description": "", "example": "PO001", "maxLength": 12 }, { "name": "dokNr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001", "maxLength": 20 }, { "name": "opTip", "kind": "optional", "type": "integer", "description": "", "example": 1, "minimum": -128, "maximum": 127 }, { "name": "taskTipas", "kind": "optional", "type": "integer", "description": "", "example": 2, "minimum": -128, "maximum": 127 }, { "name": "data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "klientas", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client", "maxLength": 70 }, { "name": "klientoKodas", "kind": "optional", "type": "string", "description": "", "example": "KL001", "maxLength": 12 }, { "name": "objektoAdresas", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius", "maxLength": 80 }, { "name": "pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note", "maxLength": 1000 }, { "name": "timestamp00", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "timestamp01", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp02", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp03", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "timestamp04", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "prioritetas", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32" }, { "name": "mspav", "kind": "optional", "type": "string", "description": "

Required. Creator's first and last name, separated by a space (\"Vardas Pavardė\"), stored in I00_Ms_Pav. A missing or blank value is rejected with 400. The importer resolves it to the Frontu user with that name and surname; a row that still has no name and surname is not imported but reported in the integration log and retried on the next run once the field is filled in.

", "example": "Jonas Jonaitis", "maxLength": 40 }, { "name": "atrinko", "kind": "optional", "type": "string", "description": "", "example": "", "maxLength": 40 }, { "name": "kodasIs", "kind": "optional", "type": "string", "description": "", "example": "IS001", "maxLength": 12 }, { "name": "kodasNr", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01", "maxLength": 20 }, { "name": "sandUseris", "kind": "optional", "type": "string", "description": "", "example": "", "maxLength": 12 }, { "name": "priskirtaRinkti", "kind": "optional", "type": "string", "description": "", "example": "", "format": "date-time" }, { "name": "rinkimoLaikas", "kind": "optional", "type": "integer", "description": "", "example": "" } ], "modelRef": "#/components/schemas/TaskUpdateRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Updated", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ], "modelRef": "#/components/schemas/cls_I00_TaskH", "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation errors", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "TaskError", "schema": [ { "name": "errors", "kind": "optional", "type": "object", "description": "", "example": "{\"data\":[\"This value should not be null.\"],\"klientas\":[\"This value is too long. It should have 70 characters or less.\"]}", "schema": [] }, { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/cls_I00_TaskH", "customType": "cls_I00_TaskH", "schema": [ { "name": "I00_ID", "kind": "optional", "type": "integer", "description": "", "example": 248474 }, { "name": "I00_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I00_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I00_Dok_Nr", "kind": "optional", "type": "string", "description": "", "example": "DOK-0001" }, { "name": "I00_Op_Tip", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I00_Task_Tipas", "kind": "optional", "type": "string", "description": "", "example": "2" }, { "name": "I00_Data", "kind": "optional", "type": "string", "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_Kl_Pav", "kind": "optional", "type": "string", "description": "", "example": "UAB Test Client" }, { "name": "I00_Klientas", "kind": "optional", "type": "string", "description": "", "example": "KL001" }, { "name": "I00_Kl_Adr", "kind": "optional", "type": "string", "description": "", "example": "Vilniaus g. 1, Vilnius" }, { "name": "I00_Pastaba", "kind": "optional", "type": "string", "description": "", "example": "Test task note" }, { "name": "I00_TimeStamp00", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2025-01-15 10:00:00", "format": "date-time" }, { "name": "I00_TimeStamp01", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp02", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp03", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_TimeStamp04", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Prioritetas", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "I00_Ms_Pav", "kind": "optional", "type": "string", "description": "Creator's first and last name as posted in mspav.", "example": "Jonas Jonaitis" }, { "name": "I00_Atrinko", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_KODAS_IS", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I00_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "urlai", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Grupe", "kind": "optional", "type": "string", "description": "", "example": "GRP01" }, { "name": "SandUseris", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "I00_Priskirta_Rinkti", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" }, { "name": "I00_Rinkimo_Laikas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ] } ], "modelRef": "#/components/schemas/TaskError", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Entity Not Found!" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get by I01_ID [path] Celsis integration API/Material(cls_I01_TaskD)/ { "id": "qU10a53tDOLKHE84MFXMn", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/materials/{id}", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/materials/{id}" } ], "name": "Get by I01_ID", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "integer", "example": 1246069, "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "cls_I01_TaskD", "schema": [ { "name": "I01_ID", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I01_Tipas", "kind": "optional", "type": "string", "description": "", "example": "OP" }, { "name": "I01_Kodas_Po", "kind": "optional", "type": "string", "description": "", "example": "PO001" }, { "name": "I01_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I12_Eil_Nr", "kind": "optional", "type": "string", "description": "", "example": "0" }, { "name": "I01_Kodas_Ps", "kind": "optional", "type": "string", "description": "", "example": "PS001" }, { "name": "I01_Kodas_Is", "kind": "optional", "type": "string", "description": "", "example": "IS001" }, { "name": "I01_Kodas_Os", "kind": "optional", "type": "string", "description": "", "example": "OS001" }, { "name": "I01_Serija", "kind": "optional", "type": "string", "description": "", "example": "SER001" }, { "name": "I01_Kodas_Us", "kind": "optional", "type": "string", "description": "", "example": "US001" }, { "name": "I01_Kiekis", "kind": "optional", "type": "string", "description": "", "example": "10.0000" }, { "name": "I01_Kiekis1", "kind": "optional", "type": "string", "description": "", "example": "5.0000" }, { "name": "I01_Pav", "kind": "optional", "type": "string", "description": "", "example": "Test Material One" }, { "name": "I01_Kodas_Gs", "kind": "optional", "type": "string", "description": "", "example": "GS001" }, { "name": "I01_Pastaba", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Material note" }, { "name": "I01_Sort", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_Foto", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Kodas_Nr", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "I01_SerNr_Sablonas", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_EAN13", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "I01_Modelis", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" } ], "modelRef": "#/components/schemas/cls_I01_TaskD", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "", "example": "Entity Not Found!" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get list [path] Celsis integration API/SerialNumber(cls_I02_TaskD_SerNr)/ { "id": "I4Jrl8b8UAmOLuNmWzAZR", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://celsis.frontu.dev/client/api/v2/integration/serial-numbers", "servers": [ { "url": "https://celsis.frontu.dev/client/api/v2/integration/serial-numbers" } ], "name": "Get list", "description": "

Serial numbers are written by Frontu when a task is finished, one row per scanned serial number. I02_ID is generated by Frontu; filter by I02_ID01 (the I01_ID of the material line) to get the serial numbers of one line.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "items", "type": "integer", "description": "", "default": 100 }, { "kind": "optional", "name": "I02_ID01", "type": "integer", "example": 1246069, "description": "

Return only serial numbers of this material line (I01_ID). A line can have several serial numbers, so the result is always a list; an empty list means none were scanned for it yet.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Value: Bearer {access_token}

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "next_page", "kind": "optional", "type": "integer", "description": "", "example": 0 }, { "name": "items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/cls_I02_TaskD_SerNr", "customType": "cls_I02_TaskD_SerNr[]", "schema": [ { "name": "I02_ID", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "I02_ID01", "kind": "optional", "type": "integer", "description": "", "example": 1246069 }, { "name": "I02_SerNr", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "SN-0001" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "

I02_ID01 is not an integer

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] }