Contained Items Management

Contained Items Management provides functionality to manage items associated with opportunities, such as documents, notes, or forms. This service enables CRUD (Create, Read, Update, Delete) operations for contained items, as well as adding existing documents and retrieving items by opportunity ID.

Contained Items Operations

Contained Items Operations provide comprehensive management of items linked to opportunities, including creation, retrieval, updates, and deletion.

Contained Items Operations - Create Contained Item `POST` /v1/api/contained_items

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

Parameters

Parameter	Description	Required	Type	Default Value
item_type	Type of the contained item (e.g., notes, form, document). Enum: ["notes", "form", "document"]	No	String	"document"
source	Source of the contained item	Yes	String	N/A
opportunity_id	ID of the opportunity this item is associated with	Yes	String	N/A
document_name	Name of the document (if applicable)	No	String	N/A
uploaded_user	User who uploaded the item	Yes	String	N/A
comments	Additional comments about the item	No	String or Null	Null
document_status	Status of the document (if applicable)	No	String or Null	Null
document_collection	Collection the document belongs to (if applicable)	No	String or Null	Null
expire_datetime	Date and time when the item expires	Yes	String (date-time)	2025-04-07T04:38:43.537Z
meta_data	Metadata associated with the item	Yes	String	N/A
version	Version of the item (if applicable)	No	String or Null	Null
file	File content to upload (binary data)	No	Binary or Null	Null
session_id	Session ID for the upload	No	Integer or Null	3.007808405211056e+37

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/contained_items' \
-H 'accept: application/json' \
-F 'item_type=document' \
-F 'source=internal' \
-F 'opportunity_id=12345' \
-F 'document_name=contract.pdf' \
-F 'uploaded_user=john.doe' \
-F 'expire_datetime=2025-12-31T23:59:59Z' \
-F 'meta_data={"type": "contract"}' \
-F '[email protected]'

Example Response

{
    "is_error": false,
    "message": "Contained item created successfully",
    "results": {
        "contained_item_id": "67890",
        "item_type": "document",
        "opportunity_id": "12345",
        "document_name": "contract.pdf"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Read Contained Items `GET` /v1/api/contained_items

Resource URL	/v1/api/contained_items
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/contained_items?page_no=1&page_size=10' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Contained items retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 2,
    "total": 15,
    "results": [
        {
            "item_type": "document",
            "document_name": "Example Corporation",
            "uploaded_user": "[email protected]",
            "document_status": "default",
            "document_collection": "DEFAULT",
            "comments": null,
            "source": "[email protected]",
            "opportunity_id": "681f1dc6-51eb-41d9-9e74-e21c560fa4f9",
            "document_url": "https://braegen.ai/v1/api/dm/download/38f8be70-c0bb-43fe-a371-eb667e3e10c7/1.0",
            "document_format": ".pdf",
            "document_id": "38f8be70-c0bb-43fe-a371-eb667e3e10c7",
            "version": "1.0",
            "expire_datetime": null,
            "id": "d2b6ec25-4e96-42fb-bc59-4333c54d5d78",
            "created_at": "2025-01-31T05:17:38.736000",
            "updated_at": "2025-01-31T05:17:38.736000"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Add Existing Document `POST` /v1/api/contained_items/add_existing_document/upload

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

Parameters

Parameter	Description	Required	Type	Default Value
source	Source of the existing document	Yes	String	N/A
opportunity_id	ID of the opportunity this document is associated with	Yes	String	N/A
document_id	ID of the existing document to be added	Yes	String	N/A
comments	Additional comments about the document	No	String or Null	Null

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/contained_items/add_existing_document/upload' \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'source=external&opportunity_id=12345&document_id=doc789&comments=Added existing contract'

Example Response

{
    "is_error": false,
    "message": "Existing document added successfully",
    "results": {
        "contained_item_id": "67891",
        "opportunity_id": "12345",
        "document_id": "doc789"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Read Contained Item `GET` /v1/api/contained_items/{contained_item_id}

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

Parameters

Parameter	Description
contained_item_id	Path parameter: ID of the contained item to retrieve

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/contained_items/67890' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Contained item retrieved successfully",
    "results": {
        "contained_item_id": "67890",
        "item_type": "document",
        "opportunity_id": "12345",
        "document_name": "contract.pdf"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Update Contained Item `PATCH` /v1/api/contained_items/{contained_item_id}

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

Parameters

Parameter	Description
contained_item_id	Path parameter: ID of the contained item to update
Input JSON	Updated contained item details (request body). See ContainedItemUpdate schema.

Example Request

curl -X 'PATCH' \
'https://braegen.ai/v1/api/contained_items/67890' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "comments": "Updated comments for the contract"
}'

Example Response

{
    "is_error": false,
    "message": "Contained item updated successfully",
    "results": {
        "contained_item_id": "67890",
        "comments": "Updated comments for the contract"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Delete Contained Item `DELETE` /v1/api/contained_items/{contained_item_id}

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

Parameters

Parameter	Description
contained_item_id	Path parameter: ID of the contained item to delete

Example Request

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

Example Response

{
    "is_error": false,
    "message": "Contained item deleted successfully",
    "results": null
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Operations - Get All Contained Items by Opportunity ID `GET` /v1/api/contained_items/opportunity/{opportunity_id}

Resource URL	/v1/api/contained_items/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
item_type	Query parameter (optional): Filter by item type
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/contained_items/opportunity/12345?page_no=1&page_size=10&item_type=document' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Contained items retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 1,
    "total": 2,
    "results": [
        {
            "contained_item_id": "67890",
            "item_type": "document",
            "opportunity_id": "12345",
            "document_name": "contract.pdf"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Contained Items Management

Contained Items Operations

Contained Items Operations - Create Contained Item POST /v1/api/contained_items

HTTP Responses

Contained Items Operations - Read Contained Items GET /v1/api/contained_items

HTTP Responses

Contained Items Operations - Add Existing Document POST /v1/api/contained_items/add_existing_document/upload

HTTP Responses

Contained Items Operations - Read Contained Item GET /v1/api/contained_items/{contained_item_id}

HTTP Responses

Contained Items Operations - Update Contained Item PATCH /v1/api/contained_items/{contained_item_id}

HTTP Responses

Contained Items Operations - Delete Contained Item DELETE /v1/api/contained_items/{contained_item_id}

HTTP Responses

Contained Items Operations - Get All Contained Items by Opportunity ID GET /v1/api/contained_items/opportunity/{opportunity_id}

HTTP Responses

On this page

Contained Items Operations - Create Contained Item `POST` /v1/api/contained_items

Contained Items Operations - Read Contained Items `GET` /v1/api/contained_items

Contained Items Operations - Add Existing Document `POST` /v1/api/contained_items/add_existing_document/upload

Contained Items Operations - Read Contained Item `GET` /v1/api/contained_items/{contained_item_id}

Contained Items Operations - Update Contained Item `PATCH` /v1/api/contained_items/{contained_item_id}

Contained Items Operations - Delete Contained Item `DELETE` /v1/api/contained_items/{contained_item_id}

Contained Items Operations - Get All Contained Items by Opportunity ID `GET` /v1/api/contained_items/opportunity/{opportunity_id}