REST APIs

Mass edit job

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

Name	Type	Description
`self`	Link	A link to the resource for this Mass Edit Job
`owner`	Link	A link to the user entity resource that submitted this Mass Edit Job.
`title`	Labels	The title to show in the UI, in different languages.
`state_description`	Labels	A description of the current state of the Mass Edit Job.
`state`	String	The state of the Mass Edit Job. Possible values: Created, Pending, InProgress, Completed.
`condition`	String	The condition of the Mass Edit Job. Possible values: Pending, Success, Failure.
`started_on`	String	String containing an ISO 8601 formatted date and time when this Mass Edit Job was started.
`completed_on`	String	String containing an ISO 8601 formatted date and time when this Mass Edit Job was completed.
`target_count`	Number	The number of targets present in the Mass Edit Job.
`targets_completed`	Number	The number of targets that have been completed.
`targets`	Link	A 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."
  }
}

If you have suggestions for improving this article, let us know!