Returns a single job instance details object.
Instance Id is the same as Batch Id when retrieving User batch details in the User Service. Support for retrieving other import types needs to be discussed with the POs. If a -1 is returned in the column_number for errors an internal error occurred with the spring-batch execution.
GET /batch/jobs/{jobName}/{instanceId}
Operation id: BatchService_GetBatchJobInstance
Tags: BatchService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
instanceId | string | Yes | Specific job instance under a job name. Required: true Instance Id is the same as Batch Id when retrieving User batch details in the User Service. |
jobName | string | Yes | Job Name. Required: true |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | No | Will use the tenantUtil to pull in from bearer token if not provided. Required: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
tenantId | string | No | |
instanceId | string | No | |
jobName | string | No | |
importType | string | No | The type of data being imported. - LOCATIONS: The import file is forwarded directly to the zac-server locations API Constraints: - template_name, deviation, and dry_run are all ignored. - zac-server performs an upsert always, any errors in the file will fail the entire file |
status | string | No | |
errors | array | No | |
startTime | string (date-time) | No | |
endTime | string (date-time) | No | |
fssId | string | No | |
recordsProcessed | integer (int32) | No | |
totalErrors | integer (int32) | No | |
creationTime | string (date-time) | No | |
createdBy | string | No | |
created | integer (int32) | No | |
updated | integer (int32) | No | |
deleted | integer (int32) | No |
{
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"jobName": {
"type": "string"
},
"importType": {
"type": "string",
"description": "The type of data being imported.\n\n - LOCATIONS: The import file is forwarded directly to the zac-server locations API\nConstraints:\n - template_name, deviation, and dry_run are all ignored.\n - zac-server performs an upsert always, any errors in the file will fail the entire file",
"enum": [
"USERS",
"ROLES",
"WORKSPACES",
"SITES",
"DEPARTMENTS",
"HIERARCHIES",
"SITE_TEMPLATES",
"PERMISSION_TEMPLATES",
"GROUPS",
"LOCATIONS"
],
"default": "USERS"
},
"status": {
"type": "string",
"enum": [
"UNKNOWN_STATUS",
"PENDING",
"IN_PROGRESS",
"SUCCEEDED",
"SUCCEEDED_WITH_ERRORS",
"FAILED"
],
"default": "UNKNOWN_STATUS"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"columnNumber": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
}
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"fssId": {
"type": "string"
},
"recordsProcessed": {
"type": "integer",
"format": "int32"
},
"totalErrors": {
"type": "integer",
"format": "int32"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"created": {
"type": "integer",
"format": "int32"
},
"updated": {
"type": "integer",
"format": "int32"
},
"deleted": {
"type": "integer",
"format": "int32"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}