File upload

Resource type: uploadfile

Use this API call to upload a file to onOffice. The module and the data record ID specify where the file should be stored. It is possible to upload estate, address and agentslog files as well as files linked to task. This has to be specified in the parameter module.

You also can set tmpUpload as module, then you receive the ID of a cached file with which you can continue to work. See second example for usage.

Uploading files happens in two steps. In the first step you enter the data and the file name, and receive as a response a temporary ID and the file size. In the second step you specify in which module the file is uploaded and with which record it should be linked.

A temporary id can only be used once.
Please note that for estate files a document attribute can only be assigned once for every estate. The list of possible document attributes can be edited in the administration.

Some parameters such as “documentAttribute” and “Art” are only relevant for the estate module, these are the additional file information that can be seen on the “Files” tab in the properties module.

Parameters first step:

  • file
    STRING. Filename
  • data
    STRING. File content as base64-encoded binary data

Parameters second step:

  • tmpUploadId
    STRING. Temporary upload ID
  • relatedRecordId
    INTEGER. Linked record number
  • Art
    STRING. Needed for module estate. Type of file.
    Possible picture types: Titelbild, Foto, Foto_gross, Grundriss, Lageplan,Stadtplan, Anzeigen, Epass_Skala, Finanzierungsbeispiel, QR-Code, Logo, Banner, Panorama
    Possible document types: Expose, Dokument, Aushang, Mietaufstellung, Energieausweis
    Possible link types: Link, Film-Link, Ogulo-Link, Objekt-Link
  • title
    STRING. Needed for module estate. File title
  • freetext
    STRING. Needed for module estate. Free text
  • documentAttribute
    STRING. Needed for module estate. Document attribute
  • module
    STRING. Possible values: estate, address, agentsLog, task or tmpUpload

Example first step: Specify file name and data

...
{
 	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
 	"resourceid": null,
 	"resourcetype": "uploadfile",
 	"identifier": "",
 	"parameters": {
 	 	"data": "\/9j\/4AAQSkZJRgABAQEAS .....  FlkHx2crJPdFYS5EVuh9YT9Dwlirw3ZWFhOs\/\/9k=",
 	 	"file": "JPEG_example_JPG_RIP_025.jpg"
 	}
}
...

Response:

  • tmpUploadId
    STRING. Temporary upload id. It is needed for the second step
...
"records": [
 	{
 	 	"id": 0,
 	 	"type": "",
 	 	"elements": {
 	 	 	"filesize": 9407,
 	 	 	"tmpUploadId": "b09f36b0-7bf3-4691-e1c6-7a298f1fd1ed"
 	 	}
 	}
]
...

Example second step: module, data record to be linked and further information

...
{
 	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
 	"resourceid": null,
 	"resourcetype": "uploadfile",
 	"identifier": "",
 	"parameters": {
 	 	"module": "estate",
 	 	"freetext": "Freitext",
 	 	"tmpUploadId": "b09f36b0-7bf3-4691-e1c6-7a298f1fd1ed",
 	 	"file": "JPEG_example_JPG_RIP_025.jpg",
 	 	"title": "Titel",
 	 	"Art": "Foto",
 	 	"documentAttribute": "document_reservation_list",
 	 	"relatedRecordId": 30
 	}
}
...

————

Example first step with module tmpUpload: Specify file name and data

Request:

