Document

Get all BDMS.Models.Document that are linked to the BDMS.Models.Borehole with BDMS.Models.Borehole.Id provided in boreholeId.

get/api/v{version}/document/getallforborehole

Path parameters

versionstring required

Query parameters

boreholeIdinteger required

The id of the BDMS.Models.Borehole.

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 2 of the 25 revisions of this API.486

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

    • the response property items/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 response property items/boreholeId became optional for the status 200 (media type: text/plain)

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

    • the response property items/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.