Company Uploads
Description
Creating an Upload is the first step in associating a file to a resource
in Procore. Creating an Upload can be seen as fetching instruction on how
to post your file directly to Procore's storage service.
The instructions contain three properties: a UUID to reference the
Upload, a URL which has to be used to post the file, and fields which
need to be posted together with the file.
To upload the file you must POST to the URL in the url property with
a multipart/form-data body (see RFC 2388). Make sure to include all
the names and values from fields without altering them. The URL and
fields necessary to complete the upload may vary between companies and
may also change over time so none of these may be hard-coded. Finally add
a field named file with the actual file data.
Uploads are associated to a Company so they can use company specific
upload settings. The currently authenticated user will become the owner
of the Upload and only that user can use the Upload in subsequent
requests.
You will have to initiate the upload within one hour or you can expect
a 403 Forbidden response. Other errors are usually clearly explained in
the response body.
For an example of how to associate a finalized upload to another resource
in Procore see the Photos resource. An Upload will have to be associated
to another resource within a week or it will be automatically deleted from
Procore servers.
Note that there is also a variant of this API endpoint that works using a
Project ID.
Changelog
Date | Category | Breaking | Summary |
|---|---|---|---|
Nov 20 2024 | Feature | Add size attribute as a new parameter to Create Company Uploads | |
Aug 23 2024 | Feature | Add attachment_content_disposition as a new parameter for Create Company Uploads | |
Dec 04 2023 | New | true | Versioned endpoint |
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
company_idinteger*
Unique identifier for the company.
1const request = require('request');
2
3const options = {
4 method: 'POST',
5 url: 'https://api.procore.com/rest/v1.1/companies/%7Bcompany_id%7D/uploads',
6 headers: {'content-type': 'application/json'},
7 body: {
8 response_filename: 'Contract.pdf',
9 response_content_type: 'application/pdf',
10 attachment_content_disposition: true,
11 size: 1234567,
12 segments: [
13 {
14 size: 5242880,
15 sha256: '70c50ce1892d79bc900a0e753b12126273ea8e80051386531b3c10dc68d33926',
16 md5: '85a13cb23a2fded1b6c6b78a48507a12',
17 etag: '9c6243014e7ae154a58d29294906d4a960c60765'
18 }
19 ]
20 },
21 json: true
22};
23
24request(options, function (error, response, body) {
25 if (error) throw new Error(error);
26
27 console.log(body);
28});
29Body Parameters
Body
response_filenamestring*
By setting a filename you ensure that the storage service knows the
filename of the upload. Files are often downloaded directly from the
storage service and without the filename they will save on the end
users' device without a readable name or extension.
response_content_typestring
The content-type set through this parameter will be used by the storage
service during download just like the response_filename. Setting this
value is less important because HTTP clients and operating systems are
generally well equipped to determine file types.
Setting this parameter is optional and should only be included when you
are certain it's correct or when you want to force a content-type other
than what the filename extension suggests.
attachment_content_dispositionboolean
The content type set through this parameter will be used by the storage system during download, similar to the response_filename. When set to true, the file will be downloaded as an attachment. Otherwise, the file content will be rendered inline in the browser.
sizeinteger
File size in bytes
segmentsarray
Upload segments
1{
2 "response_filename": "Contract.pdf",
3 "response_content_type": "application/pdf",
4 "attachment_content_disposition": true,
5 "size": 1234567,
6 "segments": [
7 {
8 "size": 5242880,
9 "sha256": "70c50ce1892d79bc900a0e753b12126273ea8e80051386531b3c10dc68d33926",
10 "md5": "85a13cb23a2fded1b6c6b78a48507a12",
11 "etag": "9c6243014e7ae154a58d29294906d4a960c60765"
12 }
13 ]
14}Responses
Body
One Of
uuidstring
Reference to the upload that stays valid during the lifecycle of the
upload. After uploading to the storage service you will use
this reference to associate the upload to another resource.
urlstring
Post the multipart/form-data encoded body with the upload to this URL. Do
not attempt to cache or alter the URL in any way or the upload may fail.
fieldsobject
Fields to send with the file data to sucessfully complete the upload. Do
not make any assumptions about the names or contents of the fields because
they may change at any time to any other value.
1{
2 "uuid": "1QJ83Q56CVQR4X3C0JG7YV86F8",
3 "url": "https://procore-uploads.s3.amazonaws.com",
4 "fields": {
5 "key": "companies/352/1QJ83Q56CVQR4X3C0JG7YV86F8",
6 "Content-Type": "application/pdf",
7 "Content-Disposition": "inline; filename=\\\"Contract.pdf\\\"",
8 "policy": "eyJleHBpc=",
9 "x-amz-credential": "ABCD/1234/us-east-1/s3/aws4_request",
10 "x-amz-algorithm": "AWS4-HMAC-SHA256",
11 "x-amz-date": "20210809T131612Z",
12 "x-amz-signature": "abcd1234243ae6f4"
13 }
14}Description
Show detailed information on an upload
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
company_idinteger*
Unique identifier for the company.
uuidstring*
Upload UUID
1const request = require('request');
2
3const options = {
4 method: 'GET',
5 url: 'https://api.procore.com/rest/v1.1/companies/%7Bcompany_id%7D/uploads/%7Buuid%7D'
6};
7
8request(options, function (error, response, body) {
9 if (error) throw new Error(error);
10
11 console.log(body);
12});
13Responses
Body
One Of
uuidstring
Reference to the upload that stays valid during the lifecycle of the
upload. After uploading to the storage service you will use
this reference to associate the upload to another resource.
urlstring
Post the multipart/form-data encoded body with the upload to this URL. Do
not attempt to cache or alter the URL in any way or the upload may fail.
fieldsobject
Fields to send with the file data to sucessfully complete the upload. Do
not make any assumptions about the names or contents of the fields because
they may change at any time to any other value.
1{
2 "uuid": "1QJ83Q56CVQR4X3C0JG7YV86F8",
3 "url": "https://procore-uploads.s3.amazonaws.com",
4 "fields": {
5 "key": "companies/352/1QJ83Q56CVQR4X3C0JG7YV86F8",
6 "Content-Type": "application/pdf",
7 "Content-Disposition": "inline; filename=\\\"Contract.pdf\\\"",
8 "policy": "eyJleHBpc=",
9 "x-amz-credential": "ABCD/1234/us-east-1/s3/aws4_request",
10 "x-amz-algorithm": "AWS4-HMAC-SHA256",
11 "x-amz-date": "20210809T131612Z",
12 "x-amz-signature": "abcd1234243ae6f4"
13 }
14}Description
Update the upload.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
company_idinteger*
Unique identifier for the company.
uuidstring*
Upload UUID
1const request = require('request');
2
3const options = {
4 method: 'PATCH',
5 url: 'https://api.procore.com/rest/v1.1/companies/%7Bcompany_id%7D/uploads/%7Buuid%7D',
6 headers: {'content-type': 'application/json'},
7 body: {
8 segments: [
9 {
10 size: 5242880,
11 sha256: '70c50ce1892d79bc900a0e753b12126273ea8e80051386531b3c10dc68d33926',
12 md5: '85a13cb23a2fded1b6c6b78a48507a12',
13 etag: '9c6243014e7ae154a58d29294906d4a960c60765'
14 }
15 ]
16 },
17 json: true
18};
19
20request(options, function (error, response, body) {
21 if (error) throw new Error(error);
22
23 console.log(body);
24});
25Body Parameters
Body
segmentsarray
Upload segments
1{
2 "segments": [
3 {
4 "size": 5242880,
5 "sha256": "70c50ce1892d79bc900a0e753b12126273ea8e80051386531b3c10dc68d33926",
6 "md5": "85a13cb23a2fded1b6c6b78a48507a12",
7 "etag": "9c6243014e7ae154a58d29294906d4a960c60765"
8 }
9 ]
10}Responses
Body
One Of
uuidstring
Reference to the upload that stays valid during the lifecycle of the
upload. After uploading to the storage service you will use
this reference to associate the upload to another resource.
urlstring
Post the multipart/form-data encoded body with the upload to this URL. Do
not attempt to cache or alter the URL in any way or the upload may fail.
fieldsobject
Fields to send with the file data to sucessfully complete the upload. Do
not make any assumptions about the names or contents of the fields because
they may change at any time to any other value.
1{
2 "uuid": "1QJ83Q56CVQR4X3C0JG7YV86F8",
3 "url": "https://procore-uploads.s3.amazonaws.com",
4 "fields": {
5 "key": "companies/352/1QJ83Q56CVQR4X3C0JG7YV86F8",
6 "Content-Type": "application/pdf",
7 "Content-Disposition": "inline; filename=\\\"Contract.pdf\\\"",
8 "policy": "eyJleHBpc=",
9 "x-amz-credential": "ABCD/1234/us-east-1/s3/aws4_request",
10 "x-amz-algorithm": "AWS4-HMAC-SHA256",
11 "x-amz-date": "20210809T131612Z",
12 "x-amz-signature": "abcd1234243ae6f4"
13 }
14}