...
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
    "resourceid": null,
    "identifier": "1",
    "resourcetype": "uploadfile",
    "parameters": {
        "data": "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAS10lEQVR42uWaCXhU5bnH\/zNn9pnMJBmSkEAAIwRZXOgFxYWiuNTdW7CWqnW5UBBBZXFHRQW9tlDB1q0KasWltloXKgheiygCWVgFyQYEs2eS2fflzH3fk8xkEibJhMRbn9vveb7nLHNm5vz+7\/K933eODP8P2\/7LLnvYWVe31FRQUCM3GLYGW1r++JPPP\/8u2bWyf\/XNDnQrmfGzG01q81seQZD5Gxuh12hgnDQp4v7uu5e9VVUPnF1a6klZgOHDh8upyfR6PTT0Qz\/GFo1GYFC5cUqmH5eMEC45x3HuR5GQqAkFg3CFQojs2oWQzQbjxInQnXbat46iomvOLSs73qsASqVSEwqFBtNudm9C\/RhaYT6Gfvi0Yl1WZKSpZdNpCLhDUHs8SHM4cJgEkFdXQyAjZlx44ffOQ4cu\/GlNzbEeBaBmon5eNBrd+K+G6635XPWo\/+ICmPVO6NMy4KqWofGtXGQ2eREgEVzkDU2jRiG8ZQsUdL1h7NjDnpqayRc7HM6eBEinPoUE+KSBYkkUo5DJZNTbdOt5C+nauMKyjr+RJe53+ay7c\/HzHT8S3w0H3Wj95mpkaasJPhORcBCNzQ789x8GYZ5VhzS3G34SwRMIoHHwYAiVlVDT9xRpaeumOZ2zUxKgvqGhW9g4aJdtqvtJRUoCmkwMUYygeeevYJbtQpoxk45F2O0uLHzRgN2VKmTRNct8PmQ5nZIIEfrcLQgI0VYbjYoBtfrMFAVoTALdu\/V73E8Bujurt7UomkoXI933HtJMZvpYDrfLjSfXG7CxSIhfpfT7cZ\/FglHkAdzsCgWaMjORR78nWiwrUw6BZNAnWD\/hRlMB7xG6OyHaP2s5tBq65mdgTDdDUCjhcXvwyqZ0rN0QiV8WDofR2tqKkMuFpwQZxkGOWvYAGh0EEsHocr2bkgCNTU3ozeWTipDCfo\/ekMTyfGSv\/gCyI\/OQkZ4JpVpL8G58unswHl\/rjl\/XFg522GgE0KmjeP1+RLTbFbK6rRE5MZH\/wL1TLr8kRQGak8AnSXhJrJ4qeKoh4G7agdCB6wleD7VWD5\/HjeJjI3D3KrJ0OCpdw4BuEoWtHxXDeH4hxAtOR0SQy1DzkUw48qEYeh345ffA5pQEaGpu7gTdI3AqIvQmSjfnfI5KeIovR4ZRDp3BRPBOHLGOxOwVFjho3I81P8V9S0uLtF12G8QZUxFRELxGI8g0akG867HQPR8cEP+mBLwpCdBMSaQvcd\/XMEgqSpdzIZ8F9h2XIUPngs5oRtDnQpPvVIK3oqaxw\/U57hmePWD21cBd0wlekIlaNcGTAK9uEJ9ati70CuuJ1AVo6Tn++yNC+3Ey6Ni5SNiHlh3XIkNBY70pm8Z+H5yRfMxf5cX+w83xryXG\/RXnRPHMXAGCXIyQ1aPUZf\/YEV0\/d2XwCXaSdgH8KQlgaWnpFT4ZZJ\/Au7M+j\/VFt8IkFhF8LkGG4Itk49HXBGzeVhW\/NBb3bP0JIyP4070CtBo5VIpoRKsRsLdS9s8Zj\/gXBILwtgvAPdBbKfxTFqCFkklS+FRFSHU\/ybFl38PQu\/4GQ+ZQ6bwvbMBLG3Ow7t3iTjfL8W6hUM3LDGD9UgGZRhnUagXUyqh4vFl28Iol\/tucHtgT4LmHUhagT\/A9uH5frG+reBnKhlVIyxwGQVDCF1Jiw94xeOLZzZLFY43Hdc74arkbbz0qx\/AcOcELILeH1RltvPJe\/6ya5mhlF\/hgygK0Wq3984BUROhy7KrdCLFqIYzm4VCotGThCErqz8ddj7yPYLAj43Pcc8wHvHasfUCGs0Z2wCvVJky9o+nJw8dFntBZkggQSVmAVOEHIgx8rXvg\/5bi3pwLldoIP5Wxx7yX4fYl78Dh6Mj47AUuqvJstlasmifikolt4BqVQCKo0WBaidPPn303XbqTenMCPNfF4ZQFsJLCfYE\/AawPIgRcx+HecwNM6enQ6DLI8j60Clfg9sXv4\/vaxk436KOJDie9RdcH8eufdcDztlZzH4JpV2DSpEkL6NIdXQQItgsQTVmAPsGfpAjhoB2O4l\/AaCAIQxZCQS+82ssx75HN2Lu\/rNPNcdwz\/PTzvXjw5g5wjVqORuUtaFXPRFpaGiZMmDCPLv+miwCS9eMcvQnAMdYrbBLQeFWY7FyX\/agYhLXkVqSpbNAacxEO+RHSTcFDz+7Hli92dEp6sbifeKodzy4QoNO0xb2Wk57iMtQoFkhLeAaDAWecccZc+sp26k0J7s\/w0dQFoOKiT\/B9FIHhrPsWQh8toypvKCKRMM1czsSad2x4852P6bhjhheL+yHprVh7PxUrBiGe9DyKn6ACD0Gt0UOr1YLXMseOHTubvvY19cYE64vx\/09FAK6u+gPfmwj2spVQubdAn1HAhAgJ+XhvmwEr1\/xZcvXExnGvkVnwxoMR5A3qgA8qTsGB8OOU+dMl+JgHFBYW3k5f+7LdA4Ix1++bAA7HD+YBruN\/gaxpLQzmUZDLFQiKRnxVMQr3P\/q8BJvYWIywvwWvLPFj9LBYzAuIKrKwJ\/A4oBosgScKUFBQ8Gv66la05YBwzPX7LkCCNQfKAzxNXyJybDnBj4ag1CAYkuOQZSLm3\/scbHZHp5vhMPC6bfj9XBcmj++AF5R6lHqXkgec2gmet5wEhw4dOpP+aytxtCS6fp8EcJAA0s2nKkIS+K5x77cfgv\/wQqQNKoRSlSYVN7X+yZiz+GXU1Td2SnpSne9y4qGZNlx1rhxc2zO8SqXEbvdCOGVnSdCJAnD8m0wmDBo06HqqCbYGAgFrMsjUBHA6k4L2ujrUzTbkrYPnwFyq74dBpaWpbcAHW3Qi7njgbZRXHJOyfCI8h8It01ow6ypImV7DAqjk2O++FQ3hqZ3guet0Osn6RqORt\/9JAnxFAthOWgAnCdCdtfsKHwk64dz3GxiMGVAb8trGevlYLHpiE4pKD3bK+NyCwSAuPqMFD98UInhFfKyv8F5F\/bq4xbnyY3C2PMc+C8D7dP66dgHsJy8ADTupxH1v8DyVde6fT+N2FBrjCBrrAwjKhuDRNcXY\/EWJtJiR2FiM8fmtWDnHB72OwRUkghy1gXOw23YrDXeauPVjSS9m+XZ4mkQJ19L264ET4CRF4ORrP\/gINKiFNmOMtKYfEg14bv1RvP3+NsnSiY1dPy\/djufvciEzTd7m9lzohAuxrWkezRH0neAZmME57mPwCoWCRhZ5\/wXgwiMpaIoicHNV\/QEKz3boBv0HScFL01G8vbEFz726BYH2NftEeJPWgxcWWDE0qwPeF83FppoFkCvTk8Kn0\/yBPYDPkeWlTvfQLwF4RWiDy+1O3dpdPuPmqf2A6rDXoB88BTJBJyW9LbvcWLZqE7xe7wl\/rBICWDPXgjHDEYcX5SZsODYfIXlOJ3iOe4bPyMiQrM\/HbHluZP2BFSCZ1XuLe3\/LdgSrliEt7yIIal7MdKD4kBdLVmyG0+nuNNxJN02F2vJbmnDeOLEt4ZEAgkKDT47MhjMyolt47uwJSqWyLUw7ev8F4LW2pMC9iBB0lsF3cC7ScqdAqR+BgN+K8qNO3PnYF2hpdZ4Az8dLfm7B1ecG48OdWqXAxiMzUe8b3wk+VuhkZmZKnfdVKlXM6vH7GDABerN+V\/iwv5Hm9b9CWvZZUJlOR9BvQ22dBfMe247jdbak8DdPs2HW5d42eEkAObZWX4HD1sndwlOhI7l+e8bvDDdgAng8fQoBMeSGo3QGjfUUr9lTpbG+pekY5j9RjO+qToTndukEF1V6jnb4tsRXWj8ZO2ovTQrPLs\/wvOVzHPddnzq330\/\/BfCQAD2NAonw\/CjKsftmaAQbdHnXICLK4bQcwpLfHcDOfdak8BNO9eG3s1ph0LXDkwgVrafh0\/LraKzXdqrvOc4ZOisrS\/IAHvvbs\/2JAtCxfKAE6C322\/ZprN+\/CCrvV9DnT0dUng63pQRPvFiOjdtdSeFH5ATxxzstMJvkcfh61xD8Zf8NUKj0cfjE+j47Oxtms1nyhMSk19X9GU8Q+lcHtAlAQ1Uq1m+q+BC6+nuQNvRKKtpHwdO8C8+\/VYE3PwsnhTcbw3hhvgXDchCHdwQy8FrxDYgKGSfU+AzPlufO+5z0unH7Nm+U8YOR\/lWCnQTo2fpA1e4NyAytRaY5Bx7Hcbz36VH8\/q9KJGGHViXiuXkWjB8RiY\/1AVGHV3dcD6+YnTTuGZytzwUPJ73YalIyAXg0EOUC9GpV\/wWQipVeMn\/Q78b3h\/4HCn6dzrIepUVf48n1eoTFE\/9CkEfx9G2tmHJ6MA4flSmxdsfVaPYO6wTPneE54eXk5EjwfC4GHxMgto3dFwsQVaiQrtdeS57yNZXa\/ROgtxzQUFlEMR+BGHYj5Lfjm1178PRznyT94SUzbJh+gS8+rxcUcqwvuhiVLYVxaLZwbILD8c6W56TH3iBZl6bMPHniCRO\/wMUC8O3wZ3JKigpBgYhCJeaZ069RKJTfhMMhR7J76ZsAPbr\/R1DrtQRvQ4i8LeSz4fk3vsRXxTWdfvSmaVQIXeOOFzoKhQwf75uEndVnJYXnjB9LepwEufHSGC+ghMIhRMIRSQx+54PvhAXgV2bUxky8\/urLn614\/LGHdTp9mdfr8SWDTE0An69H9w8H\/Sjb9SZ0xrQ2AcgDWASvx4o3\/\/4dtu+xSwtx087y4MlbHDQd7oDfVj4aG7497wR4hmV3jyU9PmYrBwJBafLEs0dpjZC9gGaWHAE05EFJ3zeZB+Hzjf8oWbxo0T0KpbKcSma73WYTB0aABC+IidB4pAQu6yGIEW9cgGCgzROC5AmV1XYcrPRg6cxGmAyC5PoMf6BmCN7YcRGN9bp4pk9c0WGrMzx7Art5IOCHz+eXngTHRAhTCETJA9jyGZkZMA8yo6S4qHLunDtmk2ccNKWn25ubmsTuIFMSQFqd7cH9y3e9S1mIgRPg270gTFWhXK4kt9ThzMF7kWEAFEoZjrea8dK2y6UHmLFVHO6J++wBLAbD8yMyp9MFrkl8JADD8\/MDvocheUMwbFi+dC\/79u9tnjNn7q1Oh7OYBLTX1dWJPTCepAAJ+xGKw31bfge1TtZmcQIPcw4IOqU3O2QysrbaKIEqom6My9qDcFTAul03QK5uy+o8prPFYwJwGPAYz+VtKBSG1+cFL8w2NjRQ3POwqUYm5Ybc3FzkDcmT7sVqtaGs\/LB7\/p0Lbm9oaPjn4MGD7UePHu0Rvk8CdBf\/VYfI\/Ws\/pX0fWd5B8A7p9VUxEoBM3rZsrVAZoVKnw2KN4HiTEsasEdCnD5fgeTrL4Oz6MWiOdU5s7Oputwc8HbdZrbDarLjpxhvjQx57AF\/D8EeOVIbuv\/+BeWVl5R\/m5+fby8rKeoXvuwBJwmDNs6vQVLMbP5+WiUjIRd0jrf2x5QWFlgQwoNUugyOYB9PgM5Cdmx9fs2NotnZiOcvDGic3fiTucjolt+dVaRaAM\/2M6dNPgD96rEpcvnzFgyXFpWsLCk5xHDjwbUrw\/RJAyv7k\/r+4fgbN7W0Yf6oGN145iD6PgF9blQkaeLxUFOlOR07BOcig6pDjOQbMlm5fs4sXNDF4jm+Xi2aUTge5PolA7s\/PJ7kQunjaRV3gj0RXr169\/Mut29YUFo6y7969J5oie98F6BoGJUU7sWjJfdK6Pd\/QqGFqzP3laKQbc5E+dCqyCyZLDypjwDxr67pgwS3m8jykMTz\/Flud495us0v7vDR\/9tmTUDhqZCI8XnrppWc\/27R5xZixY+zFRcV9gu+3AL995im899cP4gJkZ5mx8O4FmHnjzXRRxxQ19j2G7\/Tn7eUsw3OPWZ+HXQe\/7mZ3SFt+NOenczNmTJeqvZjlCX715s82rxg3bpx9585dfYZPXQCCO2HeHxVx6SUXS4+xRhaMwG\/mzMHV11wnWbsrZLL9rgIkuj+vQNkJXnrnjzpbPycnG5PPOTse86tXr1nBbj9u\/Dj7rpOEPzkB2vPAntJivPDiC5j1X7Nw\/pSpSZfC+yoAw8fiP\/bCIwvBwyDDcwhxtl\/x1FNLS0tK144ZQ25fXHLS8P0SIBQK0rCl7hH4ZAXgzB8TgONfR6PF6NGF0ji\/9OGl95SXV\/ydEp5jz569\/YLvlwCpWPxkBZDe\/JIEsEv5YMTwYaiqqmhesnjJnY2NjV+cUlDgOPjtwX7D\/+gESBwC2QPsbH1TBg7vK62697775rucruL8YfmOivKKAYFPWQDO8IkAXdfgeoNMRYDEUYDrfQeFQVChwdaNH5csfeihxXTdQSpvHdXV1QMGn4oA59MffzqQf9i1SQJQD9OEh+v8INUC\/mAYbl9AXPfyC5+venr5MhpZyjPNZkdDff2AwvcoAFnHQDdXSLu54CdW\/\/eNXxSoo\/lBNU1pnZbm5gGH71EAUl2gykxLIgjo2VN+qBalewhotNoAzQl+EPgeBfh3af\/2AvwvbF+OQNe52mMAAAAASUVORK5CYII=",
        "file": "test.png"
    }
}
...

