Resource: MaintenanceJob

About this resource

Storage class for maintenance jobs in ADAM.

Properties

Property	Description	Type
actions	A collection which defines Maintenance Actions. This job should execute on all the specified targets.	MaintenanceActionCollection
createdOn	Gets the creation datetime in UTC time.	datetime
creatorEmail	E-mail address for this job.	string
disableNotification	Value indicating whether or not notification is enabled on this job.	boolean
earliestStartDate	The earliest date in utc time on which this job can be executed.	datetime
executionTime	Gets the time it took for this maintenance job to execute.	timespan
failedTargetsCount	Gets the count of the failed targets.	int32
id	Gets the Id of this maintenance job.	guid
message	Gets the error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet.	string
priority	Gets or sets the priority of this maintenance job.	string (values: high, medium, auditarchiving, buildsearchindex)
startedOn	Gets the time on which the execution of this maintenance job started in utc time.	datetime
status	Gets the status of this maintenance job.	string (values: pending, success, failed, partiallyfailed, executing, cancelled, scheduled, queued, asyncpending, asyncexecuting)
type	Gets the name of this maintenance job.	string

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.
GET	targets	select-MaintenanceJob: targets	MaintenanceTargetCollection	Gets a collection of all the targets to be processed by this job.
GET	createdby	select-MaintenanceJob: createdby	User	Gets or sets the user that created this resource.

Examples

Reading a maintenance job without embedded resources (targets)

GET /maintenanceftpResortOrder/b6d2400e-ffce-489b-9e08-7324c9378206 HTTP/1.1
accept: application/hal+json

In case of hal+json, all subresources (targets) are represented as links to these resources.

{
	"_links": {
		"targets": {
			"href": "/maintenanceftpResortOrder/11489c63d7ac42da916ba4e901008807/targets",
			"select-key": "targets"
		},
		"self": {
			"href": "/maintenanceftpResortOrder/11489c63-d7ac-42da-916b-a4e901008807"
		}
	},
	"actions": [
		{
			"label": "Resave record"
		}
	],
	"createdBy": "fa286193ddbf44299d2ea2390e2a8b99",
	"createdOn": "2015-08-03T15:31:43.633",
	"creatorEmail": "frank.tremens@adamsoftware.net",
	"disableNotification": false,
	"earliestStartDate": "2015-08-20T22:00:00Z",
	"executionTime": "00:00:00",
	"id": "11489c63d7ac42da916ba4e901008807",
	"priority": "Medium",
	"startedOn": null,
	"status": "Pending"
}

GET /maintenanceftpResortOrder/b6d2400e-ffce-489b-9e08-7324c9378206 HTTP/1.1
accept: application/json

In case of json, all subresources (targets) are returned as null values.

{
	"targets": null,
	"actions": [
		{
			"label": "Resave record"
		}
	],
	"createdBy": "fa286193ddbf44299d2ea2390e2a8b99",
	"createdOn": "2015-08-03T15:31:43.633",
	"creatorEmail": "frank.tremens@adamsoftware.net",
	"disableNotification": false,
	"earliestStartDate": "2015-08-20T22:00:00Z",
	"executionTime": "00:00:00",
	"id": "11489c63d7ac42da916ba4e901008807",
	"priority": "Medium",
	"startedOn": null,
	"status": "Pending"
}

Reading a maintenance job with embedded resources (targets)

GET /maintenanceftpResortOrder/b6d2400e-ffce-489b-9e08-7324c9378206 HTTP/1.1
accept: application/hal+json
select-maintenanceftpResortOrder: targets

Read maintenance job and embed targets.

{
"_links": {
"self": {
"href": "/maintenanceftpResortOrder/11489c63-d7ac-42da-916b-a4e901008807"
}
},
"actions": [
{
"label": "Resave record",
"impact": 40
}
],
"createdBy": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "2015-08-03T15:31:43.633",
"creatorEmail": "frank.tremens@adamsoftware.net",
"disableNotification": false,
"earliestStartDate": "2015-08-20T22:00:00Z",
"executionTime": "00:00:00",
"id": "11489c63d7ac42da916ba4e901008807",
"priority": "Medium",
"startedOn": null,
"status": "Pending",
"_embedded": {
"targets": {
"_links": {
"self": {
"href": "/maintenanceftpResortOrder/11489c63d7ac42da916ba4e901008807/targets"
}
},
"items": [
{
"id": "bd4855e731724b67835c38fa311f11d0",
"attempt": 1,
"errorDetails": "",
"executionTime": "00:00:00",
"forceRetry": false,
"message": "",
"status": "Pending",
"tag": null
},
{
"id": "d3299f7df4724895914bc5bcdab14805",
"attempt": 1,
"errorDetails": "",
"executionTime": "00:00:00",
"forceRetry": false,
"message": "",
"status": "Pending",
"tag": null
},
{
"id": "f107d016115b41848b7fc10a8d73293b",
"attempt": 1,
"errorDetails": "",
"executionTime": "00:00:00",
"forceRetry": false,
"message": "",
"status": "Pending",
"tag": null
}
]
}
}
}