Sign in
specimens

Create Specimen

Changed on

Submit a new specimen for review.

post/api/v1/specimens/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/login/access-token)

Request body

comment_by_authorstring nullable
specimen_reference_idstring required
replicate_testsinteger required
notestring nullable
dowelboolean required
connectorboolean required
assembly_type'Wall-Floor' | 'Wall-Wall' | 'Wall-Floor & Wall-Wall' required
practice'Conventional' | 'Research and Development' required
connection_descriptionstring nullable
element_dimensionstring required
fastener_numbersinteger required
moisture_percentagestring nullable
wood_typestring nullable
wood_mechanical_propertiesstring nullable
connector_mechanical_propertiesstring nullable
fastener_mechanical_propertiesstring nullable
e_datestring nullable
e_test_loading_type'Cyclic' | 'Monotonic' | 'Monotonic and Cyclic' required
e_yield_point_method'CEN 1/6' | 'EEEP' required
e_stiffnessnumber required
e_yield_displacementnumber required
e_yield_forcenumber required
e_max_displacementnumber required
e_max_forcenumber required
e_ultimate_displacementnumber required
e_ultimate_forcenumber required
e_ductilitynumber required
e_qfm_descriptionstring nullable
doi_idstring uuid required
e_qualitative_failure_measurestring[] required
fastener_type_idsstring[] required
loading_direction_idsstring[] required
joinery_type_idstring uuid required
sub_joinery_type_idstring uuid required

Response

Successful Response

comment_by_authorstring nullable
specimen_idstring uuid nullable
changed_by_user_idstring uuid required
changed_dataobject required
idstring uuid required
status'pending' | 'approved' | 'rejected' required
created_atstring date-time required
reviewer_idstring uuid nullable
comment_by_reviewerstring nullable
reviewed_atstring date-time nullable

Changes

  • 43713faf2a43Revision changes
    • breaking

      removed the enum value FEMA P795 of the request property

  • eac602fde46eRevision changes
    • breaking

      removed subschema #2 from the request property anyOf list

    • breaking

      removed subschema #2 from the request property anyOf list

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the request property type changed from no type to string

    • breaking

      the request property type changed from no type to string

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      the request property became optional

    • info

      added the new CEN 1/6 enum value to the request property

    • info

      added the new Cyclic enum value to the request property

    • info

      added the new EEEP enum value to the request property

    • info

      added the new FEMA P795 enum value to the request property

    • info

      added the new Monotonic enum value to the request property

    • info

      added the new Monotonic and Cyclic enum value to the request property

    • info

      request property list-of-types was widened by adding types null to media type application/json