> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Add file to a concept commercial rent contract
> Uploads a file and links it to the concept commercial rent contract.
## OpenAPI
````json POST /api/v1/contracts/conceptcommercialrent/files
{
"openapi": "3.0.4",
"info": {
"title": "Concept SalesContracts V1",
"description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "CommercialRentContracts"
},
{
"name": "Concept CommercialRent"
},
{
"name": "Concept PrivateRent"
},
{
"name": "GeneralSalesContracts"
},
{
"name": "Metadata"
},
{
"name": "PrivateRentContracts"
},
{
"name": "SupplierContracts"
}
],
"paths": {
"/api/v1/contracts/conceptcommercialrent/files": {
"post": {
"tags": [
"Concept CommercialRent"
],
"summary": "Add file to a concept commercial rent contract",
"description": "Uploads a file and links it to the concept commercial rent contract.",
"operationId": "AddFileToConceptCommercialRentContract",
"parameters": [
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"File": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"File": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "The file was created"
},
"400": {
"description": "No file was uploaded"
},
"404": {
"description": "There was a problem attaching the file to the contract",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "Add file to a concept commercial rent contract
This endpoint uploads a file and links it to an existing concept commercial lease contract, for example a floor plan or a supporting document for the draft agreement.
A developer calls this endpoint after the concept contract has been created, using its external identifier to attach the file to the correct contract.
Request Fields
Field | Type | Required | Description |
|---|
externalIdentifier | string | Yes | The identifier of the concept commercial lease contract to attach the file to. This identifier is not generated by Bloxs. Passed as a query parameter. |
File | string (binary) | Yes | The file to upload, sent as multipart form data or as a binary-encoded JSON body. The call fails with a 400 response if no file is included. |
Response Fields
This endpoint returns no response fields. A successful call confirms the file was created and linked to the contract.
"
}
}
},
"components": {
"schemas": {
"APIErrorMessageModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"traceId": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
````