subjectivities

Download schema

create_subjectivity

POST

/api/v2/subjectivities/create_subjectivity

Create an XRevisionSubjectivity.

create_subjectivity › Request Body

Request schema for /api/v2/subjectivities/create_subjectivity

request-create_subjectivity

subjectivity_definition_id

string · uuid · required

ID of the subjectivity definition

status

string · enum · required

Status of the subjectivity

Enum values:

Satisfied

Not Satisfied

Waived

Expired

Canceled

revision_id

string · uuid

ID of the revision

external_system_reference

string

Reference to the revision in an external system

due_date

string · date-time

Due date for this subjectivity to be met before

assignee

string · uuid

ID of the assignee

description

string

Description of the subjectivity

statement

string

Statement for the subjectivity. Copied from the subjectivity definition if not provided.

create_subjectivity › Responses

200

Response schema for /api/v2/subjectivities/create_subjectivity

response-create_subjectivity

object · required

Data related to the created subjectivity

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/create_subjectivity

curl --request POST \
  --url /api/v2/subjectivities/create_subjectivity \
  --header 'Content-Type: application/json' \
  --data '
{
  "revision_id": "00000000-0000-0000-0000-000000000000",
  "external_system_reference": "external_system_reference",
  "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
  "status": "Satisfied",
  "due_date": "2024-08-25T15:00:00Z",
  "assignee": "00000000-0000-0000-0000-000000000000",
  "description": "description",
  "statement": "statement"
}
'

Example Request Body

{
  "revision_id": "00000000-0000-0000-0000-000000000000",
  "external_system_reference": "external_system_reference",
  "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
  "status": "Satisfied",
  "due_date": "2024-08-25T15:00:00Z",
  "assignee": "00000000-0000-0000-0000-000000000000",
  "description": "description",
  "statement": "statement"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "revision_id": "00000000-0000-0000-0000-000000000000",
    "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
    "status": "Satisfied",
    "due_date": "2024-08-25T15:00:00Z",
    "assignee": "00000000-0000-0000-0000-000000000000",
    "created_by": "00000000-0000-0000-0000-000000000000",
    "date_created": "2024-08-25T15:00:00Z",
    "updated_by": "00000000-0000-0000-0000-000000000000",
    "date_updated": "2024-08-25T15:00:00Z",
    "description": "description",
    "statement": "statement"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

create_subjectivity_definition

POST

/api/v2/subjectivities/create_subjectivity_definition

Create a subjectivity definition.

create_subjectivity_definition › Request Body

Request schema for /api/v2/subjectivities/create_subjectivity_definition

request-create_subjectivity_definition

name

string · maxLength: 100 · required

Name for the subjectivity definition

mandatory

boolean · required

true for mandatory and false for non-mandatory. Default is false

active

boolean · required

true for active and false for inactive. Default is true

description

string · maxLength: 500

Description for the subjectivity definition

policy_type_id

string · uuid

ID of the associated policy type

due_within_days

integer · min: 0

Days the subjectivity definition is due within

due_date_type

string · enum

Type of due date (e.g., Post Bind, Post Issue)

Enum values:

Pre Bind

Post Bind

Post Issue

statement

string

Statement for the subjectivity definition

create_subjectivity_definition › Responses

200

Response schema for /api/v2/subjectivities/create_subjectivity_definition

response-create_subjectivity_definition

object[] · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/create_subjectivity_definition

curl --request POST \
  --url /api/v2/subjectivities/create_subjectivity_definition \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description",
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "mandatory": true,
  "active": true,
  "due_within_days": 0,
  "due_date_type": "Pre Bind",
  "statement": "statement"
}
'

Example Request Body

{
  "name": "name",
  "description": "description",
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "mandatory": true,
  "active": true,
  "due_within_days": 0,
  "due_date_type": "Pre Bind",
  "statement": "statement"
}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "policy_type_id": "00000000-0000-0000-0000-000000000000",
      "mandatory": true,
      "active": true,
      "due_within_days": 0,
      "due_date_type": "Pre Bind",
      "created_by": "00000000-0000-0000-0000-000000000000",
      "date_created": "2024-08-25T15:00:00Z",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "date_updated": "2024-08-25T15:00:00Z",
      "statement": "statement"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

delete_subjectivity

POST

/api/v2/subjectivities/delete_subjectivity

Delete a revision subjectivity.

delete_subjectivity › Request Body

