EBAYCCLONE

FRONTEND GUIDE FOR AI CODING AGENTS - PART 10 - AdminModeration Service

This document is a part of a REST API guide for the ebaycclone project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of adminModeration

Service Access

AdminModeration service management is handled through service specific base urls.

AdminModeration service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the adminModeration service, the base URLs are:

• Preview: https://ebaycclone.prw.mindbricks.com/adminmoderation-api
• Staging: https://ebaycclone-stage.mindbricks.co/adminmoderation-api
• Production: https://ebaycclone.mindbricks.co/adminmoderation-api

Scope

AdminModeration Service Description

Administrative backend service for moderation and manual override actions. Responsible for logging all admin interventions (user/product/feedback/media/category/order/notification/searchindex moderation), triggering corrections via interservice calls, and providing comprehensive audit trails for compliance.

AdminModeration service provides apis and business logic for following data objects in ebaycclone application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

moderationAction Data Object: Audit record for all admin moderation/override actions affecting core business entities. Links to admin, timestamp, entity type/ID, action performed, and reason.

AdminModeration Service Frontend Description By The Backend Architect

Service is admin-only and never presented to buyers/sellers. All moderation actions (soft-delete, restore, update/correct) display audit information and confirmation dialogs. Admin views include filtering/search of moderation actions by entity type, date, and admin user. Admin-initiated corrections (like payment, feedback, or index fixes) always appear as explicit history entries. All endpoints require admin login; UI presents moderation action logs for compliance review, manual rollbacks, and traceability.

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

• 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
• 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3,
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

Error Response

If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters.
• 401 Unauthorized: The request lacked a valid authentication token; login is required.
• 403 Forbidden: The current token does not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Ebaycclone application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"ebaycclone-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

ModerationAction Data Object

Audit record for all admin moderation/override actions affecting core business entities. Links to admin, timestamp, entity type/ID, action performed, and reason.

ModerationAction Data Object Frontend Description By The Backend Architect

Each moderationAction creates a visible traceable log for compliance. Moderation details (admin, target type/id, reason, timestamp) are rendered in the admin dashboard/AuditLog view. Editing/deleting moderation actions is restricted to superadmins or internal use for corrections. Actions are linked to actual domain changes for reference.

ModerationAction Data Object Properties

ModerationAction data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• entityType: [USER, PRODUCT, FEEDBACK, MEDIA, CATEGORY, NOTIFICATION, ORDER, SEARCHINDEX]

• actionType: [SOFT_DELETE, RESTORE, UPDATE_ROLE, MANUAL_CORRECTION, MEDIA_FLAG, INDEX_REBUILD, PAYMENT_FIX, FEEDBACK_OVERRIDE, ADMIN_NOTE]

Relation Properties

adminId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• adminId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

API Reference

Get Moderationaction API

Get a single moderation action log by ID. Used to review admin audit trails; accessible only to platform admins.

Rest Route

The getModerationAction API REST controller can be triggered via the following route:

/v1/moderationactions/:moderationActionId

Rest Request Parameters

The getModerationAction api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/moderationactions/:moderationActionId

  axios({
    method: 'GET',
    url: `/v1/moderationactions/${moderationActionId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationAction",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationAction": {
		"id": "ID",
		"adminId": "ID",
		"entityId": "ID",
		"actionTimestamp": "Date",
		"entityType": "Enum",
		"entityType_idx": "Integer",
		"reason": "String",
		"actionType": "Enum",
		"actionType_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Moderationaction API

Soft-deletes a moderation action log record (dangerous; allowed only to superadmins or strict manual correction), primarily for audit correction or internal error cleanup. Usually, moderation logs are immutable.

Rest Route

The deleteModerationAction API REST controller can be triggered via the following route:

/v1/moderationactions/:moderationActionId

Rest Request Parameters

The deleteModerationAction api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/moderationactions/:moderationActionId

  axios({
    method: 'DELETE',
    url: `/v1/moderationactions/${moderationActionId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationAction",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationAction": {
		"id": "ID",
		"adminId": "ID",
		"entityId": "ID",
		"actionTimestamp": "Date",
		"entityType": "Enum",
		"entityType_idx": "Integer",
		"reason": "String",
		"actionType": "Enum",
		"actionType_idx": "Integer",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Moderationaction API

Logs an admin moderation or override action in the system for audit and traceability. Requires admin login, takes context from session, and creates an audit entry for any admin operation over any entity type.

Rest Route

The createModerationAction API REST controller can be triggered via the following route:

/v1/moderationactions

Rest Request Parameters

The createModerationAction api has got 4 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/moderationactions

  axios({
    method: 'POST',
    url: '/v1/moderationactions',
    data: {
            entityId:"ID",  
            entityType:"Enum",  
            reason:"String",  
            actionType:"Enum",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationAction",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationAction": {
		"id": "ID",
		"adminId": "ID",
		"entityId": "ID",
		"actionTimestamp": "Date",
		"entityType": "Enum",
		"entityType_idx": "Integer",
		"reason": "String",
		"actionType": "Enum",
		"actionType_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Moderationactions API

List moderation actions for admin dashboard/audit search. Supports filtering by admin, entityType, entityId, actionType, and date. Always sorted by most recent action.

Rest Route

The listModerationActions API REST controller can be triggered via the following route:

/v1/moderationactions

Rest Request Parameters The listModerationActions api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/moderationactions

  axios({
    method: 'GET',
    url: '/v1/moderationactions',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationActions",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"moderationActions": [
		{
			"id": "ID",
			"adminId": "ID",
			"entityId": "ID",
			"actionTimestamp": "Date",
			"entityType": "Enum",
			"entityType_idx": "Integer",
			"reason": "String",
			"actionType": "Enum",
			"actionType_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Moderationaction API

Allows update of explanation/note on a moderation action for correction (typically by admin or superadmin only). No entity/type/admin may be changed after creation; only 'reason' is editable for audit consistency.

Rest Route

The updateModerationAction API REST controller can be triggered via the following route:

/v1/moderationactions/:moderationActionId

Rest Request Parameters

The updateModerationAction api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/moderationactions/:moderationActionId

  axios({
    method: 'PATCH',
    url: `/v1/moderationactions/${moderationActionId}`,
    data: {
            reason:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationAction",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationAction": {
		"id": "ID",
		"adminId": "ID",
		"entityId": "ID",
		"actionTimestamp": "Date",
		"entityType": "Enum",
		"entityType_idx": "Integer",
		"reason": "String",
		"actionType": "Enum",
		"actionType_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.