v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

spec sections

Get all spec_sections in project

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

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[current_version_title_eq]string

Example:Test Value

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

filters[current_version_title_like]string

Example:Test Value

Filter on current_version_title field being like passed in value

filters[section_number_eq]string

Example:Test Value

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

filters[section_number_like]string

Example:Test Value

Filter on section_number field being like passed in value

filters[attached_to_submittal_eq]string

Example:true

Filter on attached_to_submittal field being equal to passed in value

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[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

filters[spec_section_current_version_title_section_number_like]string

Example:Test Value

Filter on spec_section_current_version_title_section_number field being like passed in value

filters[conflict_eq]string

Example:true

Filter on conflict field being equal to passed in value

filters[processing_eq]string

Example:true

Filter on processing field being equal to 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_section

section_numberstring required

The number that the spec_section corresponds to within a spec book

project_idstring uuid required

ID of the project the spec_section belongs to

current_version_idstring uuid nullable required

ID of the current spec_section_version of the spec_section

current_version_titlestring required

Title of the current spec_section_version of the spec_section

current_version_descriptionstring required

Description of the spec_section_version of the spec_section

current_version_file_urlstring nullable required

The URL for the PDF associated with the current spec_section_version of the spec_section

current_version_thumb_urlstring nullable required

The URL for the thumbnail associated with the current spec_section_version of the spec_section

conflictboolean required

Indicates a version conflict on the spec_section

processingboolean required

Indicates the processing status of the spec_section

errorboolean

Indicates whether the spec_section contains an error

creator_user_idinteger required

ID of the user who created the spec_section

last_editor_user_idinteger nullable required

ID of the last user who edited the spec_section

created_atstring date-time required

Time when the server created the spec_section

updated_atstring date-time required

Time when the server last updated the spec_section

deleted_atstring date-time nullable required

Time when the server last deleted the spec_section

device_created_atstring date-time required

Time when the device created the spec_section

device_updated_atstring date-time required

Time when the device last updated the spec_section