Document

Adds the BDMS.Models.Document to the BDMS.Models.Borehole by BDMS.Models.Document.BoreholeId.

post/api/v{version}/document

Path parameters

versionstring required

Request body

idinteger required
boreholeIdinteger required

Gets or sets the BDMS.Models.Document.Borehole id.

urlstring uri

Gets or sets the BDMS.Models.Document's url.

descriptionstring nullable

Gets or sets the BDMS.Models.Document's description.

publicboolean

Gets or sets whether the BDMS.Models.Document is publicly visible.

createdByIdinteger nullable
createdstring date-time nullable
updatedByIdinteger nullable
updatedstring date-time nullable

Response

OK

idinteger required
boreholeIdinteger required

Gets or sets the BDMS.Models.Document.Borehole id.

urlstring uri

Gets or sets the BDMS.Models.Document's url.

descriptionstring nullable

Gets or sets the BDMS.Models.Document's description.

publicboolean

Gets or sets whether the BDMS.Models.Document is publicly visible.

createdByIdinteger nullable
createdstring date-time nullable
updatedByIdinteger nullable
updatedstring date-time nullable

Changes

Changed in 4 of the 25 revisions of this API.1566

  • 4b5d5e7caaa2126See the full diff
    • the request property createdBy/workgroupRoles/items/workgroup/name became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/name became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/name became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/name became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/name became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/name became required (media type: application/*+json)

      request-property-became-required

    • the createdBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: application/json)

      request-property-min-length-increased

    • the createdBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: text/json)

      request-property-min-length-increased

    • the createdBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: application/*+json)

      request-property-min-length-increased

    • the updatedBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: application/json)

      request-property-min-length-increased

    • the updatedBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: text/json)

      request-property-min-length-increased

    • the updatedBy/workgroupRoles/items/workgroup/name request property's minLength was increased from 0 to 1 (media type: application/*+json)

      request-property-min-length-increased

    • the response property createdBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: text/plain)

      response-property-became-required

    • the response property createdBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: application/json)

      response-property-became-required

    • the response property createdBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: text/json)

      response-property-became-required

    • the response property updatedBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: text/plain)

      response-property-became-required

    • the response property updatedBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: application/json)

      response-property-became-required

    • the response property updatedBy/workgroupRoles/items/workgroup/name became required for the status 200 (media type: text/json)

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the request property boreholeId became required (media type: application/json)

      request-property-became-required

    • the request property boreholeId became required (media type: text/json)

      request-property-became-required

    • the request property boreholeId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: application/*+json)

      request-property-became-required

    • the request property id became required (media type: application/json)

      request-property-became-required

    • the request property id became required (media type: text/json)

      request-property-became-required

    • the request property id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: application/*+json)

      request-property-became-required

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • the response property boreholeId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property boreholeId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property boreholeId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/term/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/term/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/term/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/termId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/termId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/termId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/userId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/userId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/termsAccepted/items/userId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/userId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/userId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/userId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property createdBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/term/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/term/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/term/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/termId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/termId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/termId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/userId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/userId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/termsAccepted/items/userId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/userId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/userId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/userId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroup/id became optional for the status 200 (media type: text/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: application/json)

      response-property-became-optional

    • the response property updatedBy/workgroupRoles/items/workgroupId became optional for the status 200 (media type: text/json)

      response-property-became-optional

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • the request property boreholeId became required (media type: application/json)

      request-property-became-required

    • the request property boreholeId became required (media type: text/json)

      request-property-became-required

    • the request property boreholeId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/term/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/termId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/termsAccepted/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroup/id became required (media type: application/*+json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: application/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: text/json)

      request-property-became-required

    • the request property createdBy/workgroupRoles/items/workgroupId became required (media type: application/*+json)

      request-property-became-required

    • the request property id became required (media type: application/json)

      request-property-became-required

    • the request property id became required (media type: text/json)

      request-property-became-required

    • the request property id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/term/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/termId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/termsAccepted/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/userId became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroup/id became required (media type: application/*+json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: application/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: text/json)

      request-property-became-required

    • the request property updatedBy/workgroupRoles/items/workgroupId became required (media type: application/*+json)

      request-property-became-required

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.