v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

attachments

Create a new attachment

post/api/v3/projects/{project_id}/attachments

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

idstring uuid

ID of the attachment

creator_user_idinteger required

ID of the user who created this attachment

last_editor_user_idinteger required

ID of the user who most recently edited this attachment

folder_idstring uuid nullable

ID of the folder, if this attachment belongs to one

is_dynamicboolean

Whether the content of this attachment can change without the URL changing

file_urlstring required

URL of the potential processed file

namestring required

Name of the attachment

original_urlstring nullable

URL of the file originally uploaded by the user

thumb_urlstring nullable

URL of the thumb version of image attachment

file_sizeinteger nullable

Attachment file size

kind'file' | 'photo' | 'video' | 'photo_sphere' | 'sign'

Kind of the attachment

latitudenumber double nullable

Latitude of where this photo attachment was created

longitudenumber double nullable

Longitude of where this photo attachment was created

device_created_atstring date-time nullable

Time when the device created the attachment

device_updated_atstring date-time nullable

Time when the device last updated the attachment

flattened_file_urlstring nullable

URL of the file that has the markups flattened too

deleted_by_two_way_syncboolean nullable

Indicates if a file was deleted by two way sync

origin'photo_gallery' | 'plan_attachment' | 'form_attachment' | 'bubble_attachment' | 'null' nullable

Indicates the original location an attachment is uploaded from

cropboolean

Flag to notify whether thumb_url should be populated by cropping this attachment (only applicable for photo & photo_sphere)

Response

Successful response

idstring uuid required

ID of the attachment

creator_user_idinteger required

ID of the user who created this attachment

last_editor_user_idinteger required

ID of the user who most recently edited this attachment

cascade_deleted_by_idstring uuid nullable

ID of the item that cascaded its delete to this attachment

folder_idstring uuid nullable

ID of the folder, if this attachment belongs to one

project_idstring uuid required

ID of the project this attachment belongs to

is_dynamicboolean required

Whether the content of this attachment can change without the URL changing

file_urlstring required

URL of the potential processed file

namestring required

Name of the attachment

original_urlstring nullable

URL of the file originally uploaded by the user

thumb_urlstring nullable

URL of the thumb version of image attachment

file_sizeinteger nullable

Attachment file size

floorplans_countinteger required

Count of active plans this attachment links to

kind'file' | 'photo' | 'video' | 'photo_sphere' | 'sign' required

Kind of the attachment

process_state'deleting' | 'restoring' | 'null' nullable

Whether this attachment is being restored or deleted

latitudenumber double nullable

Latitude of where this photo attachment was created

longitudenumber double nullable

Longitude of where this photo attachment was created

captured_atstring date-time nullable

Time when a photo attachment was taken extracted from photo data

created_atstring date-time required

Time when the server created the attachment

deleted_atstring date-time nullable

Time the server deleted the attachment

resolved_conflictboolean nullable required

Specifies if PUT/PATCH request was rejected - do not store this field!

device_created_atstring date-time nullable required

Time when the device created the attachment

device_updated_atstring date-time nullable required

Time when the device last updated the attachment

updated_atstring date-time required

Time when the server last updated the attachment

flattened_file_urlstring nullable

URL of the file that has the markups flattened too

deleted_by_two_way_syncboolean nullable required

Indicates if a file was deleted by two way sync

origin'photo_gallery' | 'plan_attachment' | 'form_attachment' | 'bubble_attachment' | 'null' nullable required

Indicates the original location an attachment is uploaded from