docs: add company-level upload docs and verify project-level accuracy#354
Open
cynthiaxhe wants to merge 1 commit intomainfrom
Open
docs: add company-level upload docs and verify project-level accuracy#354cynthiaxhe wants to merge 1 commit intomainfrom
cynthiaxhe wants to merge 1 commit intomainfrom
Conversation
cynthiaxhe
force-pushed
the
cynthia/ppc2-7768-unified-uploads-company-level
branch
2 times, most recently
from
da1459c to
d982ad6
Compare
| | `infected` | File failed malware scan; do not use | | ||
| | `available` | File is fully processed and available for use in Procore | | ||
| | `failed` | Upload processing failed | | ||
| | `expired` | Upload window elapsed before completion; file has been deleted | |
Contributor
There was a problem hiding this comment.
Since Unified Uploads does not support malware scan related status codes yet - I suggest going back to the status codes that are supported today
- `ready` — Upload created, waiting for file content
- `receiving` — Parts are being uploaded (partial ETags submitted)
- `complete` — All parts uploaded and ETags submitted
- `available` — File is fully processed and available for use in Procore
| | `infected` | File failed malware scan; do not use | | ||
| | `available` | File is fully processed and available for use in Procore | | ||
| | `failed` | Upload processing failed | | ||
| | `expired` | Upload window elapsed before completion; file has been deleted | |
| | `failed` | Upload processing failed | | ||
| | `expired` | Upload window elapsed before completion; file has been deleted | | ||
|
|
||
| > **Note:** After a successful PATCH, the upload status is `complete`. From there, the progression to `available` depends on whether malware scanning is enabled: |
Contributor
There was a problem hiding this comment.
Remove this new "NOTE" section because malware scan is not yet supported
cynthiaxhe
force-pushed
the
cynthia/ppc2-7768-unified-uploads-company-level
branch
3 times, most recently
from
4947a0f to
fcf6f42
Compare
- Add company-level endpoints table and single-part upload example - Add differences table comparing project-level vs company-level - Fix status values: correct in_progress/completed → ready/receiving/complete/available - Expand status reference table with scanning, clean, infected, failed, expired - Add status progression note explaining complete → available flow and upcoming malware scanning - Remove total_parts from POST responses (field does not exist in API response) - Fix segment size limits: 100 MB → 100 MiB (104,857,600 bytes), 5 MB min → >5 MiB (5,242,881 bytes) Closes PPC2-7768 Co-authored-by: Cursor <cursoragent@cursor.com>
cynthiaxhe
force-pushed
the
cynthia/ppc2-7768-unified-uploads-company-level
branch
from
fcf6f42 to
608685e
Compare
| | [Create Upload](https://developers.procore.com/reference/rest/uploads?version=2.1#create-unified-upload-company) | POST | `/rest/v2.1/companies/{company_id}/uploads` | | ||
| | Upload File Content | PUT | Presigned URL returned in the `segments[].url` field of the POST response | | ||
| | [Complete Upload](https://developers.procore.com/reference/rest/uploads?version=2.1#complete-unified-upload-company) | PATCH | `/rest/v2.1/companies/{company_id}/uploads/{upload_id}` | | ||
| | [Get Upload Status](https://developers.procore.com/reference/rest/uploads?version=2.1#get-unified-upload-status-company) | GET | `/rest/v2.1/companies/{company_id}/uploads/{upload_id}` | |
Contributor
There was a problem hiding this comment.
| | [Create Upload](https://developers.procore.com/reference/rest/uploads?version=2.1#create-unified-upload-company) | POST | `/rest/v2.1/companies/{company_id}/uploads` | | ||
| | Upload File Content | PUT | Presigned URL returned in the `segments[].url` field of the POST response | | ||
| | [Complete Upload](https://developers.procore.com/reference/rest/uploads?version=2.1#complete-unified-upload-company) | PATCH | `/rest/v2.1/companies/{company_id}/uploads/{upload_id}` | | ||
| | [Get Upload Status](https://developers.procore.com/reference/rest/uploads?version=2.1#get-unified-upload-status-company) | GET | `/rest/v2.1/companies/{company_id}/uploads/{upload_id}` | |
Contributor
There was a problem hiding this comment.
Other examples - "update-company-upload" -> https://developers.procore.com/reference/rest/uploads?version=latest#update-company-upload etc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
file-upload-servicecodebaseChanges
New content
/rest/v2.1/companies/{company_id}/uploads)Accuracy fixes
in_progress/completed→ready/receiving/complete/availablescanning,clean,infected,failed,expiredcomplete→availableflow and upcoming malware scanning pathtotal_partsfrom POST responses (field not present in the API response)Closes PPC2-7768
Made with Cursor