Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
spec uploads

Get all spec_uploads in project

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

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

last_synced_atstring date-time

Timestamp since when further updates should be included

filters[status_eq]string
Example:processing

Filter on status field being equal to passed in value, allows for filtering with a array of values

filters[created_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than or equal to the passed in value

filters[created_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than the passed in value

filters[created_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than or equal to the passed in value

filters[created_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than to the passed in value

filters[name_like]string
Example:Project 1

Filter on name field being like passed in value

filters[name_eq]string
Example:Project 1

Filter on name field being equal to passed in value, allows for filtering with a array of values

filters[updated_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than or equal to the passed in value

filters[updated_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than or equal to the passed in value

filters[updated_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than to the passed in value

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Fieldwire-Filter'active' | 'deleted'

Specifies if request should include active, deleted or all (default) entities

Fieldwire-Per-Pageinteger

Specifies the number of entities to include in the request

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!