Back to TeamworkGet all risks
Return all risks for the provided filters. Only filters that the logged-in user
has access will be returned.
Input
type: object
properties:
parameters:
type: object
properties:
updatedAfterDate:
type: string
format: date-time
description: >-
filter by risks updated after specified date (deprecated, use
updatedAfter)
updatedAfter:
type: string
format: date-time
description: filter by risks updated after specified date
sortOrder:
type: string
enum:
- asc
- desc
description: sort order (deprecated, use orderMode)
sort:
type: string
enum:
- datecreated
- source
- probability
- impact
- result
- project
description: sort by (deprecated, use orderBy)
searchTerm:
type: string
description: search term
reportFormat:
type: string
default: pdf
description: define the format of the report
orderMode:
type: string
enum:
- asc
- desc
description: sort order
orderBy:
type: string
enum:
- datecreated
- source
- probability
- impact
- result
- project
description: sort by
probabilityTo:
type: integer
description: filter by probability
probabilityFrom:
type: integer
description: filter by probability
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
impactTo:
type: integer
description: filter by impact
impactFrom:
type: integer
description: filter by impact
showDeleted:
type: boolean
default: 'false'
description: include deleted items
onlyStarredProjects:
type: boolean
default: 'false'
description: filter by starred projects only
matchAllProjectTags:
type: boolean
description: enforce all tag ids must be matched
isReportDownload:
type: boolean
description: generate a report document
includeArchivedProjects:
type: boolean
description: include archived projects
impactSchedule:
type: boolean
description: filter by risks that impact schedule
impactPerformance:
type: boolean
description: filter by risks that impact performance
impactCost:
type: boolean
description: filter by risks that impact cost
statuses:
type: array
items:
enum:
- new
- pending
- closed
type: string
description: filter by risk statuses
projectTagIds:
type: array
items:
type: integer
description: filter by project tag ids
projectStatuses:
type: array
items:
type: string
description: list of project statuses
projectOwnerIds:
type: array
items:
type: integer
description: filter by project owner ids
projectIds:
type: array
items:
type: integer
description: filter by project ids
projectHealths:
type: array
items:
type: integer
description: list of project health
projectCompanyIds:
type: array
items:
type: integer
description: filter by company ids
projectCategoryIds:
type: array
items:
type: integer
description: filter by project category ids
include:
type: array
items:
enum:
- projects
- users
- projects.companies
type: string
description: include
ids:
type: array
items:
type: integer
description: filter by specific ids
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[risks]:
type: array
items:
enum:
- id
- source
- probability
- probabilityValue
- impact
- impactValue
- impactCost
- impactSchedule
- impactPerformance
- createdOn
- createdByUserId
- lastChangedOn
- lastChangedByUserId
- result
- mitigationPlan
- stats
- projectId
- deleted
- canEdit
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
title: Parameters
Output
type: object
title: RisksResponse
properties:
included:
type: object
properties:
companies:
type: object
projects:
type: object
users:
type: object
meta:
type: object
title: Meta
properties:
averageSpend:
type: integer
limit:
type: integer
nextCursor:
type: string
page:
type: object
title: MetaPage
properties:
count:
type: integer
hasMore:
type: boolean
pageOffset:
type: integer
pageSize:
type: integer
prevCursor:
type: string
totalCapacity:
type: integer
risks:
type: array
items:
type: object
title: Risk
properties:
canEdit:
type: boolean
createdAt:
type: string
createdBy:
type: integer
createdByUserId:
type: integer
createdOn:
type: string
deleted:
type: boolean
id:
type: integer
impact:
type: string
impactCost:
type: boolean
impactPerformance:
type: boolean
impactSchedule:
type: boolean
impactValue:
type: integer
lastChangedByUserId:
type: integer
lastChangedOn:
type: string
mitigationPlan:
type: string
probability:
type: string
probabilityValue:
type: integer
project:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectId:
type: integer
result:
type: integer
source:
type: string
status:
type: string
updatedAt:
type: string
updatedBy:
type: integer