Skip to main content

Get risk score data in bulk

This endpoint can retrieve risk score data in bulk from Lifecycle

Query Parameters
  • query object

    Allows for pagination and sorting using the deepObject notation.


    resource?query[limit]=50&query[offset]=0&query[order]=label


    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    Example: query[limit]=100&query[offset]=50&query[order]=created_at
  • object_id uuid

    ID of an object for filtering. Used along with object_type

    Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
  • object_type string

    Possible values: [Profile, WorkflowSession]

    Type of object that object_id represents

    Example: Profile
  • overall_risk_level_id uuid

    Overall risk level to filter by

  • impact_risk_level_id uuid

    Impact risk level to filter by

    Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
  • probability_risk_level_id uuid

    Probability risk level to filter by

    Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
  • metadata boolean

    Returns batching metadata in the response

    Example: true
Responses

Expected response to a valid request


Schema
  • risk_scores object[]
  • id uuid

    id

  • uid string

    Possible values: >= 32 characters and <= 32 characters

    the uid

  • object_id uuid

    the object id

  • object_type string

    Possible values: [Profile, WorkflowSession]

    the object type

  • overall_score decimal

    Overall score

  • overall_risk_level_id uuid

    the overall risk level id

  • impact_score decimal

    the impact score

  • impact_risk_level_id uuid

    the impact risk level id

  • probability_score decimal

    the probability_score

  • probability_risk_level_id uuid

    The probability risk level id

  • _metadata object
  • limit int32

    The limit

  • offset int32

    The offset

  • total int32

    The total

  • next string

    The link to the next page of data

  • previous string

    The link to the previous page of data

Loading...