Request schema for /api/v2/subjectivities/delete_subjectivity

request-delete_subjectivity

id

string · uuid · required

ID of the subjectivity to delete

delete_subjectivity › Responses

200

Response schema for /api/v2/subjectivities/delete_subjectivity

response-delete_subjectivity

array · required

Empty array returned when the request is successful.

success

boolean · required

Indicates if the request was successful

required

filter_subjectivities

POST

/api/v2/subjectivities/filter_subjectivities

Filter subjectivities.

filter_subjectivities › Request Body

Request schema for /api/v2/subjectivities/filter_subjectivities

request-filter_subjectivities

start_date

string · date

Start date of the date range to filter subjectivities by

end_date

string · date

End date of the date range to filter subjectivities by

revision_ids

string[]

IDs of the revisions to retrieve subjectivities from

external_system_references

string[]

External system references to filter subjectivities by

assignee_ids

string[]

IDs of the assignees to filter subjectivities by

page

integer

Page number

page_size

integer

Number of items per page

filter_subjectivities › Responses

200

Response schema for /api/v2/subjectivities/filter_subjectivities

response-filter_subjectivities

object[] · required

Array of existing subjectivities that match the filter criteria

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/filter_subjectivities

curl --request POST \
  --url /api/v2/subjectivities/filter_subjectivities \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2024-08-25",
  "end_date": "2024-08-25",
  "revision_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "external_system_references": [
    "string"
  ],
  "assignee_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "page": 0,
  "page_size": 0
}
'

Example Request Body

{
  "start_date": "2024-08-25",
  "end_date": "2024-08-25",
  "revision_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "external_system_references": [
    "string"
  ],
  "assignee_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "page": 0,
  "page_size": 0
}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "revision_id": "00000000-0000-0000-0000-000000000000",
      "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
      "subjectivity_definition": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "description": "description",
        "policy_type_id": "00000000-0000-0000-0000-000000000000",
        "policy_type_name": "policy_type_name",
        "mandatory": true,
        "active": true,
        "due_within_days": 0,
        "due_date_type": "due_date_type",
        "statement": "statement",
        "expiration_action": "expiration_action",
        "created_by": "00000000-0000-0000-0000-000000000000",
        "updated_by": "00000000-0000-0000-0000-000000000000",
        "date_created": "2024-08-25T15:00:00Z",
        "date_updated": "2024-08-25T15:00:00Z"
      },
      "status": "Satisfied",
      "due_date": "2024-08-25T15:00:00Z",
      "assignee": "00000000-0000-0000-0000-000000000000",
      "created_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "date_created": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z",
      "statement": "statement",
      "description": "description"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_subjectivities

POST

/api/v2/subjectivities/list_subjectivities

Retrieve list of revision subjectivities.

list_subjectivities › Request Body

Request schema for /api/v2/subjectivities/list_subjectivities

request-list_subjectivities

revision_id

string · uuid

ID of the revision to retrieve subjectivities from

external_system_reference

string

Reference to the revision in an external system

list_subjectivities › Responses

200

Response schema for /api/v2/subjectivities/list_subjectivities

response-list_subjectivities

object[] · required

Array of existing subjectivities

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/list_subjectivities

curl --request POST \
  --url /api/v2/subjectivities/list_subjectivities \
  --header 'Content-Type: application/json' \
  --data '
{
  "revision_id": "00000000-0000-0000-0000-000000000000",
  "external_system_reference": "external_system_reference"
}
'

Example Request Body

{
  "revision_id": "00000000-0000-0000-0000-000000000000",
  "external_system_reference": "external_system_reference"
}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "revision_id": "00000000-0000-0000-0000-000000000000",
      "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
      "subjectivity_definition": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "description": "description",
        "policy_type_id": "00000000-0000-0000-0000-000000000000",
        "policy_type_name": "policy_type_name",
        "mandatory": true,
        "active": true,
        "due_within_days": 0,
        "due_date_type": "due_date_type",
        "statement": "statement",
        "expiration_action": "expiration_action",
        "created_by": "00000000-0000-0000-0000-000000000000",
        "updated_by": "00000000-0000-0000-0000-000000000000",
        "date_created": "2024-08-25T15:00:00Z",
        "date_updated": "2024-08-25T15:00:00Z"
      },
      "status": "Satisfied",
      "due_date": "2024-08-25T15:00:00Z",
      "assignee": "00000000-0000-0000-0000-000000000000",
      "created_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "date_created": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z",
      "statement": "statement",
      "description": "description"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_subjectivity_definitions