Response:

  • tmpUploadId
    STRING. Temporary upload id. It is needed for the second step
...
"records": [
 	{
 	 	"id": 0,
 	 	"type": "",
 	 	"elements": {
 	 	 	"filesize": 9407,
 	 	 	"tmpUploadId": "b09f36b0-7bf3-4691-e1c6-7a298f1fd1ed"
 	 	}
 	}
]
...

Example second step with module tmpUpload: Specify module and further information

Request:

...
{
	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
	"resourceid": null,
	"identifier": "2",
	"resourcetype": "uploadfile",
	"parameters": {
		"file": "test.png",
		"title": "test.png",
		"tmpUploadId": "3e53c275-ea8b-4a32-0d04-6915acf945f6",
		"Art": null,
		"relatedRecordId": null,
		"module": "tmpUpload"
	}
}
...

Response:

  • tmpUploadId
    STRING. Temporary upload id.
  • cacheFileUuid
    STRING. Cache file uuid with which you can continue to work.
...
{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:do",
                "resourceid": "",
                "resourcetype": "uploadfile",
                "cacheable": false,
                "identifier": "2",
                "data": {
                    "meta": {
                        "cntabsolute": null
                    },
                    "records": [
                        {
                            "id": 0,
                            "type": "",
                            "elements": {
                                "filesize": 4880,
                                "tmpUploadId": "15fe4d69-241f-42c3-f5ac-6a8c39a3bb69",
                                "cacheFileUuid": "ec74c71e-fea4-47dd-8d84-dac7a83d69fd",
                                "success": "success"
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}
...