Workgroup

Asynchronously gets the BDMS.Models.Workgroup with the specified id.

Changed on
get/api/v{version}/workgroup/{id}

Request

  • The document declares no server URL.
  • Auth
    OpenIdConnect (defined in the document in a form this page cannot read)

Path parameters

idinteger required
versionstring required

Response

Returns a workgroup.

idinteger required
namestring required

Gets or sets the name of the workgroup.

createdAtstring date-time nullable

Gets or sets the BDMS.Models.Workgroup created date.

disabledAtstring date-time nullable

Gets or sets the BDMS.Models.Workgroup disabled date.

isDisabledboolean

Gets the value whether the BDMS.Models.Workgroup is disabled or not.

settingsstring nullable

Gets or sets the Settings for the BDMS.Models.Workgroup.

boreholeCountinteger

Number of boreholes in the workgroup.

Changes

  • 4b5d5e7caaa2Revision changes
    • info

      the response property became required for the status (media type: text/plain)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/json)