{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0cb856f5-6a13-47f4-89f6-711eb22ef7e6","name":"PRO.FILE Platform - PRO.FX REST API","description":"<img src=\"https://www.pro-file.com/de/wp-content/uploads/sites/65/2020/11/platform2.jpg\">\n\n## PRO.FX-Framework REST API\n\nWith the PRO.FX-Framework, [PRO.FILE](https://www.pro-file.com) provides a platform for the development and execution of PRO.FILE Add-on applications.  \nThe PRO.FX-Framework consists of the PRO.FX-AppServer and the client-side PRO.FX-Runtime component (only required for the .NET API).\n\nThe PRO.FX-Framework offers different APIs (Application Programming Interfaces)\n\n- .NET API for MS Windows Development\n    \n- REST API (http requests with JSON exchange format)\n    \n\nThis documentation gives you a PRO.FX-Framework REST API overview and sample calls with response data.  \nThe PRO.FX .NET API and SDK will be briefly discussed at the end of this documentation.\n\n<img src=\"https://www.pro-file.com/de/wp-content/uploads/sites/65/2020/11/profx-framework6.jpg\">\n\nPRO.FX APIs are only available to licensed customers and partners. For this purpose, a license agreement with the customer or partner is concluded on request.\n\n## Supported PRO.FX AppServer versions\n\nThe REST API is available and supported with AppServer version 10.0.14.00 or higher.\n\nThis AppServer version is provided with following service packs:\n\n- PRO.FILE 8.7 SP7 or higher\n    \n- PRO.FILE 8.6 SP14 or higher (Smartfolders not supported)\n    \n\n## PRO.FX-AppServer\n\nWith the PRO.FX-AppServer, we offer you an interface to access your PRO.FILE data.\n\nThe PRO.FX-AppServer can be hosted using IIS.  \nThe clients communicate with the PRO.FX-AppServer via HTTPS. By using HTTPS, not only browsers, but also all mobile devices will be able to access PRO.FILE data and files.\n\n## PRO.FX-Framework REST API\n\nThe PRO.FX-Framework REST API is a collection of HTTPS endpoints. Any application / programming language that supports HTTPS requests can send and receive entity data by using a PROCAD account.\n\nThe PRO.FX-Framework REST API allows you to create, query and update metadata and files in PRO.FILE. You can manage documents, items, projects and other entities and also change the status of entities, lock/unlock entities or upload/download files.  \nIt is also possible to get comprehensive schema information for all PRO.FILE entities.\n\n## Technical Background\n\nHTTPS requests and responses between the clients and the API are encoded using the JSON format.\n\nAll requests are handled by the PRO.FX-AppServer, which is part of your PRO.FILE implementation.\n\nThe PRO.FX-Framework REST API provides typical CRUD functionalities. With this, PRO.FILE data can be created, read, updated and deleted.  \nFor this, a client sends a POST request to the server in order to execute a method on the server. This approach is called Remote Procedure Call (RPC). The result of the method is returned to the client. The JavaScript Object Notation (JSON) is used as exchange format. The response is also provided in JSON format.\n\n## Sending Requests to the PRO.FX-Framework REST API\n\n- the used HTTP method is POST\n    \n- the HTTP header is set to \"Content-Type: application/json\"\n    \n\nThe parameters (request bodies) themselves may be JSON objects, arrays or combinations. Consult the documentation for each request for a list of the available parameters.\n\n## Getting started\n\nFeel free to take advantage of our Postman collection: download and import the “PRO.FX-Framework REST API”-collection and start testing in a few minutes. The “PRO.FX-Framework REST API”-collection is a package of ready to use HTTPS sample requests.\n\nCheckout the [Postman website](https://www.getpostman.com/) for more details and how to install Postman.\n\nPlease perform the following steps to use the “PRO.FX-Framework REST API”-collection in Postman:\n\n- download and install the Postman Client\n    \n- create your Postman Work Space (i.e. \"My Workspace\")\n    \n- click the “Run in Postman”-button to import the “PRO.FX-Framework REST API”-collection into your Postman Work space\n    \n- together with the collection, the “PRO.FX-Framework REST API”-environment is imported\n    \n- complete all CPRO.FX-Framework REST API”-environment settings: PRO.FX-AppServer domain, tenant, user, pwd\n    \n- activate the “PRO.FX-Framework REST API”-environment\n    \n- go to the “PRO.FX-Framework REST API”-collection in the “Collections”-tab\n    \n- browse for requests in the collection\n    \n- use the “Send”-Button to execute a selected request\n    \n\n## Authentication\n\nYou need valid PRO.FILE credentials to send HTTPS requests to the PRO.FX AppServer.  \nThe access to PRO.FILE data (read/write) is checked with the transmitted credentials.\n\nFollowing authorization types are supported:\n\n- Bearer Authentication (Base64 encoded user:password)\n    \n- NTLM Authentication (enables PRO.FILE AutoLogin)\n    \n\nTo authenticate with the \"PRO.FX-Framework REST API,\" you need to call the `AuthenticateUser` API to obtain a Bearer token. This token is then stored and used for all subsequent API requests.\n\n## Supported Entities\n\nThis table shows all supported entities for each MobilityService method.\n\n[](https://www.procad.de/wp-content/uploads/2018/09/ientityservice_supported_entites-003.jpg)\n\n<img src=\"https://www.pro-file.com/de/wp-content/uploads/sites/65/2018/09/ientityservice_supported_entites-003.jpg\">\n\nThis table shows all supported entity combinations for the MobilityService methodes CreateEdgeEntity and UpdateEdgeEntity.\n\nImportant: Transmittal edges are supported with 10.x datebases only!\n\n[](https://www.procad.de/wp-content/uploads/2018/09/ientityservice_supported_relations-002.jpg)\n\n<img src=\"https://www.pro-file.com/de/wp-content/uploads/sites/65/2018/09/ientityservice_supported_relations-002.jpg\">\n\n## HTTP Status Codes\n\n| Code | Status Text | Description |\n| --- | --- | --- |\n| 200, 2xx | OK | the request has succeeded |\n| 400 | Bad Request | invalid parameter or data |\n| 401 | Unauthorized | credentials are invalid or action is not authorized |\n| 404 | Not Found | unknown method |\n| 500 | Internal Error | internal server error |\n\n# Reference and sample Requests\n\n<img src=\"https://www.pro-file.com/de/wp-content/uploads/sites/65/2020/11/profilebyprocad.png\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4153732","team":117806,"collectionId":"0cb856f5-6a13-47f4-89f6-711eb22ef7e6","publishedId":"2sAYdeLrde","public":true,"publicUrl":"https://postman.revalizesoftware.com","privateUrl":"https://go.postman.co/documentation/4153732-0cb856f5-6a13-47f4-89f6-711eb22ef7e6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-06-24T14:00:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"PRO.FX-Framework REST API","id":"fec4ac8c-a5d9-4a60-9dfa-52701d882c8d","owner":"4153732","values":[{"key":"SERVER","value":"http://localhost","enabled":true},{"key":"TENANT","value":"MyTenant","enabled":true},{"key":"USER","value":"MyUser","enabled":true},{"key":"PASSWORD","value":"MyPassword","enabled":true,"type":"secret"},{"key":"APPID","value":"de.companyname.app1","enabled":true},{"key":"LANG","value":"de","enabled":true},{"key":"bearer_token","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/47c440099eef7892540d88ef5db615ddb16f13a6f0727a1e32f293349395c6e5","favicon":"https://revalizesoftware.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PRO.FX-Framework REST API","value":"4153732-fec4ac8c-a5d9-4a60-9dfa-52701d882c8d"}],"canonicalUrl":"https://postman.revalizesoftware.com/view/metadata/2sAYdeLrde"}