v1

latestOpenAPI 3.0.02026-07-24622596.0 KB

Projects

Upload a Document

post/projects/{project_id}/documents

Path parameters

project_idstring id required

ID of the Project

Headers

X-CompanyCam-Userstring

Email of CompanyCam user to be designated as the creator

Request body

Example request

{
  "document": {
    "name": "test.txt",
    "attachment": "VGVzdAo="
  }
}

Response

The created project document

idstring required

The unique ID of the document

creator_idstring

The unique ID of the entity that created the document

creator_typestring

The type of the entity that created the document

creator_namestring

The unique ID of the company that owns the document

project_idstring

The unique ID of the project the document is attached to

namestring

the filename of the document

urlstring

The URL where the document can be downloaded/viewed from

content_typestring

The content type of the document. (e.g. application/pdf)

byte_sizeinteger

The size of the document in bytes.

created_atinteger

Timestamp when the Document was created on the server

updated_atinteger

Timestamp when the Document was last updated

Example response

{
  "id": "115",
  "creator_id": "8675309",
  "creator_type": "User",
  "creator_name": "CompanyCam Developer",
  "project_id": "48892885",
  "name": "silver-kadabra-measurements.pdf",
  "url": "https://static.companycam.com/documents/8374c65e-2048-41d4-b4a7-a9c839fd388a.pdf",
  "content_type": "application/pdf",
  "byte_size": 3457903,
  "created_at": 1621857746,
  "updated_at": 1621857746
}