ConfigExportJobStatus

Description

Status entry that is created by the system while executing a config-export job (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)

Supported Operations

Model Properties

Property Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
jobName False string Name of the config-export job
jobDescription False string A read only string specifying the description of the job
user False string A read only string specifying the user who triggered the job.
startDateTime False string Export job's start-time
endDateTime False string Export job's end-time
status False string An enum which specifies the different job status. The values can be one of the following.
QUEUED - Specifies that the job execution is queued for running.
IN_PROGRESS - Specifies that the job execution is in progress.
FAILED - Specifies that the job execution has failed.
SUCCESS - Specifies that the job execution is successful.
statusMessage False string A read only string specifying the reason for success or failure of the job.
scheduleUuid False string A string that points to the original schedule that triggered the execution of a task and creation of the instance of a job history object. The original schedule might not be present if the schedule is expired.
diskFileName False string The actual name of the export output file saved in the system
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
messages False [string] Job execution messages updated during job execution
configExportType True string Enum values: FULL_EXPORT, PENDING_CHANGE_EXPORT and PARTIAL_EXPORT
Field level constraints: cannot be null. (Note: Additional constraints might exist)
deployedObjectsOnly False boolean Whether to include DEPLOYED objects only. This field is carried over from ScheduleConfigExport object
entityIds False [string] For PARTIAL_EXPORT jobs, the list of object identities that determines which objects are exported. This field is required for PARTIAL_EXPORT jobs only and is carried over from the ScheduleConfigExport object
includeSystemDefined False boolean Whether to include system defined objects. This field is carried over from ScheduleConfigExport object.
excludeEntities False [string] (Optional.) A list of object matching strings to exclude some objects in the system from being exported. This field is carried over from the ScheduleConfigExport object
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string configexportjobstatus