Subjectivities Module API

API reference for subjectivity workflow endpoints.

BriteCore V2 subjectivities API endpoint wrappers.

britecore_sdk.api.api_calls.v2.subjectivities.create_subjectivity(status=None, due_date=None, external_system_reference=None, description=None, assignee=None, subjectivity_definition_id=None, statement=None, revision_id=None, **kwargs)[source]

Create Subjectivity.

POST /api/v2/subjectivities/create_subjectivity

Parameters:

  • status (str | None)

  • due_date (str | None)

  • external_system_reference (str | None)

  • description (str | None)

  • assignee (str | None)

  • subjectivity_definition_id (str | None)

  • statement (str | None)

  • revision_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.create_subjectivity_definition(due_date_type=None, mandatory=None, name=None, statement=None, active=None, policy_type_id=None, due_within_days=None, description=None, **kwargs)[source]

Create Subjectivity Definition.

POST /api/v2/subjectivities/create_subjectivity_definition

Parameters:

  • due_date_type (str | None)

  • mandatory (bool | None)

  • name (str | None)

  • statement (str | None)

  • active (bool | None)

  • policy_type_id (str | None)

  • due_within_days (int | None)

  • description (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.delete_subjectivity(id=None, **kwargs)[source]

Delete Subjectivity.

POST /api/v2/subjectivities/delete_subjectivity

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.filter_subjectivities(end_date=None, revision_ids=None, assignee_ids=None, page=None, page_size=None, start_date=None, external_system_references=None, **kwargs)[source]

Filter Subjectivities.

POST /api/v2/subjectivities/filter_subjectivities

Parameters:

  • end_date (str | None)

  • revision_ids (list[str] | None)

  • assignee_ids (list[str] | None)

  • page (int | None)

  • page_size (int | None)

  • start_date (str | None)

  • external_system_references (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.list_subjectivities(revision_id=None, external_system_reference=None, **kwargs)[source]

List Subjectivities.

POST /api/v2/subjectivities/list_subjectivities

Parameters:

  • revision_id (str | None)

  • external_system_reference (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.list_subjectivity_definitions(**kwargs)[source]

List Subjectivity Definitions.

POST /api/v2/subjectivities/list_subjectivity_definitions

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.modify_subjectivity(status=None, due_date=None, description=None, assignee=None, statement=None, id=None, **kwargs)[source]

Modify Subjectivity.

POST /api/v2/subjectivities/modify_subjectivity

Parameters:

  • status (str | None)

  • due_date (str | None)

  • description (str | None)

  • assignee (str | None)

  • statement (str | None)

  • id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.modify_subjectivity_definition(due_date_type=None, mandatory=None, description=None, due_within_days=None, statement=None, active=None, policy_type_id=None, id=None, name=None, **kwargs)[source]

Modify Subjectivity Definition.

POST /api/v2/subjectivities/modify_subjectivity_definition

Parameters:

  • due_date_type (str | None)

  • mandatory (bool | None)

  • description (str | None)

  • due_within_days (int | None)

  • statement (str | None)

  • active (bool | None)

  • policy_type_id (str | None)

  • id (str | None)

  • name (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.retrieve_subjectivity(id=None, **kwargs)[source]

Retrieve Subjectivity.

POST /api/v2/subjectivities/retrieve_subjectivity

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.subjectivities.retrieve_subjectivity_definition(id=None, **kwargs)[source]

Retrieve Subjectivity Definition.

POST /api/v2/subjectivities/retrieve_subjectivity_definition

Parameters:
Return type:

Any