Lists all jobs under a specific tenant.
GET /schedule
Operation id: SchedulingService_ListSchedules
Tags: SchedulingService
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
jobName | string | No | Job Name field used only for partial search. Required: true (when partial search set to true) |
pageSize | integer (int32) | No | Page size of list items returned. Default: 10. Required: false |
pageToken | string | No | Auto generated page token to view results in order beyond page size. Required: false |
partialTextSearch | boolean | No | Boolean value to search on jobName field by partial search. Required: false |
sortField | string | No | ENUM defined in proto CREATION_TIME/JOB_NAME/IMPORT_TYPE/UPDATED_ON. Required: true - Indexed/Sortable |
sortType | string | No | ENUM defined in proto none defaults to descending order NONE/ASC/DEC Required: true - Indexed/Sortable |
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 |
|---|---|---|---|
scheduleProto | array | No | |
nextPageToken | string | No |
{
"type": "object",
"properties": {
"scheduleProto": {
"type": "array",
"items": {
"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"
},
"description": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"schedule": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ONCE",
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY"
],
"default": "ONCE"
},
"date": {
"type": "string",
"format": "date-time"
}
}
},
"deviation": {
"type": "integer",
"format": "int32"
},
"templateName": {
"type": "string"
},
"ignoreHeader": {
"type": "boolean"
},
"replaceExisting": {
"type": "boolean"
},
"fssId": {
"type": "string"
},
"signedUrl": {
"type": "string"
},
"sftpDetails": {
"type": "object",
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer",
"format": "int32"
},
"directory": {
"type": "string"
},
"fileName": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"sshKey": {
"type": "string"
}
}
},
"gcsDetails": {
"type": "object",
"description": "GCS Details are used for granting access to a GCS bucket for us to read the file from.",
"properties": {
"projectId": {
"type": "string"
},
"bucketName": {
"type": "string"
},
"keyFile": {
"type": "string"
},
"fileName": {
"type": "string"
}
}
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"lastUpdatedTime": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"type": "string"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"SUCCEEDED",
"FAILED",
"UNKNOWN"
],
"default": "SUCCEEDED"
},
"errorMessage": {
"type": "string"
},
"instanceId": {
"type": "string"
}
}
}
},
"nextPageToken": {
"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"
}
}
}
}
}
}