Deletes a specific job instance.
When deleting a job instance we also should delete the associated file in the FSS.
DELETE /batch/jobs/{jobName}
Operation id: BatchService_DeleteBatchJob
Tags: BatchService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 | |
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 | |
message | string | No | |
startTime | string (date-time) | No | |
endTime | string (date-time) | No | |
fssId | string | No | |
instanceId | string | No | |
historicalJobs | array | No | |
creationTime | string (date-time) | No | |
createdBy | string | No | |
created | integer (int32) | No | |
updated | integer (int32) | No | |
deleted | integer (int32) | No | |
emails | array | No |
{
"type": "object",
"properties": {
"tenantId": {
"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"
},
"message": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"fssId": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"historicalJobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"UNKNOWN_STATUS",
"PENDING",
"IN_PROGRESS",
"SUCCEEDED",
"SUCCEEDED_WITH_ERRORS",
"FAILED"
],
"default": "UNKNOWN_STATUS"
},
"message": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"fssId": {
"type": "string"
},
"instanceId": {
"type": "string"
}
}
}
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"created": {
"type": "integer",
"format": "int32"
},
"updated": {
"type": "integer",
"format": "int32"
},
"deleted": {
"type": "integer",
"format": "int32"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
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"
}
}
}
}
}
}