POST

/api/v2/subjectivities/list_subjectivity_definitions

Retrieve list of subjectivity definitions.

list_subjectivity_definitions › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	No specific criteria
	No specific criteria

Properties for Variant 1:

active

boolean

Filter subjectivity definitions by active status

list_subjectivity_definitions › Responses

200

Response schema for /api/v2/subjectivities/list_subjectivity_definitions

response-list_subjectivity_definitions

object[] · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/list_subjectivity_definitions

curl --request POST \
  --url /api/v2/subjectivities/list_subjectivity_definitions \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "policy_type_id": "00000000-0000-0000-0000-000000000000",
      "mandatory": true,
      "active": true,
      "due_within_days": 0,
      "due_date_type": "Pre Bind",
      "created_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "date_created": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

modify_subjectivity

POST

/api/v2/subjectivities/modify_subjectivity

Modify a revision subjectivity.

modify_subjectivity › Request Body

Request schema for /api/v2/subjectivities/modify_subjectivity

request-modify_subjectivity

id

string · uuid · required

ID of the revision subjectivity

status

string · enum

Status of the subjectivity

Enum values:

Satisfied

Not Satisfied

Waived

Expired

Canceled

due_date

string · date-time

Due date for this subjectivity to be met before

assignee

string · uuid

ID of the assignee

description

string

Description of the subjectivity

statement

string

Statement for the subjectivity.

modify_subjectivity › Responses

200

Response schema for /api/v2/subjectivities/modify_subjectivity

response-modify_subjectivity

object · required

Data related to the updated subjectivity

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/modify_subjectivity

curl --request POST \
  --url /api/v2/subjectivities/modify_subjectivity \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Satisfied",
  "due_date": "2024-08-25T15:00:00Z",
  "assignee": "00000000-0000-0000-0000-000000000000",
  "description": "description",
  "statement": "statement"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Satisfied",
  "due_date": "2024-08-25T15:00:00Z",
  "assignee": "00000000-0000-0000-0000-000000000000",
  "description": "description",
  "statement": "statement"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "revision_id": "00000000-0000-0000-0000-000000000000",
    "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
    "status": "Satisfied",
    "due_date": "2024-08-25T15:00:00Z",
    "assignee": "00000000-0000-0000-0000-000000000000",
    "created_by": "00000000-0000-0000-0000-000000000000",
    "updated_by": "00000000-0000-0000-0000-000000000000",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z",
    "description": "description",
    "statement": "statement"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

modify_subjectivity_definition

POST

/api/v2/subjectivities/modify_subjectivity_definition

Modify a subjectivity definition.

modify_subjectivity_definition › Request Body

Request schema for /api/v2/subjectivities/modify_subjectivity_definition

request-modify_subjectivity_definition

id

string · uuid · required

ID of the subjectivity to be Modified

name

string · maxLength: 100

Name for the subjectivity definition

description

string · maxLength: 500

Description for the subjectivity definition

policy_type_id

string · uuid

ID of the associated policy type

mandatory

boolean

true for mandatory and false for non-mandatory. Default is false

active

boolean

true for active and false for inactive. Default is true

due_within_days

integer · min: 0

Days the subjectivity is due within

due_date_type

string · enum

Type of due date (e.g., 'Post Bind' or 'Post Issue')

Enum values:

Pre Bind

Post Bind

Post Issue

statement

string

Statement for the subjectivity definition

modify_subjectivity_definition › Responses

200

Response schema for /api/v2/subjectivities/modify_subjectivity_definition

response-modify_subjectivity_definition

object · required

required

POST/api/v2/subjectivities/modify_subjectivity_definition

curl --request POST \
  --url /api/v2/subjectivities/modify_subjectivity_definition \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "mandatory": true,
  "active": true,
  "due_within_days": 0,
  "due_date_type": "Pre Bind",
  "statement": "statement"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "mandatory": true,
  "active": true,
  "due_within_days": 0,
  "due_date_type": "Pre Bind",
  "statement": "statement"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "policy_type_id": "00000000-0000-0000-0000-000000000000",
    "mandatory": true,
    "active": true,
    "due_within_days": 0,
    "due_date_type": "Pre Bind",
    "created_by": "00000000-0000-0000-0000-000000000000",
    "updated_by": "00000000-0000-0000-0000-000000000000",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z",
    "success": true,
    "statement": "statement"
  },
  "messages": [
    "string"
  ]
}

