Resource: MaintenanceJobPagedCollection

About this resource

Representation of a paged collection of MaintenanceJob items

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of MaintenanceJob items
page	The current page of this paged collection.	int32
pageSize	The current page size of this paged collection.	int32
skip	The current skip size of this paged collection.	int32
take	The current take size of this paged collection.	int32
totalCount	The total count of items in this paged collection, not just on the current page.	int64

Relations

Method	Name	Description
GET	self	Provides a link to this resource.
GET	first	A link to the first page of this paged collection.
GET	prev	A link to the previous page of this paged collection.
GET	next	A link to the next page of this paged collection.
GET	last	A link to the last page of this paged collection.

Actions

Method

Action

Description

Response codes

POST /maintenancejobs

add

Create a maintenance job

201	Request completed successfully. The header parameter 'Location' contains the location of the new maintenance job resource. The response body is a JSON object which contains the property "id" that corresponds to the newly created maintenance job resource Id.
400	Bad request (in general)
403	Insufficient permissions

Examples

Searching for maintenance jobs

The parameters are specified as http headers.

GET /maintenancejobs HTTP/1.1
accept: application/hal+json
filter: CreatedOn in today
sort: createdon
page: 1
pageSize: 20

The parameters are specified as query string parameters.

GET /maintenancejobs?filter=CreatedOn+in+today&sort=createdon&page=1&pagesize=10 HTTP/1.1

The parameters are specified as a combination of query string parameters and http headers.

GET /maintenancejobs?filter=CreatedOn+in+today&sort=createdon HTTP/1.1
page: 1
pageSize: 20

Creating a new maintenance job

POST /maintenancejobs HTTP/1.1
{
    "type": "record",
    "priority": "Medium",
    "creatorEmail": "frank.tremens@adamsoftware.net",
    "disableNotification": "true",
    "earliestStartDate": "2015-08-01T10:00:00Z",
    "targets": [
        {
            "recordId": "bbf68a95b3f547e4acb9a3cd0069b702",
            "forceRetry" : "true",
            "tag": "<xml>some tag</xml>"
        },
        {
            "recordId": "8735a5a3e75a4bc0a2a1a3cd0069b669"
        },
        {
            "recordId": "b2fcb9c50d264ac19a6ba3cd0069b785",
            "tag": "<xml>some tag</xml>"
        }
    ],
    "actions": [
        {
            "action": "classifyRecord",
            "label": "a dummy label",
            "description": "a dummy description",
            "parameters": {
            	"classificationId": "209d7ede48004a008885a3cd006b8b8c"
            }
        }
    ]
}

Maintenance job request attributes:

Attribute	Description
type	The type of maintenance job that needs to be created. One of the following types need to be provided: record classification
priority	The priority of this maintenance job. The priority has to be a "High" or "Medium" The execution of all maintenancejobs are delayed and will be picked up by the Service Bus.
creatorEmail	The e-mail address for this maintenance job. By default this is the e-mail address of the user that created this job.
disableNotification	A value indicating whether or not notifications are enabled on this maintenance job.
earliestStartDate	The earliest date in utc on which this maintenance job can be executed.
targets	An array of references to records that this maintenance job needs to target.
actions	An array of actions that need to be executed on the targets of this maintenance job.

Export audit maintenance job specific request attributes:

Attribute	Description
title	Specify the title of the download that will appear on the Downloads page in Content Workspace. Title usually is something that can identify download.
description	Specify the description of the download that will appear on the Downloads page in Content Workspace. Description is usually the type of download, e.g. Export audit trail.
Download based on an Export audit maintenance job is displayed on the Downloads page in DAM UI(Content Workspace). Values for title and description could be: text JSON(used for translatable title or description) If title and description are not specificed, default value will be used. Default value for title is "X items". Default value for description is "Export audit trail". To provide translations for the title and description for non-English users, refer to the Localization > Translations section of the DAM Administrator Guide. Values for title and description properties should be in the following format: { ... "title":"{\"StudioName\":\"DAMUI\",\"ModuleName\":\"Orders\",\"TranslationKey\":\"CustomAuditJobTitle\"}", "description":"{\"StudioName\":\"DAMUI\",\"ModuleName\":\"Orders\",\"TranslationKey\":\"CustomAuditJobDescription\"}", ... } Where "DAMUI", "Orders", "CustomAuditJobTitle" are examples of a Studio, Module and Translation Key of a translation created earlier.

Maintenance job target attributes

(the column 'Target type' shows which property is valid for which kind of a maintenance job target)

Attribute	Target type	Description
forceRetry	All	Controls whether or not a new maintenance job will be created to retry this target after it finished its execution.
tag	All	The tag for this target.
recordId	RecordMaintenanceTarget	The Id of the target of this record maintenance job.
classificationId	ClassificationMaintenanceTarget	The Id of the target of this classification maintenance job.

