This changelog provides a detailed record of all the changes we've made to our API since the previous version 7.4 to version 7.5, including new features, modifications, and deprecations, so that it can help you adapt your implementations to be compatible with our latest updates.
Job Manager
The most substantial change in version 7.5 is the introduction of UUIDs (Universally Unique Identifiers) for users, replacing the previous ID system. The old functionality is now deprecated!
Please note:
In some operations the old IDs have already been replaced by UUIDs, and can no longer be used!
Breaking (3)
Removing a resource is always breaking unless it was deprecated before.
GET /dse/rest/v1.0/dse-object/{instanceId}/{l10nLocaleId}
Response
creator → id removed
creator → uuid added
assignment → assignees → id removed
assignment → assignees → uuid added
GET /dse/rest/v1.0/jobs/discussions/{discussionId}/comments
Response
user → id removed
user → uuid added
GET /dse/rest/v1.0/jobs/{ordinalNumber}
Response
creator → id removed
creator → uuid added
assignment → assignees → id removed
assignment → assignees → uuid added
Added Endpoints (9)
Newly added operations now available in Job Manager with version 7.5:
- GET /dse/rest/v1.0/dse-object/{instanceId}/{l10nLocaleId}/histories
- GET /dse/rest/v1.0/job-manager/filters
- GET /dse/rest/v2/process-types/{technicalName}
- GET /dse/rest/{version}/assets/{assetId}/discussion-count
- PATCH /dse/rest/v1.0/dse-object/{instanceId}
- POST /dse/rest/v1.0/dse-object
- POST /dse/rest/v1.0/job-manager/types/_search-by-filter
- POST /dse/rest/v2.0/jobs/discussions/{discussionId}/participants/_add
- POST /dse/rest/v2.0/jobs/discussions/{discussionId}/participants/_delete
Modified (30)
GET /dse/rest/v1.0/job-manager/types
Response
variables → label added
variables → help added
color added
GET /dse/rest/v1.0/jobs/filters/{filterId}/types Operation is now deprecated!
Response
types → variables → label added
types → variables → help added
types → color added
GET /dse/rest/v1.0/jobs/{ordinalNumber}/subjobs
Response
items → values → creator → id deprecated
items → values → creator → uuid added
items → assignment → assignees → id deprecated
items → assignment → assignees → uuid added
items → assignment → group → defaultAssignee → id deprecated
items → assignment → group → defaultAssignee → uuid added
GET /dse/rest/v1.0/product-manager/types
Response
variables → label added
variables → help added
color added
GET /dse/rest/v1.0/product-manager/types-light
Response
variables → label added
variables → help added
GET /dse/rest/v1.0/products/{ordinalNumber}/{localeId}
Response
creator → id deprecated
creator → uuid added
assignment → assignees → id deprecated
assignment → assignees → uuid added
assignment → group → id deprecated
assignment → group → uuid added
assignment → group → defaultAssignee → id deprecated
assignment → group → defaultAssignee → uuid added
GET /dse/rest/v1.0/products/{ordinalNumber}/{localeId}/subproducts
Response
items → creator → id deprecated
items → creator → uuid added
GET /dse/rest/v1/job-or-process/{jobOrProcessId}
Response
creator → id deprecated
creator → uuid added
GET /dse/rest/v1/process-list/{nextChunkId}
Response
values → creator → id deprecated
values → creator → uuid added
values → workflowStep → assignment → assignees → id deprecated
values → workflowStep → assignment → assignees → uuid added
values → workflowStep → assignment → group → defaultAssignee → id deprecated
values → workflowStep → assignment → group → defaultAssignee → uuid added
GET /dse/rest/v1/process-types
Response
variables → label added
variables → help added
color added
GET /dse/rest/v1/process-types/{dseObjectTypeId}
Response
variables → label added
variables → help added
color added
GET /dse/rest/v1/process/{processId}
Response
creator → id deprecated
creator → uuid added
assignment → assignees → id deprecated
assignment → assignees → uuid added
assignment → group → id deprecated
assignment → group → uuid added
assignment → group → defaultAssignee → id deprecated
assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1.0/job-manager/types/_search
Body
userId deprecated
userIdUUID added
POST /dse/rest/v1.0/jobs
Body
creatorId deprecated
creatorUUID added
Response
creator → id deprecated
creator → uuid added
assignment → assignees → id deprecated
assignment → assignees → uuid added
assignment → group → id deprecated
assignment → group → uuid added
assignment → group → defaultAssignee → id deprecated
assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1.0/jobs/_search
Body
userId deprecated
userIdUUID added
Response
values → creator → id deprecated
values → creator → uuid added
values → assignment → assignees → id deprecated
values → assignment → assignees → uuid added
values → assignment → group → defaultAssignee → id deprecated
values → assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1.0/jobs/_search/ids
Body
userId deprecated
userIdUUID added
POST /dse/rest/v1.0/jobs/discussions/{discussionId}/comments
Response
id deprecated
uuid added
POST /dse/rest/v1.0/jobs/{ordinalNumber}/_assign
Body
assigneeId deprecated
userGroupId deprecated
assigneeUUID added
userGroupUUID added
POST /dse/rest/v1.0/jobs/{ordinalNumber}/_forward
Body
assigneeId deprecated
userGroupId deprecated
assigneeUUID added
userGroupUUID added
POST /dse/rest/v1.0/jobs/{ordinalNumber}/_reject
Body
assigneeId deprecated
userGroupId deprecated
assigneeUUID added
userGroupUUID added
POST /dse/rest/v1.0/product-manager/types/_search
Body
userId deprecated
userIdUUID added
POST /dse/rest/v1.0/products
Body
creatorId deprecated
creatorUUID added
Response
creator → id deprecated
creator → uuid added
assignment → assignees → id deprecated
assignment → assignees → uuid added
assignment → group → id deprecated
assignment → group → uuid added
assignment → group → defaultAssignee → id deprecated
assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1.0/products/_search Operation is now deprecated!
Body
userId deprecated
userIdUUID added
Response
values → creator → id deprecated
values → creator → uuid added
values → assignment → assignees → id deprecated
values → assignment → assignees → uuid added
values → assignment → group → defaultAssignee → id deprecated
values → assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1.0/products/_search/ids Operation is now deprecated!
Body
userId deprecated
userIdUUID added
POST /dse/rest/v1/job-or-process/{jobOrProcessId}/_approve
Body
userId deprecated
userIdUUID added
POST /dse/rest/v1/process-list
Response
values → creator → id deprecated
values → creator → uuid added
values → workflowStep → assignment → assignees → id deprecated
values → workflowStep → assignment → assignees → uuid added
values → workflowStep → assignment → group → defaultAssignee → id deprecated
values → workflowStep → assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1/process-types/{processTypeId}/process
Body
alActivityId added
creatorUUID added
Response
201 response removed
202 response added
POST /dse/rest/v1/product-list
Body
userId deprecated
userIdUUID added
Response
values → creator → id deprecated
values → creator → uuid added
values → assignment → assignees → id deprecated
values → assignment → assignees → uuid added
values → assignment → group → defaultAssignee → id deprecated
values → assignment → group → defaultAssignee → uuid added
POST /dse/rest/v1/product-list/ids
Body
userId deprecated
userIdUUID added
PUT /dse/rest/v1.0/jobs/{ordinalNumber}
Response
creator → id deprecated
creator → uuid added
assignment → assignees → id deprecated
assignment → assignees → uuid added
assignment → group → id deprecated
assignment → group → uuid added
assignment → group → defaultAssignee → id deprecated
assignment → group → defaultAssignee → uuid added
Media Pool
Breaking (2)
Removing a resource is always breaking unless it was deprecated before.
GET /rest/mp/v1.0/settings Operation is now deleted!
GET /rest/mp/v1.0/suggest
Request Body
useLanguageNamesResult added
Response
response: 200 deleted
response: 204 added
Added Endpoints (24)
Newly added operations now available in Media Pool with version 7.5:
- POST /rest/mp/v1.0/assets/_delete
- GET /rest/mp/v1.0/assets/digital-watermark/{sessionId}
- GET /rest/mp/v1.0/assets/import/mass-imports
- GET /rest/mp/v1.0/assets/import/mass-imports/assets
- DELETE /rest/mp/v1.0/assets/import/mass-imports/{massImportId}
- GET /rest/mp/v1.0/assets/import/mass-imports/{massImportId}
- PUT /rest/mp/v1.0/assets/import/mass-imports/{massImportId}
- GET /rest/mp/v1.0/assets/import/mass-imports/{massImportId}/assets
- POST /rest/mp/v1.0/assets/import/mass-imports/{massImportId}/assets
- POST /rest/mp/v1.0/assets/import/mass-imports/{massImportId}/matches
- POST /rest/mp/v1.0/assets/{assetId}/_extract
- GET /rest/mp/v1.0/fonts
- GET /rest/mp/v1.0/fonts/valid
- POST /rest/mp/v1.0/fonts/valid
- POST /rest/mp/v1.0/versions/assets/_merge
- DELETE /rest/mp/v1.1/assets/{assetId}/subscribers
- GET /rest/mp/v1.1/assets/{assetId}/subscribers
- POST /rest/mp/v1.1/licenses/requests
- GET /rest/mp/v1.1/search/config
- POST /rest/mp/v1.1/search/config
- GET /rest/mp/v1.1/users/{userId}/activity
- POST /rest/mp/v1.1/users/{userId}/assets
- GET /rest/mp/v1.1/users/{userUuid}/activity
- POST /rest/mp/v1.1/users/{userUuid}/assets
Modified (45)
GET /rest/mp/v1.0/asset-attributes
Request Body
useLanguageNamesResult added
POST /rest/mp/v1.0/asset-attributes
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/asset-attributes/{id}
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/asset-attributes/{id}/nodes
Request Body
useLanguageNamesResult added
PATCH /rest/mp/v1.0/asset-attributes/{id}/nodes
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/asset-attributes/{id}/trees
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/asset-types
Request Body
assetTypes → orgUnitUuid added
assetTypes → roleUuid added
assetTypes → useLanguageNamesResult added
Response
assetTypes → orgUnitUuids added
assetTypes → roleUuids added
POST /rest/mp/v1.0/asset-types
Request Body
useLanguageNamesResult added
Response
orgUnitUuids added
roleUuids added
GET /rest/mp/v1.0/asset-types/{id}
Request Body
useLanguageNamesResult added
Response
orgUnitUuids added
roleUuids added
PUT /rest/mp/v1.0/asset-types/{id}
Request Body
useLanguageNamesResult added
Response
orgUnitUuids added
roleUuids added
GET /rest/mp/v1.0/asset-types/{id}/attribute-configs
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/asset-types/{id}/groups
Request Body
useLanguageNamesResult added
PATCH /rest/mp/v1.0/asset-types/{id}/groups
Request Body
useLanguageNamesResult added
POST /rest/mp/v1.0/assets/import/mass-imports
Response
lastUploadDate added
ownerName added
ownerUuid added
POST /rest/mp/v1.0/assets/load
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/assets/{assetId}/edit-schema
Response
selectedApproverUuid added
GET /rest/mp/v1.0/assets/{assetId}/versions/latest
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/assets/{assetId}/versions/official
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/assets/{assetId}/versions/upload-schema
Response
selectedApproverUuid added
GET /rest/mp/v1.0/assets/{assetId}/versions/{resourceVersion}
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/assets/{assetId}/workflow-steps
Response
uuid added
GET /rest/mp/v1.0/previews/{previewType}/asset/{assetId}
Request Body
contentDisposition added
GET /rest/mp/v1.0/search/aggregation
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.0/settings/{name}
Response
response: 401 added
POST /rest/mp/v1.0/versions/assets/{assetId}
Response
userUuid added
GET /rest/mp/v1.1/assets/{assetId}/versions/latest
Request Body
useLanguageNamesResult added
Response
assetSets added
GET /rest/mp/v1.1/assets/{assetId}/versions/{resourceVersion}
Request Body
useLanguageNamesResult added
Response
assetSets added
GET /rest/mp/v1.1/free-fields
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.1/keywords
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.1/organizational-units
Request Body
uuid added
OPTIONS /rest/mp/v1.1/search
Request Body
useLanguageNamesResult added
POST /rest/mp/v1.1/search
Request Body
useLanguageNamesResult added
Response
orgUnitUuid added
ownerUuid added
GET /rest/mp/v1.1/search/languages/default
Request Body
useLanguageNamesResult added
Response
orgUnitUuid added
ownerUuid added
GET /rest/mp/v1.1/users
Response
uuid added
GET /rest/mp/v1.1/users/current/asset-collections
Response
lastUploadDate added
ownerName added
ownerUuid added
GET /rest/mp/v1.1/virtual-databases/{vdbId}/workflow-steps Operation is now deprecated!
Response
steps → approvers → uuid added
steps → divisions → uuid added
steps → divisions → approvers → uuid added
PATCH /rest/mp/v1.2/assets
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.2/keywords
Request Body
useLanguageNamesResult added
POST /rest/mp/v1.2/keywords
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.2/themes
Request Body
useLanguageNamesResult added
Response
response: 401 added
name changed data type
POST /rest/mp/v1.2/themes
Request Body
useLanguageNamesResult added
GET /rest/mp/v1.2/webhooks
Response
vdbUuids added
POST /rest/mp/v1.2/webhooks
Response
vdbUuids added
PUT /rest/mp/v1.2/webhooks
Response
vdbUuids added
GET /rest/mp/v1.2/webhooks/{id}
Response
vdbUuids added