Import/Export of Configuration APIs
In our continuous efforts to enhance system administration and streamline configuration management, we are excited to introduce new APIs in our backend. Historically, organizations have faced challenges with manual and time-consuming configuration management processes, often leading to inconsistencies and inefficiencies.
With the introduction of these APIs, we aim to automate and streamline configuration management, ensuring a seamless import/export of configurations across different machines. This update is designed to reduce manual efforts, ensure consistency, expedite configuration updates, and ultimately enhance system stability and operational efficiency.
List of Export APIs — GET Requests
-
Domains: api/v5/configurationManagerService/exportAllDomains
-
Attributes: api/v5/configurationManagerService/exportAllAttributes
-
Content Types: api/v5/configurationManagerService/exportAllContentTypes
-
Searches: api/v5/configurationManagerService/exportAllQueries
-
Workflows: api/v5/configurationManagerService/exportAllWorkflows
-
Roles: api/v5/configurationManagerService/exportAllRoles
-
Groups: api/v5/configurationManagerService/exportAllGroups
-
Users: api/v5/configurationManagerService/exportAllUsers
-
Parameters
-
exclude: false
-
Set to true to exclude the specified users.
-
-
includedDeleted: false
-
Set to true to import all users along with deleted users.
-
-
names
-
List of user names to export.
-
-
-
-
Collections: api/v5/configurationManagerService/exportAllCollections
-
Forms: api/v5/configurationManagerService/exportAllForms
-
Relations: api/v5/configurationManagerService/exportAllRelations
List of Import APIs — POST Requests
-
Domains: api/v5/configurationManagerService/importDomains
-
Attributes: api/v5/configurationManagerService/importAttributes
-
Content Types: api/v5/configurationManagerService/importContentTypes
-
Searches: api/v5/configurationManagerService/importQueries
-
Parameters
-
setQueryConditions: true
-
setQueryContext: true
-
setSharedSearchTrustees: true
-
-
-
Workflows: api/v5/configurationManagerService/importWorkflows
-
Roles: api/v5/configurationManagerService/importRoles
-
Groups: api/v5/configurationManagerService/importGroups
-
Users: api/v5/configurationManagerService/importUsers
-
Collections: api/v5/configurationManagerService/importCollections
-
Parameters:
-
setWorkflows: true
-
setGroups: true
-
setUsers: true
-
setRevisionControls: true
-
setJobJackets: true
-
setRoutings: true
-
-
Order in which data should be imported
-
Domain or value lists
-
Attributes
-
Relation Types
-
Content types
-
Roles
-
Users
-
Groups
-
Workflows
-
Workflow Forms
-
Collections
-
Searches
Points to Consider While Using These APIs
When utilizing these newly introduced configuration management APIs, it's crucial to keep the following points in mind to ensure smooth and efficient operations:
exportAllDomains and importDomains
-
If target system doesn't have domain while importing, the domain will be imported.
-
If target system has domain while importing, the domain data will be overwritten as per the domain imported.
-
If target system does have some extra domains which are not present in the import data, those will remain unchanged.
exportAllAttributes and importAttributes
-
If target system doesn't have attribute while importing, the attribute will be imported.
-
If target system has attribute present, the attribute will be updated as the import data if the operation is permitted. Exception can be there, e.g. 'CANNOT_CHANGE_TO_SINGLE_VALUED' exception which disallows changing attribute from multi-value allowed to single value.
-
Exception thrown while trying to import attributes using domains (value lists) if they're not present in the target system.
-
Mapped content types to attribute are not mapped during importAttributes, they're mapped while importing Content Types.
exportAllRelations and importRelations
-
If target system doesn't have type of relation while importing, relation type will be created.
-
If target system doesn't have mapped attribute, then 'ATTRIBUTE_NOT_FOUND' exception will be thrown during import.
exportAllContentTypes and importContentTypes
-
If target system doesn't have content type while importing, the content type will be created.
-
If target system has the content type which is imported, then if there are changes in attribute mapping, they will be updated as per the import data.
-
Mapping of content type to attribute is done while importing content type.
-
If mapped attribute is not present in the target system while importing content type, 'ATTRIBUTE_NOT_FOUND' will be thrown during import.
exportAllRoles and importRoles
-
If target system doesn't role while importing, the role will be created with license type and assigned privileges.
-
If target system has role while importing, the license type and assigned privileges will get updated as per the imported data.
-
If target system doesn't have content type while importing role against which privileges are assigned, then 'CONTENT_TYPE_NOT_FOUND' exception will be thrown during import.
-
If updates to roles is not allowed due to user assignment, group assignment or license count appropriate exception will be thrown while importing roles.
exportAllUsers and importUsers
-
If target system doesn't have user while importing, user will be created license type and role as per the imported data.
-
If target system has the user, user will be updated.
-
If target system doesn't have role, user won't be imported.
exportAllGroups and importGroups
-
If target system doesn't have group while importing, group will be created with role and users as per imported data.
-
If target system doesn't have role mapped to group while importing, 'INVALID_USERCLASS' exception will be thrown.
-
If the target system doesn't have an existing user that is mapped to group while importing, the user mapping will skip for that user and other users will be mapped. No exception will be thrown for that user.
-
Groups are not mapped during importing users, users are mapped to groups during import of groups.
exportAllWorkflows and importWorkflows
-
If target system doesn't have workflow while importing, then workflow will be created and all status, content types and constraints will be mapped to workflow.
-
If target system doesn't have content type for which workflow is importing, content type not found exception is thrown while importing workflow.
-
If target system doesn't have attribute used in workflow status constraints, attribute not found exception is thrown while importing workflow.
-
If target system doesn't have role for which privileges are overridden or role participation on workflow status, userclass not found exception will be thrown.
-
If workflow is exists in target system, then it'll be updated as per imported data.
exportAllForms and importForms
-
If target system doesn't have workflow forms while importing, then forms are created and mapped to workflow.
-
If target system doesn't have content type for which form is importing, content type not found exception is thrown while importing forms.
-
If target system doesn't have attribute used in form, attribute not found exception is thrown while importing form.
-
If target system doesn't have workflow used in the form, workflow now found exception will be thrown.
-
If target system have form, then it'll be updated as per imported data.
exportAllCollections and importCollections
-
If target system doesn't have collections while importing, collection will be created as per imported data according to the collection hierarchy.
-
If collection exist in target system, it's updated as per changes in imported data.
-
If any of the data (workflow, routings, content types, attributes, roles) which exists in import data and is not present target system, appropriate exception is thrown.
Available parameters for importCollections API
-
setUsers: default true (use false if user mapping to collection is to be excluded while importing.
-
setGroups: default true (use false if group mapping to collection is to be excluded while importing.
-
setWorkflows: default true (use false if workflows are to be excluded while importing.
-
setRoutings: default true (use false to exclude workflow status user routings while importing.
-
setRevisionControls: default true (use false to exclude Content type revision controls for collection while importing).
-
setJobJackets: default true (use false to exclude job jacket mapping for collection while importing).
exportAllQueries and importQueries
-
If target system doesn't have query while importing, query will be created as per imported data.
-
If query exists in target system, it's updated as per changes in imported data.
-
If any of the data (workflow, status, content types, attributes, domain value list data) used in query import data is not present in target system, appropriate exception is thrown.
-
Export of queries is as per user auth token used. exportAllQueries API exports queries saved for the specific user whose token is used to export the queries.
Available parameters for importQueries API
-
setQueryContext: default true (use false to import queries without query context options: asset filter, collection filter, search all version, etc setting of query).
-
setQueryConditions: default true (use false to import queries without conditions).
-
setSharedSearchTrustees: default true (use false to ignore sharing of searches to user and groups).
