v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
spec uploads

Create a new spec_upload

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

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

project_idstring uuid

ID of the project the spec_upload belongs to

creator_user_idinteger

ID of the user who created the spec_upload

last_editor_user_idinteger nullable

ID of the last user who edited the spec_upload

device_created_atstring date-time nullable

Time when the device created the spec_upload

device_updated_atstring date-time nullable

Time when the device last updated the spec_upload

file_urlstring

File url for the attachment associated with the spec_upload

namestring

File name for the attachment associated with the spec_upload

default_version_descriptionstring

The default version description to be used for spec section versions

Response

Successful response

idstring uuid required

ID of the spec_upload

status'processing' | 'reviewed' | 'timeout_error' | 'process_error' | 'under_review' | 'null' nullable required

Status of the spec_upload

attachment_idstring uuid required

ID of the associated attachment on the spec_upload

file_urlstring required

file_url of the associated attachment - this field is delegated

namestring required

File name of the associated attachment - this field is delegated

jidstring nullable required

The job id associated to the splitting of the uploaded PDF (and creation of spec_sections) after spec_upload#review is invoked

default_version_descriptionstring nullable

The default version description to be used for spec section versions

project_idstring uuid required

ID of the project the spec_upload belongs to

creator_user_idinteger required

ID of the user who created the spec_upload

last_editor_user_idinteger nullable required

ID of the last user who edited the spec_upload

created_atstring date-time required

Time when the server created the spec_upload

updated_atstring date-time required

Time when the server last updated the spec_upload

deleted_atstring date-time nullable required

Time when the server last deleted the spec_upload

device_created_atstring date-time nullable required

Time when the device created the spec_upload

device_updated_atstring date-time nullable required

Time when the device last updated the spec_upload

resolved_conflictboolean nullable required

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