Workflow

Asynchronously gets the BDMS.Models.Workflow associated with boreholeId.

get/api/v{version}/workflow/{boreholeId}

Path parameters

boreholeIdinteger required
versionstring required

Response

Returns a workflow.

idinteger required
hasRequestedChangesboolean

Gets or sets if a reviewer has requested changes for the borehole.

status'Draft' | 'InReview' | 'Reviewed' | 'Published'

Represents the status of a BDMS.Models.Workflow.

boreholeIdinteger required

Gets or sets the id of the BDMS.Models.Workflow.Borehole.

reviewedTabsIdinteger required

Gets or sets the id of the BDMS.Models.Workflow.ReviewedTabs.

publishedTabsIdinteger required

Gets or sets the id of the BDMS.Models.Workflow.PublishedTabs.

assigneeIdinteger nullable

Gets or sets the id of the BDMS.Models.Workflow.Assignee.

Changes

Changed in 1 of the 25 revisions of this API.9

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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

      response-property-became-required

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