Get risk score data in bulk

GET 
/risk_scores

This endpoint can retrieve risk score data in bulk from Lifecycle

Request

Query Parameters

query object

Allows for pagination and sorting.

object_id uuid

ID of an object for filtering. Used along with object_type

object_type string

Possible values: [Profile, WorkflowSession]

Type of object that object_id represents

overall_risk_level_id uuid

Overall risk level to filter by

impact_risk_level_id uuid

Impact risk level to filter by

probability_risk_level_id uuid

Probability risk level to filter by

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

risk_scores object[]
Array [
id uuid
uid string
Possible values: >= 32 characters and <= 32 characters
object_id uuid
object_type string
Possible values: [Profile, WorkflowSession]
overall_score number
overall_risk_level_id uuid
impact_score number
impact_risk_level_id uuid
probability_score number
probability_risk_level_id uuid
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "risk_scores": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uid": "string",
      "object_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "object_type": "Profile",
      "overall_score": 0,
      "overall_risk_level_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "impact_score": 0,
      "impact_risk_level_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "probability_score": 0,
      "probability_risk_level_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...