json

application/json

retrieve_subjectivity

POST

/api/v2/subjectivities/retrieve_subjectivity

Retrieve revision subjectivity by ID.

retrieve_subjectivity › Request Body

Request schema for /api/v2/subjectivities/retrieve_subjectivity

request-retrieve_subjectivity

id

string · uuid · required

ID of the subjectivity to retrieve

retrieve_subjectivity › Responses

200

Response schema for /api/v2/subjectivities/retrieve_subjectivity

response-retrieve_subjectivity

object · required

Details of the retrieved subjectivity

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/retrieve_subjectivity

curl --request POST \
  --url /api/v2/subjectivities/retrieve_subjectivity \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "revision_id": "00000000-0000-0000-0000-000000000000",
    "subjectivity_definition_id": "00000000-0000-0000-0000-000000000000",
    "status": "Satisfied",
    "due_date": "2024-08-25T15:00:00Z",
    "assignee": "00000000-0000-0000-0000-000000000000",
    "created_by": "00000000-0000-0000-0000-000000000000",
    "updated_by": "00000000-0000-0000-0000-000000000000",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z",
    "statement": "statement",
    "description": "description"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

retrieve_subjectivity_definition

POST

/api/v2/subjectivities/retrieve_subjectivity_definition

Retrieve subjectivity definition by ID.

retrieve_subjectivity_definition › Request Body

Request schema for /api/v2/subjectivities/retrieve_subjectivity_definition

request-retrieve_subjectivity_definition

id

string · uuid · required

ID of the subjectivity definition to be retrieved

retrieve_subjectivity_definition › Responses

200

Response schema for /api/v2/subjectivities/retrieve_subjectivity_definition

response-retrieve_subjectivity_definition

object · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/subjectivities/retrieve_subjectivity_definition

curl --request POST \
  --url /api/v2/subjectivities/retrieve_subjectivity_definition \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "policy_type_id": "00000000-0000-0000-0000-000000000000",
    "policy_type_name": "policy_type_name",
    "mandatory": true,
    "active": true,
    "due_within_days": 0,
    "due_date_type": "Pre Bind",
    "created_by": "00000000-0000-0000-0000-000000000000",
    "updated_by": "00000000-0000-0000-0000-000000000000",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

retrieve_subjectivity_provenance

POST

/api/v2/subjectivities/retrieve_subjectivity_provenance

Retrieve rule-execution provenance rows for a revision subjectivity.

retrieve_subjectivity_provenance › Request Body

Request payload for /api/v2/subjectivities/retrieve_subjectivity_provenance

request-retrieve_subjectivity_provenance

id

string · uuid · required

The id of the revision subjectivity whose rule-execution lineage to retrieve.

retrieve_subjectivity_provenance › Responses

200

Response payload for /api/v2/subjectivities/retrieve_subjectivity_provenance. Returns null when the subjectivity was not created by a rule effect.

response-retrieve_subjectivity_provenance

required

success

boolean · required

required

POST/api/v2/subjectivities/retrieve_subjectivity_provenance

curl --request POST \
  --url /api/v2/subjectivities/retrieve_subjectivity_provenance \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "success": true,
  "data": {
    "run_id": "00000000-0000-0000-0000-000000000000",
    "module": "events",
    "trigger_source": "trigger_source",
    "run_status": "running",
    "run_started_at": "2024-08-25T15:00:00Z",
    "run_completed_at": "2024-08-25T15:00:00Z",
    "underwriting_rule_id": "00000000-0000-0000-0000-000000000000",
    "rule_name": "rule_name",
    "matched": true,
    "skipped_reason": "skipped_reason",
    "rule_error_details": "rule_error_details",
    "scope": "scope",
    "scope_ref_id": "00000000-0000-0000-0000-000000000000",
    "underwriting_rule_effect_id": "00000000-0000-0000-0000-000000000000",
    "effect_action": "effect_action",
    "effect_applied": true,
    "effect_error_details": "effect_error_details",
    "payload_snapshot": {},
    "artifact_type": "task",
    "artifact_id": "00000000-0000-0000-0000-000000000000",
    "artifact_operation": "created"
  }
}

json

application/json

statement_of_value summaries