Workgroup

Sets or removes workgroup roles. A user holds one role per workgroup: an active role replaces the user's current role in that workgroup, an inactive role removes it only if it is the current role.

Changed on
post/api/v{version}/workgroup/setroles

Request

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

Path parameters

versionstring required

Request body

userIdinteger required

Gets or sets the foreign key to the BDMS.Models.UserWorkgroupRole.User entity.

workgroupIdinteger required

Gets or sets the foreign key to the BDMS.Models.UserWorkgroupRole.Workgroup entity.

role'Reader' | 'Editor' | 'Reviewer' | 'Publisher'

Represents a role entity in the database.

isActiveboolean nullable

Gets or sets whether the role is active or not.

Response

The roles were set successfully.

Changes

  • 7f70d3203af2Revision changes
    • breaking

      removed the enum value Controller of the request property / (media type: application/json)

    • breaking

      removed the enum value Controller of the request property / (media type: text/json)

    • breaking

      removed the enum value Controller of the request property / (media type: application/*+json)

    • breaking

      removed the enum value View of the request property / (media type: application/json)

    • breaking

      removed the enum value View of the request property / (media type: text/json)

    • breaking

      removed the enum value View of the request property / (media type: application/*+json)

    • info

      added the new Reader enum value to the request property / (media type: application/json)

    • info

      added the new Reader enum value to the request property / (media type: text/json)

    • info

      added the new Reader enum value to the request property / (media type: application/*+json)

    • info

      added the new Reviewer enum value to the request property / (media type: application/json)

    • info

      added the new Reviewer enum value to the request property / (media type: text/json)

    • info

      added the new Reviewer enum value to the request property / (media type: application/*+json)

  • aeb37c95c81fRevision changes
    • breaking

      removed the enum value Validator of the request property / (media type: application/json)

    • breaking

      removed the enum value Validator of the request property / (media type: text/json)

    • breaking

      removed the enum value Validator of the request property / (media type: application/*+json)