Basic CRUD Operations

Files Referenced in this Document

• IMyEntityNameAppService.cs
• MyEntityNameAppService.cs
• MyEntityNameCreateDto.cs
• MyEntityNameUpdateDto.cs
• MyEntityNameGetListInput.cs

Table of Contents

1. Introduction
2. Create (CreateAsync)
3. Read (GetAsync & GetListAsync)
4. Update (UpdateAsync)
5. Delete (DeleteAsync)
6. Best Practices

Introduction

Basic CRUD (Create, Read, Update, Delete) operations are the foundation of data management in the CMS plugin. Implemented via MyEntityNameAppService, these operations follow the ABP framework's standard patterns, ensuring consistency, validation, and authorization.

Create (CreateAsync)

Method Signature: Task<MyEntityNameDto> CreateAsync(MyEntityNameCreateDto input)

Description: Creates a new MyEntityName entity in the database.

Process:

1. Accepts MyEntityNameCreateDto containing required fields (e.g., Name, Code).
2. Validates the input (e.g., required fields, max length).
3. Maps DTO to Entity.
4. Inserts Entity into the database.
5. Maps the created Entity back to MyEntityNameDto and returns it.

Example Request:

POST /api/app/my-entity-name
{
  "name": "New Entity",
  "code": "NE-001"
}

Read (GetAsync & GetListAsync)

Get Single Entity

Method Signature: Task<MyEntityNameDto> GetAsync(Guid id)

Description: Retrieves a specific entity by its unique ID. Throws EntityNotFoundException if not found.

Get List

Method Signature: Task<PagedResultDto<MyEntityNameDto>> GetListAsync(MyEntityNameGetListInput input)

Description: Retrieves a paginated list of entities, optionally filtered and sorted.

Process:

1. Applies filters from MyEntityNameGetListInput (e.g., search by name).
2. Sorts data based on Sorting parameter.
3. Applies paging (SkipCount, MaxResultCount).
4. Returns a PagedResultDto containing the list of items and total count.

Example Request:

GET /api/app/my-entity-name?Filter=test&Sorting=name%20asc&SkipCount=0&MaxResultCount=10

Update (UpdateAsync)

Method Signature: Task<MyEntityNameDto> UpdateAsync(Guid id, MyEntityNameUpdateDto input)

Description: Updates an existing entity identified by ID.

Process:

1. Retrieves entity by ID.
2. Validates input.
3. Maps fields from MyEntityNameUpdateDto to the loaded entity.
4. Saves changes to the database.
5. Returns the updated DTO.

Example Request:

PUT /api/app/my-entity-name/{id}
{
  "name": "Updated Name"
}

Delete (DeleteAsync)

Method Signature: Task DeleteAsync(Guid id)

Description: Deletes an entity by ID.

Process:

1. Checks if the entity exists.
2. Deletes the entity (soft delete if ISoftDelete is implemented).
3. Returns 204 No Content upon success.

Example Request:

DELETE /api/app/my-entity-name/{id}

Best Practices

• DTOs: Always use specific DTOs for each operation (Create, Update) to control which fields can be modified.
• Validation: Use Data Annotations on DTOs for basic validation.
• Authorization: Ensure appropriate permissions are checked before each operation (handled by ABP's [Authorize] attribute or policy configuration).