Maintenance job action attributes

Attribute	Description
action	The name of the action that needs to be executed on the targets. In case the targets of the maintenance job are records, the following actions are supported: AppendTextField AppendToField ClassificationCopy ClassificationMove ClassifyRecord Delete OverwriteField RefreshFileRecord RemoveFromField ReplaceTextField UnclassifyRecord ChangeContentType ChangeRecordStatus RefreshUrlToPdf
label	Name of the action.
description	Short description of the action.
parameters	The action-specific parameters that need to be passed to the action.

Actions

Note: when editing multilingual fields, the LanguageId parameter is required. Due to performance considerations however, this is not validated in the REST API when submitting a MaintenanceJob. If you submit a job to edit a multilingual field without supplying a LanguageId parameter, the default behavior takes place: the maintenance job will succeed but leave the values of the field untouched.

AppendTextField (valid for record maintenance job)

Adds a specific text to a textfield.

The following parameter attributes need to be provided:

Attribute	Description
fieldId	The Id of the textfield.
languageId	The Id of the language of the field that needs to be updated.
value	The text that will be appended to the current value of the referenced field.

AppendToField (valid for record maintenance job)

Appends the list of provided value(s) to the list of values of a specific field. Duplicate values will be ignored.

The following parameter attributes need to be provided:

Attribute	Description
fieldId	The Id of the field for which the value will be appended. The following fields are supported: ClassificationList TextList OptionList UserList UserGroupList LanguageList RecordList
languageId	The Id of the language of the field that needs to be updated.
value	An array of values to append to the referenced field. Valid values to append: Classification list field Classification Id Classification Identifier Option list field Option item Id Option item name User list field User name User Id User group list field User group name User group Id Language list field Language name Language Id Record list field Record Id Example: ... "actions": [ { "action": "appendToField", "label": "append classification list field", "description": "appending values to a classification list field", "parameters": { "fieldId": " 41745046-4c89-482e-81d5-abe900a920d1", "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": ["class1Identifier", "class2Identifier", "2a3e4f2e-3ed6-46de-bf6f-abe900a9dcfd"] } } ] ...

Attribute

Description

fieldId

The Id of the field for which the value will be appended. The following fields are supported:

ClassificationList
TextList
OptionList
UserList
UserGroupList
LanguageList
RecordList

languageId

The Id of the language of the field that needs to be updated.

value

An array of values to append to the referenced field. Valid values to append:

Classification list field

Classification Id
Classification Identifier

Option list field

Option item Id
Option item name

User list field

User name
User Id

User group list field

User group name
User group Id

Language list field

Language name
Language Id

Record list field

Record Id

Example:

...
"actions": [
    {
        "action": "appendToField",
        "label": "append classification list field",
        "description": "appending values to a classification list field",
        "parameters": {
          "fieldId": " 41745046-4c89-482e-81d5-abe900a920d1",
          "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
          "value": ["class1Identifier", "class2Identifier", "2a3e4f2e-3ed6-46de-bf6f-abe900a9dcfd"]
        }
    }
]
...

ClassificationCopy (valid for classification maintenance job)

Copies a classification to a specified parent classification.

The following parameter attributes need to be provided:

Attribute	Description
parentClassificationId	The Id of the parent classification to which the target classification will be copied to.
copySecurity	Specifies if the security options of the target classification should be preserved during the copy process.

ClassificationMove (valid for classification maintenance job)

Moves a classification to a specified parent classification.

The following parameter attributes need to be provided:

Attribute	Description
parentClassificationId	The Id of the parent classification to which the target classification will be moved to.

ClassifyRecord (valid for record maintenance job)

Classifies a record in a specific classification.

The following parameter attributes need to be provided:

Attribute	Description
classificationId	The Id of the classification in which the record will be classified in.

UnclassifyRecord (valid for record maintenance job)

Unlinks a record from a specific classification.

The following parameter attributes need to be provided:

Attribute	Description
classificationId	The Id of the classification that will be unlinked from the record.

Delete (valid for record maintenance job)

Deletes a record.

No parameters have to be provided.

OverwriteField (valid for record maintenance job)

Overwrites the value of a specific field with another value.

The following parameter attributes need to be provided:

Attribute	Description
fieldId	The Id of the field for which the value will be overwritten. The following fields are supported: SingleLineText MultiLineText Html Numeric DateTime Time Date Duration OptionList UserList UserGroupList ClassificationList RecordList LanguageList
languageId	The Id of the language of the field that needs to be updated.
value	The new value of the referenced field. In case of lists, an array of Id's need to be provided.
useReferences	If set to false, then the specified value will be used as is. If set to true, the specified value is considered to contain references. These references will be resolved and the resolved value will be assigned to the field. See Chapter 22 ("References") of the ADAM Administrator Guide for more information.

RefreshFileRecord (valid for record maintenance job)

