Related Entities Management

Related Entities Management provides functionality to manage entities related to opportunities, such as claimants, defendants, or witnesses. This service enables CRUD (Create, Read, Update, Delete) operations for related entities, as well as retrieving summaries and entities by opportunity ID.

Related Entities Operations provide comprehensive management of entities associated with opportunities, including creation, retrieval, updates, and deletion.

Related Entities Operations - Create Related Entity `POST` /v1/api/related_entities

Resource URL	/v1/api/related_entities
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required	Type	Default Value
entity_type	Type of the entity (e.g., person, organization). Enum: ["person", "organization"]	Yes	String	N/A
role	Role of the entity in relation to the opportunity (e.g., Claimant, Defendant)	Yes	String	N/A
entity_name	Name of the entity	Yes	String	N/A
email	Email address of the entity	No	String or Null	Null
entity_meta_data	Metadata associated with the entity	No	String or Null	Null
comment	Additional comments about the entity	No	String or Null	Null
opportunity_id	ID of the opportunity this entity is associated with	Yes	String	N/A
entity_details	Additional details about the entity	No	String or Null	Null
cooperate_structure	Corporate structure details (if applicable)	No	String or Null	Null

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/related_entities' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "entity_type": "person",
    "role": "Claimant",
    "entity_name": "John Doe",
    "email": "[email protected]",
    "entity_meta_data": {"age": 35},
    "comment": "Primary claimant",
    "opportunity_id": "12345",
    "entity_details": {"phone": "123-456-7890"},
    "cooperate_structure": {"department": "Legal"}
}'

Example Response

{
    "is_error": false,
    "message": "Related entity created successfully",
    "results": {
        "related_entity_id": "98765",
        "entity_name": "John Doe",
        "role": "Claimant",
        "opportunity_id": "12345"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Related Entities Operations - Get Related Entities List `GET` /v1/api/related_entities

Resource URL	/v1/api/related_entities
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
page_no	Query parameter (optional): Page number. Default: 1
page_size	Query parameter (optional): Items per page. Default: 10, Max: 100

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/related_entities?page_no=1&page_size=10' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Related entities retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 2,
    "total": 15,
    "results": [
        {
            "related_entity_id": "98765",
            "entity_name": "John Doe",
            "role": "Claimant",
            "opportunity_id": "12345"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Parameter	Description	Required	Type	Default Value
related_entity_id	ID of the related entity to retrieve	Yes	String	N/A

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Related Entities Operations - Get Related Entities List Summary `GET` /v1/api/related_entities/summery

Resource URL	/v1/api/related_entities/summery
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
page_no	Query parameter (optional): Page number. Default: 1
page_size	Query parameter (optional): Items per page. Default: 10, Max: 100

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/related_entities/summery?page_no=1&page_size=10' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Related entities summary retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 2,
    "total": 15,
    "results": [
         {
            "opportunity_id": "123123123-d234234",
            "defendant_email": "[email protected]",
            "claimant_email": "[email protected]",
            "defendant_entity_type": "organization",
            "claimant_entity_type": "person"
    }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Related Entities Operations - Update Related Entity `PATCH` /v1/api/related_entities/{related_entity_id}

Resource URL	/v1/api/contained_items
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
related_entity_id	Path parameter: ID of the related entity to update
Input JSON	Updated related entity details (request body). See RelatedEntityUpdate schema.

Example Request

curl -X 'PATCH' \
'https://braegen.ai/v1/api/related_entities/98765' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "entity_name": "John Doe Updated",
    "comment": "Updated claimant details"
}'

Example Response

{
    "is_error": false,
    "message": "Related entity updated successfully",
    "results": {
        "related_entity_id": "98765",
        "entity_name": "John Doe Updated",
        "comment": "Updated claimant details"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Related Entities Operations - Delete Related Entity `DELETE` /v1/api/related_entities/{related_entity_id}

Resource URL	/v1/api/related_entities/{related_entity_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
related_entity_id	Path parameter: ID of the related entity to delete

Example Request

curl -X 'DELETE' \
'https://braegen.ai/v1/api/related_entities/98765' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Related entity deleted successfully",
    "results": null
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Related Entities Operations - Get Related Entities by Opportunity ID `GET` /v1/api/related_entities/opportunity/{opportunity_id}

Resource URL	/v1/api/related_entities/opportunity/{opportunity_id}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description
opportunity_id	Path parameter: ID of the opportunity
page_no	Query parameter (optional): Page number. Default: 1
page_size	Query parameter (optional): Items per page. Default: 10, Max: 100

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/related_entities/opportunity/12345?page_no=1&page_size=10' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Related entities retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 1,
    "total": 2,
    "results": [
        {
            "related_entity_id": "98765",
            "entity_name": "John Doe",
            "role": "Claimant",
            "opportunity_id": "12345"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Parameters

Parameter	Description
opportunity_id	Path parameter: ID of the opportunity
page_no	Query parameter (optional): Page number. Default: 1
page_size	Query parameter (optional): Items per page. Default: 10, Max: 100

Related Entities Management

Related Entities Operations

Related Entities Operations - Create Related Entity POST /v1/api/related_entities

HTTP Responses

Related Entities Operations - Get Related Entities List GET /v1/api/related_entities

HTTP Responses

Related Entities Operations - Read Related Entity GET /v1/api/related_entities/id/{related_entity_id}

HTTP Responses

Related Entities Operations - Get Related Entities List Summary GET /v1/api/related_entities/summery

HTTP Responses

Related Entities Operations - Update Related Entity PATCH /v1/api/related_entities/{related_entity_id}

HTTP Responses

Related Entities Operations - Delete Related Entity DELETE /v1/api/related_entities/{related_entity_id}

HTTP Responses

Related Entities Operations - Get Related Entities by Opportunity ID GET /v1/api/related_entities/opportunity/{opportunity_id}

HTTP Responses

On this page

Related Entities Operations - Create Related Entity `POST` /v1/api/related_entities

Related Entities Operations - Get Related Entities List `GET` /v1/api/related_entities

Related Entities Operations - Read Related Entity `GET` /v1/api/related_entities/id/{related_entity_id}

Related Entities Operations - Get Related Entities List Summary `GET` /v1/api/related_entities/summery

Related Entities Operations - Update Related Entity `PATCH` /v1/api/related_entities/{related_entity_id}

Related Entities Operations - Delete Related Entity `DELETE` /v1/api/related_entities/{related_entity_id}

Related Entities Operations - Get Related Entities by Opportunity ID `GET` /v1/api/related_entities/opportunity/{opportunity_id}