API ReferenceRisk
Retrieves the collection of Risk resources
Retrieves the collection of Risk resources
Authorization
apiKey Authorization<token>
Value for the Authorization header parameter.
In: header
Query Parameters
page?integer
The collection page number
Default
1itemsPerPage?integer
The number of items per page
Range
0 <= value <= 100Default
30search?string
project?string
project[]?array<string>
stage?string
stage[]?array<string>
board?string
board[]?array<string>
task?string
task[]?array<string>
projectUser?string
projectUser[]?array<string>
type?string
type[]?array<string>
impact?string
impact[]?array<string>
probability?integer
probability[]?array<integer>
order[name]?string
Default
"asc"Value in
- "asc"
- "desc"
order[date]?string
Default
"asc"Value in
- "asc"
- "desc"
order[createdAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[updatedAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[probability]?string
Default
"asc"Value in
- "asc"
- "desc"
date[before]?string
date[strictly_before]?string
date[after]?string
date[strictly_after]?string
Response Body
curl -X GET "https://example.com/project/risks"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "probability": 0, "date": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "projectUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "shortCode": "string", "firstName": "string", "lastName": "string", "email": "string", "phoneNumber": "string", "pictureSm": "string", "pictureLg": "string" }, "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2", "projectName": "string", "projectShortCode": "string", "projectIsSimple": true, "stage": "9f09bdb0-89bd-4a1a-b468-0312474f1023", "stageName": "string", "board": "a98884d6-3c76-4114-ba9c-216527a5aac1", "boardName": "string", "boardShortCode": "string", "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c", "taskName": "string", "taskShortCode": "string", "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e", "typeName": "string", "impact": "4f76d8c5-a77a-40a5-b154-4cb5b989b7aa", "impactName": "string" }]