Service Import Jobs
Function-calling namespace: serviceImportJobs
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/service-import-jobs/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
createdByStackUserId | string | Yes | - |
importScope | string | No | - |
status | string | Yes | - |
fileName | string | Yes | - |
idempotencyKey | string | Yes | - |
workflowId | string | No | - |
totalRows | integer | No | - |
processedRows | integer | No | - |
successCount | integer | No | - |
warningCount | integer | No | - |
errorCount | integer | No | - |
lastProcessedChunkIndex | integer | No | nullable |
summary | string | No | - |
errorReport | array<object> | No | - |
startedAt | integer | No | unix-ms timestamp; nullable |
completedAt | integer | No | unix-ms timestamp; nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
updatedAt | integer | No | unix-ms timestamp; nullable |
Nested Field Structures
errorReport item
| Field | Type | Required | Constraints |
|---|---|---|---|
rowNumber | integer | No | - |
code | string | No | - |
status | string | No | - |
message | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "serviceImportJobs",
"apiName": "create",
"data": {
"organizationId": "org_123",
"createdByStackUserId": "createdbystackuser_123",
"status": "scheduled",
"fileName": "value",
"idempotencyKey": "value"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/service-import-jobs/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "serviceImportJobs",
"apiName": "delete",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/service-import-jobs/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "serviceImportJobs",
"apiName": "getById",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByOrganization
Source: backend/endpoints/service-import-jobs/list-by-organization
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "serviceImportJobs",
"apiName": "listByOrganization",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/service-import-jobs/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
createdByStackUserId | string | No | nullable |
importScope | string | No | nullable |
status | string | No | nullable |
fileName | string | No | nullable |
idempotencyKey | string | No | nullable |
workflowId | string | No | nullable |
totalRows | integer | No | nullable |
processedRows | integer | No | nullable |
successCount | integer | No | nullable |
warningCount | integer | No | nullable |
errorCount | integer | No | nullable |
lastProcessedChunkIndex | integer | No | nullable |
summary | string | No | nullable |
errorReport | array<object> | No | nullable |
startedAt | integer | No | unix-ms timestamp; nullable |
completedAt | integer | No | unix-ms timestamp; nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
updatedAt | integer | No | unix-ms timestamp; nullable |
Nested Field Structures
errorReport item
| Field | Type | Required | Constraints |
|---|---|---|---|
rowNumber | integer | No | - |
code | string | No | - |
status | string | No | - |
message | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "serviceImportJobs",
"apiName": "update",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }