Common Model APIs

The latest online API documentation is available at https://api.softa.io 

The following are common model-level API.

POST copyList

POST /{modelName}/copyList

Copy multiple rows based on ids, and return the new data ids.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST copyListAndReturn

POST /{modelName}/copyListAndReturn

Copy multiple rows based on ids, and return the new rows.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST copyOne

POST /{modelName}/copyOne

Copy a single row based on id, and return the id of the new row.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST copyOneAndReturn

POST /{modelName}/copyOneAndReturn

Copy a single row based on id, and return the new row.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET copyWithoutCreate

GET /{modelName}/copyWithoutCreate

Copy one row by id, only return the copyable field values, without inserting into database.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET count

GET /{modelName}/count

Returns a count or group counting based on the specified filter, groupBy, and orders.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST createList

POST /{modelName}/createList

Create multiple rows and return the id list.

Body Parameters

[
  {
    "property1": {},
    "property2": {}
  }
]

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST createListAndReturn

POST /{modelName}/createListAndReturn

Create multiple rows and return the latest values from database.

Body Parameters

[
  {
    "property1": {},
    "property2": {}
  }
]

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST createOne

POST /{modelName}/createOne

Create a single row and return the id.

Body Parameters

{
  "property1": {},
  "property2": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST createOneAndReturn

POST /{modelName}/createOneAndReturn

Create one row return the latest values from database.

Body Parameters

{
  "property1": {},
  "property2": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST deleteList

POST /{modelName}/deleteList

Delete multiple rows by ids.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST deleteOne

POST /{modelName}/deleteOne

Delete one row by id. All slices related to this id will be deleted for timeline model.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST deleteBySliceId

POST /{modelName}/deleteBySliceId

Delete a slice of the timeline model by sliceId.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST addVersion

POST /{modelName}/addVersion

Timeline models only: add a version (slice) to an EXISTING entity. The body must carry the entity’s id; effectiveStartDate defaults to the context effective date. Fields absent from the body are copied forward from the adjacent slice, so a delta payload (id + effectiveStartDate + changed fields) is the recommended form. Adjacent slices are split/corrected automatically. Returns the new version’s sliceId (the existing sliceId when a same-start slice is corrected in place).

Body Parameters

{
  "id": 6,
  "effectiveStartDate": "2026-08-01",
  "name": "New Department Name"
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": 1899999999999999,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST addVersionAndFetch

POST /{modelName}/addVersionAndFetch

Like addVersion, then fetches the full version row by its sliceId (across the timeline — the new version’s effective date may not be today).

Body Parameters

{
  "id": 6,
  "effectiveStartDate": "2026-08-01",
  "name": "New Department Name"
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": {
    "id": 6,
    "sliceId": 1899999999999999,
    "name": "New Department Name",
    "effectiveStartDate": "2026-08-01",
    "effectiveEndDate": "9999-12-31"
  },
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST setEndDate

POST /{modelName}/setEndDate

Timeline models only: set the end date of the entity’s LAST slice. An endDate before 9999-12-31 terminates the timeline (as-of reads after it return nothing); passing 9999-12-31 reopens it. Must not precede the last slice’s start date — delete trailing versions first to terminate earlier. A later addVersion starting after a terminated end date revives the entity as a new segment, leaving a gap.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET getUnmaskedField

GET /{modelName}/getUnmaskedField

Get the original value for masking field.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET getUnmaskedFields

GET /{modelName}/getUnmaskedFields

Get the original values for multiple masking fields.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET readList

GET /{modelName}/readList

Read multiple rows by ids.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

GET readOne

GET /{modelName}/readOne

Read one row by id.

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST searchList

POST /{modelName}/searchList

Get the data list based on the specifiedfields, filters, orders, limitSize, aggFunctions, and subQueries. Default limit to 50.

Body Parameters

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "fields": [
    "id",
    "name"
  ],
  "filters": {},
  "groupBy": [],
  "orders": [
    "name",
    "ASC"
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "splitBy": [],
  "subQueries": {},
  "summary": true
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST searchPage

POST /{modelName}/searchPage

Paging aggregation query parameters, including fields, filters, orders, pageNumber, pageSizegroupBy, aggFunctions, subQueries, etc. Use the backend default value when not specified.

Body Parameters

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "fields": [
    "id",
    "name"
  ],
  "filters": {},
  "groupBy": [],
  "orders": [
    "name",
    "ASC"
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "splitBy": [],
  "subQueries": {},
  "summary": true
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST searchPivot

POST /{modelName}/searchPivot

Get the pivot table data based on the specified fields, filters, orders, groupBy, splitBy.

Body Parameters

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "fields": [
    "id",
    "name"
  ],
  "filters": {},
  "groupBy": [],
  "orders": [
    "name",
    "ASC"
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "splitBy": [],
  "subQueries": {},
  "summary": true
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST searchSimpleAgg

POST /{modelName}/searchSimpleAgg

Pure SUM, AVG, MIN, MAX, COUNT aggregate query, like ["SUM", "amount"] or [["SUM", "amount"], [], ...], the return key is sumAmount.

Body Parameters

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "filters": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST updateByFilter

POST /{modelName}/updateByFilter

Update data according to the filters, within the current user’s permission scope.

Body Parameters

{
  "property1": {},
  "property2": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST updateList

POST /{modelName}/updateList

Update multiple rows by id. Return true on success.

Body Parameters

[
  {
    "property1": {},
    "property2": {}
  }
]

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST updateListAndReturn

POST /{modelName}/updateListAndReturn

Update multiple rows by id, and return the latest values from database.

Body Parameters

[
  {
    "property1": {},
    "property2": {}
  }
]

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST updateOne

POST /{modelName}/updateOne

Update one row by id. Return true on success.

Body Parameters

{
  "property1": {},
  "property2": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

POST updateOneAndReturn

POST /{modelName}/updateOneAndReturn

Update one row by id, and return the latest values from database.

Body Parameters

{
  "property1": {},
  "property2": {}
}

Params

Response Examples

200 Response

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}

Responses

Responses Data Schema

Data Schema

API Response Body

{
  "code": 0,
  "data": true,
  "error": "string",
  "message": "string"
}
 

Attribute

AggFunctions

[
  "SUM",
  "amount"
]
 

Support multiple aggregation queries:

• []
• [“SUM”, “amount”]
• [[“SUM”, “amount”], [“COUNT”, “id”]]

Attribute

None

Orders

[
  "name",
  "ASC"
]
 

Support multiple order conditions:

• []
• [“name”, “ASC”]
• [[“name”, “ASC”], [“sequence”, “DESC”]]
• or string format: “name ASC, sequence DESC”

Attribute

None

SubQuery

{}
 

Sub queries for relational fields: {fieldName: SubQuery}

Attribute

Filters

[
  "name",
  "=",
  "Tom"
]
 

Support nested filters, such as [a OR b] AND [c OR d OR [e AND f] OR g]

• []
• [“name”, ”=”, “Tom”]
• [[“name”, ”=”, “Tom”], [“version”, ”=”, “6”]]
• [[“name”, ”=”, “Tom”], “OR”, [“code”, ”=”, “A010”], “OR”, [“version”, ”=”, “2”]]
• [[“name”, ”=”, “Tom”], “OR”, [“code”, ”=”, “A010”]], “AND”, [“version”, ”=”, “2”]]

Attribute

None

QueryParams

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "fields": [
    "id",
    "name"
  ],
  "filters": {},
  "groupBy": [],
  "orders": [
    "name",
    "ASC"
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "splitBy": [],
  "subQueries": {},
  "summary": true
}
 

Attribute

SimpleQueryParams

{
  "aggFunctions": [
    "SUM",
    "amount"
  ],
  "effectiveDate": "2019-08-24",
  "filters": {}
}
 

Attribute