Profile

Lists all BDMS.Models.Profiles attached to the given borehole.

get/api/v{version}/profile/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.Profile.Borehole id.

namestring

Gets or sets the BDMS.Models.Profile's original file name.

nameUuidstring

Gets or sets the unique BDMS.Models.Profile file name.

typestring

Gets or sets the BDMS.Models.Profile's content type.

descriptionstring nullable

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

publicboolean nullable

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

ocrStatus'Created' | 'Processing' | 'Success' | 'Error' | 'WillNotBeProcessed'

Lifecycle status of OCR processing for a BDMS.Models.Profile file.

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

Changes

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

    • 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

    • added the optional property items/ocrStatus to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property items/ocrStatus to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property items/ocrStatus to the response with the 200 status (media type: text/json)

      response-optional-property-added

    • removed the optional property items/ocrStatus from the response with the 200 status (media type: text/plain)

      response-optional-property-removed

    • removed the optional property items/ocrStatus from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property items/ocrStatus from the response with the 200 status (media type: text/json)

      response-optional-property-removed

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

    • added the optional property items/ocrStatus to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property items/ocrStatus to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property items/ocrStatus to the response with the 200 status (media type: text/json)

      response-optional-property-added