> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v2.0/design/architecture/low-level-design/services/console-services/project-factory-campaign-manager/manage-data-apis/v1-deprecated-data-apis/create-data-api.md).
# Create Data API
## Endpoint
* **Endpoint**: /data/\_create
* **Method**: POST
## **Request Structure**
* **Body Parameters**:
* RequestInfo: Object containing request information.
* Resource Details: Object containing the details of the resource to be created or validated.
* type: Type of resource (boundary, facility, user, boundaryWithTarget).
* tenantId: Tenant identifier.
* fileStoreId: File store identifier.
* action: Action type (create or validate).
* hierarchyType: Type of hierarchy.
* campaignId: Campaign identifier.
* additionalDetails: Additional details object (optional).
## **Response Structure**
* **Success Response**:
\- ResponseInfo: Object containing response information.
\- ResourceDetails: Array containing the detail objects of the created or validated resource.
## **Flow**
1. **Client Initiates Request**: The client sends a createData request to the Project Factory service.
2. **Validation of Request**: The Project Factory service validates the request schema and the provided resource details.
3. **Processing the Request**:
* If action is 'create':
* Enrich resource details, set status to "data-accepted", and persist in the database.
* Further creation process happens in the background.
* After successful creation, set the status to 'completed' and persist resource details in the database.
* If action is 'validate':
* Enrich resource details, set the status to "validation-started", and persist in the database.
* Further creation process happens in the background.
* If file data is invalid, set the status to 'invalid' and persist in the database.
* After successful creation, set the status to 'completed' and persist resource details in the database.
* **Fail case**: If validation or creation fails, set the status to 'failed' and persist in the database with the error cause in additional details.
4. **Response**: The Project Factory service sends the response back to the client containing the resource details and status.
## Flow Diagram
**Parsing Logic from sheet**
The getSheetData function retrieves and processes data from an Excel sheet, validating the structure according to the configuration provided in createAndSearchConfig. The key part of this process is the parseArrayConfig.parseLogic configuration, which specifies how to parse and validate the columns in the sheet. Here's a detailed explanation of how the function works, including the parsing logic:
**Parsing Logic Using parseArrayConfig.parseLogic**
The parseArrayConfig.parseLogic configuration specifies how each column in the sheet should be processed. Here's how the parsing logic works:
```
parseLogic: [
{
sheetColumn: "A",
sheetColumnName: "HCM_ADMIN_CONSOLE_FACILITY_CODE",
resultantPath: "id",
type: "string"
},
{
sheetColumn: "B",
sheetColumnName: "HCM_ADMIN_CONSOLE_FACILITY_NAME",
resultantPath: "name",
type: "string"
},
{
sheetColumn: "C",
sheetColumnName: "HCM_ADMIN_CONSOLE_FACILITY_TYPE",
resultantPath: "usage",
type: "string"
},
{
sheetColumn: "D",
sheetColumnName: "HCM_ADMIN_CONSOLE_FACILITY_STATUS",
resultantPath: "isPermanent",
type: "boolean",
conversionCondition: {
"Permanent": "true",
"Temporary": ""
}
},
{
sheetColumn: "E",
sheetColumnName: "HCM_ADMIN_CONSOLE_FACILITY_CAPACITY",
resultantPath: "storageCapacity",
type: "number"
},
{
sheetColumn: "F",
sheetColumnName: "HCM_ADMIN_CONSOLE_BOUNDARY_CODE_MANDATORY"
}
]
```
### Column Configuration
Each column configuration specifies:
* `sheetColumn`: The column letter in the sheet.
* `sheetColumnName`: The expected name of the column in the sheet.
* `resultantPath`: The path where the value will be stored in the resultant JSON.
* `type`: The expected type of the value (e.g., string, number, or boolean).
* `conversionCondition`: Optional conditions for converting values.
**Validating Column Names**
During the validation step, the function checks that the first-row value matches the expected column name.
**Processing Rows**
When mapping the rows to JSON, the function uses the `resultantPath` to place the values in the correct location in the JSON object. It converts values according to the specified `type` and `conversionCondition`.
**Example Conversion**
For a column configuration with `type: "boolean"` and `conversionCondition`, the function would convert "Permanent" to true and "Temporary" to an empty string.
```
{
"sheetColumn": "D",
"sheetColumnName": "HCM_ADMIN_CONSOLE_FACILITY_STATUS",
"resultantPath": "isPermanent",
"type": "boolean",
"conversionCondition": {
"Permanent": "true",
"Temporary": ""
}
}
```
In summary, the getSheetData function retrieves and processes data from an Excel sheet, validating the structure and content according to the createAndSearchConfig configuration. The parseArrayConfig.parseLogic configuration specifies how each column should be validated and processed into the resultant JSON format.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.digit.org/health/v2.0/design/architecture/low-level-design/services/console-services/project-factory-campaign-manager/manage-data-apis/v1-deprecated-data-apis/create-data-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
