Represents a SIS import job. More...
Public Member Functions | |
| string | ToPrettyString () |
| Returns a pretty, formatted string representation of the object. | |
Properties | |
| ulong | Id [get] |
| The import id. More... | |
| DateTime? | CreatedAt [get] |
| When the import was created. More... | |
| DateTime? | EndedAt [get] |
| When the import finished, if at all. More... | |
| DateTime? | UpdatedAt [get] |
| When the import was last updated. More... | |
| SisImportState | WorkflowState [get] |
| The import state. More... | |
| SisImportData | Data [get] |
| The import data. More... | |
| SisImportStatistics | Statistics [get] |
| The import statistics. More... | |
| long? | Progress [get] |
| The progress of the import, out of 100. More... | |
| object | ErrorsAttachment [get] |
| The error attachment. More... | |
| User | User [get] |
| The user who initiated the import. More... | |
| IEnumerable< SisImportMessage > | ProcessingWarnings [get] |
| Any warnings raised after the import has completed. More... | |
| IEnumerable< SisImportMessage > | ProcessingErrors [get] |
| Any errors raised after the import has completed. More... | |
| bool? | BatchMode [get] |
| Whether the import was run in batch mode. More... | |
| long? | BatchModeTermId [get] |
| If running in batch mode, the term id the batch was limited to. More... | |
| bool? | MultiTermBatchMode [get] |
| Whether multi-term batch mode is enabled. More... | |
| bool? | SkipDeletes [get] |
| Whether the import will skip any deletes. More... | |
| bool? | OverrideSisStickiness [get] |
| Whether the import will override SIS stickiness. More... | |
| bool? | AddSisStickiness [get] |
| Whether the import add override SIS stickiness. More... | |
| bool? | ClearSisStickiness [get] |
| Whether the import will remove SIS stickiness. More... | |
| bool? | DiffingThresholdExceeded [get] |
| Whether a diffing job failed due to an exceeded threshold. More... | |
| string | DiffingDataSetIdentifier [get] |
| The id of the dataset that this SIS batch diffs against. More... | |
| ulong? | DiffedAgainstImportId [get] |
| The id of the import that this SIS batch diffs against. More... | |
| IEnumerable< object > | CsvAttachments [get] |
| Attached files for processing. More... | |
Detailed Description
Represents a SIS import job.
Property Documentation
◆ AddSisStickiness
|
get |
Whether the import add override SIS stickiness.
◆ BatchMode
|
get |
Whether the import was run in batch mode.
Normally, when the import file is missing an entry currently present in Canvas, the entry is left alone. In batch mode, it will be deleted instead.
◆ BatchModeTermId
|
get |
If running in batch mode, the term id the batch was limited to.
◆ ClearSisStickiness
|
get |
Whether the import will remove SIS stickiness.
◆ CreatedAt
|
get |
When the import was created.
◆ CsvAttachments
|
get |
Attached files for processing.
◆ Data
|
get |
The import data.
◆ DiffedAgainstImportId
|
get |
The id of the import that this SIS batch diffs against.
◆ DiffingDataSetIdentifier
|
get |
The id of the dataset that this SIS batch diffs against.
◆ DiffingThresholdExceeded
|
get |
Whether a diffing job failed due to an exceeded threshold.
◆ EndedAt
|
get |
When the import finished, if at all.
◆ ErrorsAttachment
|
get |
The error attachment.
◆ Id
|
get |
The import id.
◆ MultiTermBatchMode
|
get |
Whether multi-term batch mode is enabled.
◆ OverrideSisStickiness
|
get |
Whether the import will override SIS stickiness.
◆ ProcessingErrors
|
get |
Any errors raised after the import has completed.
◆ ProcessingWarnings
|
get |
Any warnings raised after the import has completed.
◆ Progress
|
get |
The progress of the import, out of 100.
◆ SkipDeletes
|
get |
Whether the import will skip any deletes.
◆ Statistics
|
get |
The import statistics.
◆ UpdatedAt
|
get |
When the import was last updated.
◆ User
|
get |
The user who initiated the import.
◆ WorkflowState
|
get |
The import state.
The documentation for this class was generated from the following file:
- UVACanvasAccess/Structures/SisImports/SisImport.cs