Refreshes all files of a record.

No parameters have to be provided.

RemoveFromField (valid for record maintenance job)

Removes the given value from the value of a specific field.

The following parameter attributes need to be provided:

Attribute	Description
fieldId	The Id of the field for which the value will be updated. The following fields are supported: ClassificationList TextList OptionList UserList UserGroupList LanguageList RecordList
languageId	The Id of the language of the field that needs to be updated.
value	An array of values to remove from the referenced field. Valid values to remove: Classification list field Classification Id Classification Identifier Option list field Option item Id Option item name User list field Username User Id User group list field User group name User group Id Language list field Language name Language Id Record list field Record Id

ReplaceTextField (valid for record maintenance job)

Replaces a specific text by another text in a textfield.

The following parameter attributes need to be provided:

Attribute	Description
fieldId	The Id of the textfield.
languageId	The Id of the language of the field that needs to be updated.
oldValue	The value to be replaced.
newValue	The value to replace all occurrences of oldValue.

ChangeContentType (valid for record maintenance job)

Changes the content type for a specific record.

The following parameter attributes need to be provided:

Attribute	Description
contentType	The name of the content type to which the record needs to change to.

TrimVideo (valid for record maintenance job)

Creates a trimmed video for a specific record that has a video file and stores it in the record's additional files.

The following parameter attributes need to be provided:

Attribute	Description
trimmedVideoName	The name the trimmed video should get.
startTime	The start time (format: "hh:mm:ss[.fffffff]") of the trimmed video.
duration	The duration (format: "hh:mm:ss[.fffffff]") of the trimmed video.

CropImage (valid for record maintenance job)

Creates a cropped image for a specific record that has an image file and stores it in the record's additional files.

The following parameter attributes need to be provided:

Attribute	Description
name	The name the cropped image should get.
Crop X Y Width Height	The coordinates of the crop in the original image. X and Y are the coordinates of the upper left corner of the crop, with X and Y starting from 0 in the upper left corner. The width and height are relative to these coordinates. Example: "crop": { "x" : 200, "y" : 300, "width" : 150, "height" : 250 }
ResizeWidth	The width to which the cropped image needs to be resized.
ResizeHeight	The height to which the cropped image needs to be resized.
format	The following formats are supported: keepOriginal jpg png tiff bmp eps pdf
resolution	The resolution in dpi.
colorSpace	The following colorSpaces are supported: keepOriginal rgb cmyk lab indexedColor grayscale bitmap

CreatePresetCrops (valid for record maintenance job)

Creates preset cropped images for a specific record that has an image file and stores it in the record's additional files.

No parameters have to be provided.

AprimoAI (valid for record maintenance job)

Runs the Aprimo AI features for a specific record.

The following parameter attributes need to be provided:

Attribute	Description
options	The following Aprimo AI options are supported: SmartTags CustomSmartTags Faces Transcripts Text

RefreshOnAkamaiCdn (valid for record maintenance job)

Updates file (latest version of master file or additional file) on Akamai if it was already published.

To update latest version of master file following parameter need to be provided:

Attribute	Description
RenditionName	The name of rendition for file.
"parameters": { "renditionName" : "name" }

To update additional file parameter need to be provided:

Attribute	Description
AdditionalFileId	The ID of additional file.
"parameters": { "additionalFileId" : "da7517298d384d50a0489243fa393dcc" }

CreateRenditions (valid for record maintenance job)

Creates renditions on the master file of the specified record

The following parameter attributes need to be provided:

Attribute	Description
Presets	The presets to be executed.
"parameters": { "presets" : ["Rendition1","Rendition2"] }

CreatePublicLinks (valid for record maintenance job)

Creates public links on the master file of the specified record

The following parameter attributes need to be provided:

Attribute	Description
Presets	The presets to be executed.
"parameters": { "presets" : ["Rendition1","Rendition2"] }

DeletePublicLinks (valid for record maintenance job)

Deletes public links on the master file of the specified record or (All preset is applicable to all files).

The following parameter attributes need to be provided:

Attribute	Description
Presets	The presets to be executed.
"parameters": { "presets" : ["Rendition1","Rendition2"] }

ChangeRecordStatus (valid for record maintenance job)

Changes the status for a specific record.

The following parameter attributes need to be provided:

Attribute	Description
Status	The status to which the record needs to change to. The following values are supported: Draft Released Archived

RefreshUrlToPdf (valid for record maintenance job)

This action will do an attempt to automatically generate a PDF from the pages of a public website, when the content type of the record maintenance target has 'File mode' set to 'Generate from website'. The URL, crawl depth and amount of PDF pages, that are required for this action, will be read from the record and from the content type configuration. If invalid or not present the action will fail causing the target to be failed.

See Chapter "Configure content types" of the ADAM Administrator Guide for more information on File handling and PDF creation based upon content type.

No parameters have to be provided.