Skip to content
Hivelight API Documentation

Get workflow

GET
/workflows/{workflowId}

Fetch details of a specific workflow by ID, including its milestones.

Parameters

Path Parameters

workflowId
required
string

The ID of the workflow.

Responses

200

A single workflow with milestones

object
data
object
type
string
workflow
id
string
UsFdl1Ykuz7NxBy0U5Q3q
attributes
object
name

Name of the workflow

string
POST NOCD WORKFLOW
description

HTML description of the workflow

string
<p>The Workplace Injury Roadmap is used to assist clients in the Common Law phase.</p>
type

Workflow type

string
Allowed values: ROADMAP TASK_LIST 
ROADMAP
types

A list of matter type identifiers this workflow applies to

Array<string>
jurisdictions

A list of jurisdictions this workflow is associated with

Array<string>
[
  "AU",
  "AU-QLD"
]
audience

Visibility scope of the workflow

string
Allowed values: PUBLIC ORGANIZATION WORKSPACE 
WORKSPACE
duration

Total duration of the workflow in milliseconds

integer
28512000000
createdDate

Unix timestamp (ms) when the workflow was created

integer
1772415092623
milestones

Milestones defined in this workflow

Array<object>

A summary of a workflow milestone as embedded in a workflow response

object
milestoneId
string
Af3-y814AI
name
string
NOCD
description

HTML description of the milestone

string
<p>How we progress our client's claim</p>
taskCount

Number of tasks in this milestone

integer
8
dueDate

A date expressed relative to a known anchor point

object
plus

Days to add to the anchor date (used when expressing due dates)

integer
300
minus

Days to subtract from the anchor date (used when expressing target dates)

integer
0
relativeTo

The anchor point this date is relative to

string
Allowed values: ROADMAP_START_DATE MILESTONE_DUE_DATE MILESTONE_TARGET_DATE 
ROADMAP_START_DATE
targetDate

A date expressed relative to a known anchor point

object
plus

Days to add to the anchor date (used when expressing due dates)

integer
300
minus

Days to subtract from the anchor date (used when expressing target dates)

integer
0
relativeTo

The anchor point this date is relative to

string
Allowed values: ROADMAP_START_DATE MILESTONE_DUE_DATE MILESTONE_TARGET_DATE 
ROADMAP_START_DATE
workspaceId
string
Cs8dD1-8CubzojjqvauZH
lastModifiedBy
string
Co0J-Nn3JpjjdD79Dvz-X
lastModifiedDate

Unix timestamp (ms) of last modification

integer
1772417202723
lastModifiedFrom
string
20.5.11.95, 130.176.212.77

403

Forbidden

object
message
string
Forbidden

404

Resource not found

object
message
string
Resource not found

500

Internal Server Error

object
message
string
Internal Server Error