Changes in APIs
Set Default Workflow and Status
Newly introduced APIs
In this release, we've introduced two new APIs to manage default configurations:
-
PUT /features/api/v3/config/defaults?propertyKey={{contentTypeId}}
This API allows you to set the default configurations for a specified property key, such as content type ID. The request body can be customized to include various attributes and automation channels.
Generic request body example:
{
"contentType": "Smart Document",
"custommeta1": {
"custommeta2": "MyWf",
"custommeta3": "New"
},
"Attributes": [
"Is Document",
"Is Component",
"Random Attribute"
],
"AutomationChannels": {
"publish": "ditaDocHtml,smartDocEPub",
"deliver": {
"channelIds": [
"checkInToPlatformExt",
"templatedServiceConnector",
"SendEmailUsingSendgrid"
]
}
},
"Description": "You can provide any type of body and the property key can be of any type, such as collection path, ID, content type ID, name, etc. This is a generic API, there won't be any specific handling for the data."
}
-
GET/features/api/v3/config/defaults
This API retrieves the configured default settings.
Make sure to update your integration to utilize these new endpoints for managing default configurations effectively.
Create and Manage "Document Types"
Newly introduced APIs
Get Content Types Configured as Documents
-
API Name: getContentTypesConfiguredAsDocuments
-
Method: GET
-
Endpoint: /api/v4/contentStructureService/getContentTypesConfiguredAsDocuments
-
Description: This API retrieves document types that have at least one publishing channel. It won't return document types that lack a publishing channel.
Set Content Type Workflows
-
API Name: setContentTypeWorkflows
-
Method: POST
-
Endpoint: /api/v4/contentStructureService/setContentTypeWorkflows?contentTypeId={{ContentTypeId}}&workflowIds=<one or multiple workflows can be added>
-
Description: This API allows setting one or multiple workflows for a specified content type.
Modified API
Get Content Type Channel Mappings
-
API Name: getContentTypeChannelMappings
-
Method: GET
-
Endpoint: /api/v4/publishingService/getContentTypeChannelMappings?contentTypeId={{ChildContentTypeId}}&inherited=false
-
Description:
-
The inherited flag has been introduced to this existing API.
-
Default Value: true
-
Usage: If a user doesn't want to view the inherited channels for a content type, the inherited flag can be set as false.
-
New System Attributes
Two new system-defined, non-editable attributes have been introduced:
-
Is Document
-
Is Component
These attributes help in distinguishing between documents and components within the system.
Import/Export of Configuration APIs
Newly introduced APIs
In this release, we've introduced new APIs for import/export of configuration.
List of Export APIs — GET Requests
-
Domains: api/v3/configurationManagerService/exportAllDomains
-
Attributes: api/v3/configurationManagerService/exportAllAttributes
-
Content Types: api/v3/configurationManagerService/exportAllContentTypes
-
Searches: api/v3/configurationManagerService/exportAllQueries
-
Workflows: api/v3/configurationManagerService/exportAllWorkflows
-
Roles: api/v3/configurationManagerService/exportAllRoles
-
Groups: api/v3/configurationManagerService/exportAllGroups
-
Users: api/v3/configurationManagerService/exportAllUsers
-
Collections: api/v3/configurationManagerService/exportAllCollections
-
Forms: api/v3/configurationManagerService/exportAllForms
-
Relations: api/v3/configurationManagerService/exportAllRelations
List of Import APIs — POST Requests
-
Domains: api/v3/configurationManagerService/importDomains
-
Attributes: api/v3/configurationManagerService/importAttributes
-
Content Types: api/v3/configurationManagerService/importContentTypes
-
Searches: api/v3/configurationManagerService/importQueries
-
Parameters:
-
setQueryConditions: true
-
setQueryContext: true
-
setSharedSearchTrustees: true
-
-
-
Workflows: api/v3/configurationManagerService/importWorkflows
-
Roles: api/v3/configurationManagerService/importRoles
-
Groups: api/v3/configurationManagerService/importGroups
-
Users: api/v3/configurationManagerService/importUsers
-
Collections: api/v3/configurationManagerService/importCollections
-
Parameters:
-
setWorkflows: true
-
setGroups: true
-
setUsers: true
-
setRevisionControls: true
-
setJobJackets: true
-
setRoutings: true
-
-
