Skip to content

Apply a workflow to a matter

POST
/matters/{matterId}/apply/{workflowId}

Parameters

Path Parameters

matterId
required
string
workflowId
required
string

Request Body

object
meta
object
startDate

An integer representing milliseconds since the Unix epoch

integer format: int64

Responses

200

Matter archived

object
data
object
type
string
id
string
attributes
object
name

Name of the matter

string
description

Description of the matter

string
external-reference
object
id

External reference for the matter

string
source

Source of the external reference

string
types

A list of matter type identifiers for this matter

Array<string>
jurisdictions
Array<string>
roles

A list of roles and users associated with the matter

If no OWNER is specified, the current user will be set as the matter owner

object
OWNER

Matter owner (limited to one user)

Array<string>
LEAD

Matter lead (limited to one user)

Array<string>
BUSINESS_1

Business Administrators of the matter

Array<string>
ADVOCATE_1

Advocates (or Barristers) of the matter

Array<string>
CONSULTANT_1

Consultants of the matter

Array<string>
LEGAL_1

Senior Lawyers of the matter

Array<string>
LEGAL_2

Junior Lawyers of the matter

Array<string>
LEGAL_3

Law Clerks or Paralegals of the matter

Array<string>
ADMINISTRATIVE_1

Senior Legal Assistants of the matter

Array<string>
ADMINISTRATIVE_2

Junior Legal Assistants of the matter

Array<string>
relationships
object
milestones
object
data
Array<object>
object
type
string
id
string
included
Array<object>
object
type
string
id
string
attributes
object
name

Name of the milestone

string
description

Description of the milestone

string
status

Status of the milestone

string
Allowed values: NOTSTARTED INPROGRESS DONE
created-date

An integer representing milliseconds since the Unix epoch

integer format: int64
due-date

An integer representing milliseconds since the Unix epoch

integer format: int64
target-date

An integer representing milliseconds since the Unix epoch

integer format: int64
total-tasks

Total number of tasks in the milestone

integer
completed-tasks

Number of completed tasks in the milestone

integer
pending-tasks

Number of pending tasks in the milestone

integer