logo
logo

Mass Edit Job Object

A Mass Edit Job object contains information about a Mass Edit Job. The following properties are present:

NameTypeDescription
selfLinkA link to the resource for this Mass Edit Job
ownerLinkA link to the user entity resource that submitted this Mass Edit Job.
titleLabelsThe title to show in the UI, in different languages.
state_descriptionLabelsA description of the current state of the Mass Edit Job.
stateStringThe state of the Mass Edit Job. Possible values: Created, Pending, InProgress, Completed.
conditionStringThe condition of the Mass Edit Job. Possible values: Pending, Success, Failure.
started_onStringString containing an ISO 8601 formatted date and time when this Mass Edit Job was started.
completed_onStringString containing an ISO 8601 formatted date and time when this Mass Edit Job was completed.
target_countNumberThe number of targets present in the Mass Edit Job.
targets_completedNumberThe number of targets that have been completed.
targetsLinkA link to the targets resource for this job.

Example

{
    "state_description":"InProgress",
    "state":"InProgress",
    "condition":"Pending",
    "started_on":"...",
    "completed_on":null,
    "target_count":215,
    "targets_completed":100,
    "self":{
        "href":"http://<hostname>/api/massedits/1493",
        "title":"This mass edit job."
    },
    "targets":{
        "href":"http/<hostname>/api/massedits/1493/targets",
        "title":"The collection of targets for this Mass Edit Job."
    }
}

Can we improve this article ? Provide feedback