@Connector(name="collibra-dgc", friendlyName="CollibraDGC") @ReconnectOn(exceptions=javax.ws.rs.NotAuthorizedException.class) public class CollibraDGCConnector extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ENCODING |
static String |
DEFAULT_UPSERT_ITEM_SEPARATOR |
static String |
ESCAPE |
static String |
FALSE |
static String |
QUOTE |
static String |
SEPARATOR |
static String |
TRUE |
Constructor and Description |
---|
CollibraDGCConnector() |
Modifier and Type | Method and Description |
---|---|
Asset |
addAsset(AddAssetRequest addAssetRequest,
String sessionId,
String csrfToken)
Adds the Asset
|
Attribute |
addAttribute(AddAttributeRequest addAttributeRequest,
String sessionId,
String csrfToken)
Adds atrribute with given value to the Asset
|
Comment |
addComment(AddCommentRequest addCommentRequest,
String sessionId,
String csrfToken)
Adds a Comment into a resource
|
Community |
addCommunity(AddCommunityRequest addCommunityRequest,
String sessionId,
String csrfToken)
Adds the community
|
Domain |
addDomain(AddDomainRequest addDomainRequest,
String sessionId,
String csrfToken)
Adds the new Domain
|
Asset |
addIssue(AddIssueRequest addIssueRequest,
String sessionId,
String csrfToken)
Adds issue basing on given parameters.
|
Mapping |
addMapping(AddMappingRequest addMappingRequest,
String sessionId,
String csrfToken)
Adds mapping
|
Attribute |
addMultivalueListAttribute(AddMultivalueAttributeRequest addMultivalueAttributeRequest,
String sessionId,
String csrfToken)
Adds atribute with multiple values to the Asset
|
Relation |
addRelation(AddRelationRequest addRelationRequest,
String sessionId,
String csrfToken)
Adds the Relation between assets
|
Comment |
addReply(AddReplyRequest addReplyRequest,
String sessionId,
String csrfToken)
Post a reply to the Comment
|
Responsibility |
addResponsibility(AddResponsibilityRequest addResponsibilityRequest,
String sessionId,
String csrfToken)
Adds a responsibility to the existing list of Responsibilities.
|
User |
addUser(AddUserRequest addRequest,
String sessionId,
String csrfToken)
Adds user
|
Asset |
changeAsset(ChangeAssetRequest changeAssetRequest,
String sessionId,
String csrfToken)
Changes the specific Asset
|
Attribute |
changeAttribute(ChangeAttributeRequest changeAttributeRequest,
String sessionId,
String csrfToken)
Makes changes to an attribute that is already in the list of attributes.
|
Comment |
changeComment(ChangeCommentRequest changeCommentRequest,
String sessionId,
String csrfToken)
Modifies the Comment
|
Community |
changeCommunity(ChangeCommunityRequest changeCommunityRequest,
String sessionId,
String csrfToken)
Changes the specific Community
|
Domain |
changeDomain(ChangeDomainRequest changeDomainRequest,
String sessionId,
String csrfToken)
Change the specific Domain
|
Mapping |
changeMapping(ChangeMappingRequest changeMappingRequest,
String sessionId,
String csrfToken)
Modifies the mapping
|
Attribute |
changeMultivalueListAttribute(ChangeMultivalueAttributeRequest changeMultivalueAttributeRequest,
String sessionId,
String csrfToken)
Changes a multivalue attribute based on the
changeMultivalueAttributeRequest request. |
Relation |
changeRelation(ChangeRelationRequest changeRelationRequest,
String sessionId,
String csrfToken)
Changes the Relation
|
User |
changeUser(ChangeUserRequest changeUserRequest,
String sessionId,
String csrfToken)
Changes the specific User NOTE: changing userName is no longer supported.
|
void |
cleanMappings(String extSystemId,
String sessionId,
String csrfToken)
Removes all mappings for given external system
|
InputStream |
downloadFile(String fileId,
String sessionId,
String csrfToken)
Download file content with given file's id
|
InputStream |
exportCSV(String tableViewConfig,
String file,
String separator,
String quote,
String escape,
Boolean headerRow,
String sessionId,
String csrfToken)
Exports the table to CSV file.
|
String |
exportCSVAsString(String tableViewConfig,
String file,
String separator,
String quote,
String escape,
Boolean headerRow,
String sessionId,
String csrfToken)
Exports the table in CSV format to String
|
InputStream |
exportExcel(String tableViewConfig,
String file,
String sheetName,
Boolean useXLSX,
Boolean headerRow,
String sessionId,
String csrfToken)
Exports the table to Excel file
|
InputStream |
exportJSON(String tableViewConfig,
String sessionId,
String csrfToken)
Exports the table as JSON
|
List<Attribute> |
findAttributes(FindAttributesRequest findAttributesRequest,
String sessionId,
String csrfToken)
Gets list of the attributes for selected resource
|
Mapping |
findMappingByExtEntityId(String extSystemId,
String extEntityId,
String sessionId,
String csrfToken)
Gets a mapping identified by the external system id and external entity
id
|
Mapping |
findMappingByResourceId(String extSystemId,
String resourceId,
String sessionId,
String csrfToken)
Gets a mapping identified by the external system id and resource id
|
org.mule.streaming.ProviderAwarePagingDelegate<Mapping,CollibraDGCConnector> |
findMappings(FindMappingsRequest findMappingRequest,
org.mule.streaming.PagingConfiguration pagingConfiguration,
String sessionId,
String csrfToken)
Returns the mappings list
|
org.mule.streaming.ProviderAwarePagingDelegate<Relation,CollibraDGCConnector> |
findRelations(FindRelationsRequest findRelationsRequest,
org.mule.streaming.PagingConfiguration pagingConfiguration,
String sessionId,
String csrfToken)
Gets the Relations of desired type between selected assets
|
List<Responsibility> |
findResponsibility(FindResponsibilityRequest findResponsibilityRequest,
String sessionId,
String csrfToken)
Gets the Responsibilities list
|
Asset |
getAsset(String assetId,
String sessionId,
String csrfToken)
Gets the Asset by id
|
Asset |
getAssetByExternalId(String externalId,
String externalSystemId,
String sessionId,
String csrfToken)
Get asset by external entity ID.
|
Asset |
getAssetByName(String domainId,
String assetName,
String sessionId,
String csrfToken)
Gets the asset by name from specific Domain
|
NamedResourceReference |
getAssetType(String assetTypeId,
String sessionId,
String csrfToken)
Gets the asset Type by id
|
NamedResourceReference |
getAssetTypeByName(String assetTypeName,
String sessionId,
String csrfToken)
Gets the asset Type by name
|
Attribute |
getAttribute(String attributeId,
String sessionId,
String csrfToken)
Gets the attribute by id
|
NamedResourceReference |
getAttributeType(String attributeTypeId,
String sessionId,
String csrfToken)
Gets the Attribute type by id
|
NamedResourceReference |
getAttributeTypeByName(String attributeTypeName,
String sessionId,
String csrfToken)
Gets the Attribute Type by name
|
Comment |
getComment(String commentId,
String sessionId,
String csrfToken)
Gets a Comment by id
|
Community |
getCommunity(String communityId,
String sessionId,
String csrfToken)
Gets the Community by ID
|
Community |
getCommunityByName(String communityName,
String sessionId,
String csrfToken)
Gets the Community by name
|
ConnectorConnectionStrategy |
getConnectionStrategy() |
Domain |
getDomain(String domainId,
String sessionId,
String csrfToken)
Gets the Domain by id
|
Domain |
getDomainByName(String communityId,
String domainName,
String sessionId,
String csrfToken)
Gets the Domain by name from specific Community
|
NamedResourceReference |
getDomainType(String domainTypeId,
String sessionId,
String csrfToken)
Gets the domain Type by id
|
NamedResourceReference |
getDomainTypeByName(String domainTypeName,
String sessionId,
String csrfToken)
Gets domain Type by Type name
|
Job |
getJob(String jobId,
String sessionId,
String csrfToken)
Returns the Job representation.
|
Mapping |
getMapping(String mappingId,
String sessionId,
String csrfToken)
Gets the mapping by id
|
Relation |
getRelation(String relationId,
String sessionId,
String csrfToken)
Gets the Relation by id
|
RelationType |
getRelationType(String relationTypeId,
String sessionId,
String csrfToken)
Gets the relation Type by id
|
Status |
getStatus(String statusId,
String sessionId,
String csrfToken)
Gets the Status by id
|
Status |
getStatusByName(String statusName,
String sessionId,
String csrfToken)
Gets the Status by name
|
User |
getUser(String userId,
String sessionId,
String csrfToken)
Gets the user by id
|
Job |
importCSV(InputStream csvFile,
String csvFileId,
String csvFileName,
String tableViewConfig,
String separator,
String quote,
String escape,
boolean strictQuotes,
boolean ignoreLeadingWhiteSpace,
boolean headerRow,
boolean deleteFile,
boolean sendNotification,
boolean waitForImportToFinish,
Integer jobStatusCheckIntervalMilliseconds,
String sessionId,
String csrfToken)
Imports CSV file.
|
void |
importCSVFromString(String stringCsvFile,
String fileName,
String tableViewConfig,
String separator,
String quote,
String escape,
boolean strictQuotes,
boolean ignoreLeadingWhiteSpace,
boolean headerRow,
boolean deleteFile,
boolean sendNotification,
boolean waitForImportToFinish,
Integer jobStatusCheckIntervalMilliseconds,
String sessionId,
String csrfToken)
Imports CSV file form a String argument.
|
Job |
importExcel(InputStream excelFile,
String excelFileId,
String excelFileName,
String tableViewConfig,
boolean headerRow,
boolean deleteFile,
boolean sendNotification,
String sheetName,
Integer sheetIndex,
boolean waitForImportToFinish,
Integer jobStatusCheckIntervalMilliseconds,
String sessionId,
String csrfToken)
Imports Excel file.
|
void |
importMetricsFromCSV(InputStream metricsFile,
String fileName,
String sessionId,
String csrfToken)
Imports metrics from CVS file.
|
org.mule.streaming.ProviderAwarePagingDelegate<Asset,CollibraDGCConnector> |
listAssets(String domainId,
org.mule.streaming.PagingConfiguration pagingConfiguration,
String sessionId,
String csrfToken)
Returns the list of the Assets from specific Domain
|
List<Asset> |
listAssetsByAssetTypeAndLastModifiedDate(String assetType,
long lastModifiedDate,
String sessionId,
String csrfToken) |
List<Comment> |
listComments(String resourceId,
String sessionId,
String csrfToken)
Gets a list of comments for selected Resource
|
List<Comment> |
listReplies(String commentId,
String sessionId,
String csrfToken)
Gets list of replies for Comment
|
String |
login(String sessionId,
String csrfToken,
org.mule.api.MuleEvent event)
Performs login (2.0/auth/sessions) to start a new session and retrieve
JSESSIONID cookie.
|
void |
logout(String sessionId,
String csrfToken)
Performs logout (2.0/auth/sessions/current) to end the session.
|
void |
removeAsset(String assetId,
String sessionId,
String csrfToken)
Removes the specific Asset
|
void |
removeAssets(List<String> assetIds,
String sessionId,
String csrfToken)
Removes Assets
|
void |
removeAttribute(String attributeId,
String sessionId,
String csrfToken)
Removes the Attribute by id
|
void |
removeComment(String commentId,
String sessionId,
String csrfToken)
Removes the Comment
|
void |
removeCommunity(String communityId,
String sessionId,
String csrfToken)
Removes the Community
|
void |
removeDomain(String domainId,
String sessionId,
String csrfToken)
Removes the specific Domain
|
void |
removeDomains(List<String> domainIds,
String sessionId,
String csrfToken)
Removes Domains
|
void |
removeMapping(String mappingId,
String sessionId,
String csrfToken)
Removes the mapping
|
void |
removeMappingByResourceId(String extSystemId,
String resourceId,
String sessionId,
String csrfToken)
Removes the mapping identified by the external system id and resource id
|
void |
removeMappingExtEntityId(String extSystemId,
String extEntityId,
String sessionId,
String csrfToken)
Removes the mapping identified by the external system id and external
entity id
|
void |
removeRelation(String relationId,
String sessionId,
String csrfToken)
Removes the Relation
|
void |
removeUser(String userId,
String sessionId,
String csrfToken)
Removes the specific User
Still using V1 of the API
|
void |
sendWorkflowMessageEvent(SendWorkflowMessageEventRequest sendWorkflowMessageEventRequest,
String sessionId,
String csrfToken)
Sends message event to the workflow engine.
|
void |
setConnectionStrategy(ConnectorConnectionStrategy connectionStrategy) |
Job |
simulateImportCSV(String csvFileId,
String tableViewConfig,
String separator,
String quote,
String escape,
boolean strictQuotes,
boolean ignoreLeadingWhiteSpace,
boolean headerRow,
boolean sendNotification,
String sessionId,
String csrfToken)
Simulates import for CSV file.
|
Job |
simulateImportExcel(String excelFileId,
String tableViewConfig,
boolean headerRow,
boolean sendNotification,
String sheetName,
Integer sheetIndex,
String sessionId,
String csrfToken)
Imports Excel file.
|
StartWorkflowResponse |
startWorkflow(StartWorkflowRequest startWorkflowRequest,
String sessionId,
String csrfToken)
Starts one workflow process
|
String |
uploadFile(InputStream file,
String fileName,
String sessionId,
String csrfToken)
Upload file to the temporary upload directory.
|
List<Map<String,Object>> |
upsertAssets(String assetTypeId,
List<Map<String,Object>> assets,
String defaultDomainId,
String externalSystemId,
String fileName,
boolean sendNotification,
Integer batchSize,
Integer jobStatusCheckIntervalMilliseconds,
boolean updateResponsibilitiesAndReturnDGCIDsOfAssets,
String sessionId,
String csrfToken)
Upserts assets of given type into DGC (creates new assets and updates
existing ones).
|
List<Map<String,Object>> |
upsertAssetsByName(String assetTypeId,
List<Map<String,Object>> assets,
String fileName,
boolean sendNotification,
Integer batchSize,
Integer jobStatusCheckIntervalMilliseconds,
boolean updateResponsibilitiesAndReturnDGCIDsOfAssets,
String sessionId,
String csrfToken)
Upserts assets of given type into DGC (creates new assets and updates
existing ones).
|
public static final String DEFAULT_UPSERT_ITEM_SEPARATOR
public static final String TRUE
public static final String FALSE
public static final String QUOTE
public static final String ESCAPE
public static final String SEPARATOR
public static final String DEFAULT_ENCODING
public ConnectorConnectionStrategy getConnectionStrategy()
public void setConnectionStrategy(ConnectorConnectionStrategy connectionStrategy)
@Processor(friendlyName="Login") public String login(@Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken, org.mule.api.MuleEvent event)
sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.event
- - Mule event.@Processor(friendlyName="Logout") public void logout(@Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add community") public Community addCommunity(@FriendlyName(value="Community") @Summary(value="Community to add") @Default(value="#[payload]") AddCommunityRequest addCommunityRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addCommunityRequest
- - object of type AddCommunityRequest
describing the
Community.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Community
type object@Processor(friendlyName="Get community") public Community getCommunity(@FriendlyName(value="Community id") @Summary(value="Id of a community to retrieve") String communityId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
communityId
- - the id of the CommunitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Community
type object when found@Processor(friendlyName="Get community by name") public Community getCommunityByName(@FriendlyName(value="Community name") @Summary(value="Name of a community to retrieve") String communityName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
communityName
- - the name of the CommunitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Community
type object when found@Processor(friendlyName="Change community") public Community changeCommunity(@FriendlyName(value="Community") @Summary(value="Community to change") @Default(value="#[payload]") ChangeCommunityRequest changeCommunityRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeCommunityRequest
- - object of type ChangeCommunityRequest
describing the
Community.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Community
type object@Processor(friendlyName="Remove community") public void removeCommunity(@FriendlyName(value="Community Id") @Summary(value="Community to remove") String communityId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
communityId
- - the id of the CommunitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add domain") public Domain addDomain(@FriendlyName(value="Domain") @Summary(value="Domain to add") @Default(value="#[payload]") AddDomainRequest addDomainRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addDomainRequest
- - object of type AddDomainRequest
describing the
Domain.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Domain
type object@Processor(friendlyName="Get domain") public Domain getDomain(String domainId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainId
- - the id of the DomainsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Domain
type object when found@Processor(friendlyName="Get domain by name") public Domain getDomainByName(String communityId, String domainName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
communityId
- - the id of the Community that owns the DomaindomainName
- - the name of the DomainsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Domain
type object when found@Processor(friendlyName="Change domain") public Domain changeDomain(@Default(value="#[payload]") ChangeDomainRequest changeDomainRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeDomainRequest
- - object of type ChangeDomainRequest
describing the
Domain.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Domain
type object@Processor(friendlyName="Remove domain") public void removeDomain(String domainId, @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainId
- - the id of the DomainsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Remove domains") public void removeDomains(List<String> domainIds, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainIds
- - Ids of domains to be removedsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Paged @Processor(friendlyName="List assets") public org.mule.streaming.ProviderAwarePagingDelegate<Asset,CollibraDGCConnector> listAssets(String domainId, org.mule.streaming.PagingConfiguration pagingConfiguration, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainId
- - the id of the DomainpagingConfiguration
- - the query pagination configurationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="List Assets By Asset Type, and Last Modified Date") public List<Asset> listAssetsByAssetTypeAndLastModifiedDate(String assetType, long lastModifiedDate, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetType
- - The asset TypelastModifiedDate
- - The last Modified datesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - The csrfTokenList
of Asset
@Processor(friendlyName="Add asset") public Asset addAsset(@Default(value="#[payload]") AddAssetRequest addAssetRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addAssetRequest
- - object of type AddAssetRequest
describing the AssetsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object@Processor(friendlyName="Get asset") public Asset getAsset(String assetId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetId
- - the id of the AssetsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object when found@Processor(friendlyName="Get asset by external entity id") public Asset getAssetByExternalId(String externalId, String externalSystemId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
externalId
- - the ID of an external entity (entity from another system)
that was created for an Asset in DGC.externalSystemId
- - the id of the external systemsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object when found@Processor(friendlyName="Get asset by name") public Asset getAssetByName(String domainId, String assetName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainId
- - the id of the Domain that owns the AssetassetName
- - the name of the AssetsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object when found@Processor(friendlyName="Change asset") public Asset changeAsset(@Default(value="#[payload]") ChangeAssetRequest changeAssetRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeAssetRequest
- - the object of type ChangeAssetRequest
describing the
AssetsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object@Processor(friendlyName="Remove asset") public void removeAsset(String assetId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetId
- - the id of the AssetsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Remove assets") public void removeAssets(List<String> assetIds, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetIds
- - Ids of assets to be removedsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add user") public User addUser(@Default(value="#[payload]") AddUserRequest addRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addRequest
- - object of type AddUserRequest
describing the user to
be added.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.UserReference
type object@Processor(friendlyName="Get user") public User getUser(String userId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
userId
- - the id of the UsersessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.UserReference
type object when found@Processor(friendlyName="Change user") public User changeUser(@Default(value="#[payload]") ChangeUserRequest changeUserRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeUserRequest
- - the object of type ChangeUserRequest
describing the
UsersessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.UserReference
type object@Processor(friendlyName="Remove user") public void removeUser(String userId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
userId
- - the id of the UsersessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add relation") public Relation addRelation(@Default(value="#[payload]") AddRelationRequest addRelationRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addRelationRequest
- - object of type AddRelationRequest
describing the
RelationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Relation
type object@Processor(friendlyName="Get relation") public Relation getRelation(String relationId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
relationId
- - the id of the RelationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
type object when found@Processor(friendlyName="Change relation") public Relation changeRelation(@Default(value="#[payload]") ChangeRelationRequest changeRelationRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeRelationRequest
- - object of type ChangeRelationRequest
describing the
RelationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Relation
type object@Processor(friendlyName="Remove relation") public void removeRelation(String relationId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
relationId
- - the id of the RelationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Paged @Processor(friendlyName="Find relations") public org.mule.streaming.ProviderAwarePagingDelegate<Relation,CollibraDGCConnector> findRelations(@Default(value="#[payload]") FindRelationsRequest findRelationsRequest, org.mule.streaming.PagingConfiguration pagingConfiguration, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
findRelationsRequest
- - object of type FindRelationsRequest
describing the
RelationspagingConfiguration
- - the query pagination configurationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add comment") public Comment addComment(@Default(value="#[payload]") AddCommentRequest addCommentRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addCommentRequest
- - object of type AddCommentRequest
describing the
commentsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type object@Processor(friendlyName="Add reply") public Comment addReply(@Default(value="#[payload]") AddReplyRequest addReplyRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addReplyRequest
- - object of type AddReplyRequest
describing the replysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type object@Processor(friendlyName="Get comment") public Comment getComment(String commentId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
commentId
- - the id of the CommentsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type object@Processor(friendlyName="Change comment") public Comment changeComment(@Default(value="#[payload]") ChangeCommentRequest changeCommentRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeCommentRequest
- - object of type ChangeCommentRequest
describing a
commentsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type object@Processor(friendlyName="Remove comment") public void removeComment(String commentId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
commentId
- - the id of the CommentsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="List replies") public List<Comment> listReplies(String commentId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
commentId
- - the id of the CommentsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type objects@Processor(friendlyName="List comments") public List<Comment> listComments(String resourceId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
resourceId
- - the id of the ResourcesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Comment
type objects@Processor(friendlyName="Simulate CSV Import") public Job simulateImportCSV(@Default(value="#[payload]") String csvFileId, String tableViewConfig, @Default(value=",") String separator, @Default(value="\"") String quote, @Default(value="\\") String escape, @Default(value="false") boolean strictQuotes, @Default(value="false") boolean ignoreLeadingWhiteSpace, @Default(value="false") boolean headerRow, @Default(value="false") boolean sendNotification, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
csvFileId
- - the ID of CSV file uploaded to DGC, used to importtableViewConfig
- - JSON String representation of TableViewConfigseparator
- - the delimiter character used to separate entriesquote
- - the delimiter character used for quoted entriesescape
- - the delimiter character used to escape separator or quote
characterstrictQuotes
- - set the character outside quotes are ignored (true) or not
(false)ignoreLeadingWhiteSpace
- - set if white space before quotes are ignored (true) or not
(false)headerRow
- - set if the first row of the sheet is the header (true) or
not (false)sendNotification
- - true to send notification, false otherwisesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Import CSV") public Job importCSV(@Default(value="#[payload]") InputStream csvFile, @Optional String csvFileId, @Optional String csvFileName, String tableViewConfig, @Default(value=",") String separator, @Default(value="\"") String quote, @Default(value="\\") String escape, @Default(value="false") boolean strictQuotes, @Default(value="false") boolean ignoreLeadingWhiteSpace, @Default(value="false") boolean headerRow, @Default(value="false") boolean deleteFile, @Default(value="false") boolean sendNotification, @Default(value="true") boolean waitForImportToFinish, @Optional Integer jobStatusCheckIntervalMilliseconds, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
csvFile
- - the CSV file to importcsvFileId
- - the ID of CSV file uploaded to DGC, used to importcsvFileName
- - the optional name of the file to be uploadedtableViewConfig
- - JSON String representation of TableViewConfigseparator
- - the delimiter character used to separate entriesquote
- - the delimiter character used for quoted entriesescape
- - the delimiter character used to escape separator or quote
characterstrictQuotes
- - set the character outside quotes are ignored (true) or not
(false)ignoreLeadingWhiteSpace
- - set if white space before quotes are ignored (true) or not
(false)headerRow
- - set if the first row of the sheet is the header (true) or
not (false)deleteFile
- - true if the file must be deleted when the Job is terminated,
false otherwisesendNotification
- - true to send a notification, false otherwisewaitForImportToFinish
- - if true then this operation will trigger import job and
return only when the job is finished (status will be checked
by polling the running job). If false then this operation
returns immediately after the import job is startedjobStatusCheckIntervalMilliseconds
- - how often status of the job should be checked for
completeness. This interval defines time (given in
milliseconds) between two consecutive checks. If not provided
then standard checking strategy applies (each second for jobs
under 10 seconds and each 10 seconds for longer jobs)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Import CSV from string") public void importCSVFromString(@Default(value="#[payload]") String stringCsvFile, @Optional String fileName, String tableViewConfig, @Default(value=",") String separator, @Default(value="\"") String quote, @Default(value="\\") String escape, @Default(value="false") boolean strictQuotes, @Default(value="false") boolean ignoreLeadingWhiteSpace, @Default(value="false") boolean headerRow, @Default(value="false") boolean deleteFile, @Default(value="false") boolean sendNotification, @Default(value="true") boolean waitForImportToFinish, @Optional Integer jobStatusCheckIntervalMilliseconds, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken) throws UnsupportedEncodingException
stringCsvFile
- - CVS file in stringfileName
- - the optional name of the file to be uploadedtableViewConfig
- - JSON String representation of TableViewConfigseparator
- - the delimiter character used to separate entriesquote
- - the delimiter character used for quoted entriesescape
- - the delimiter character used to escape separator or quote
characterstrictQuotes
- - set the character outside quotes are ignored (true) or not
(false)ignoreLeadingWhiteSpace
- - set if white space before quotes are ignored (true) or not
(false)headerRow
- - set if the first row of the sheet is the header (true) or
not (false)deleteFile
- - true if the file must be deleted when the Job is terminated,
false otherwisesendNotification
- - true to send a notification, false otherwisewaitForImportToFinish
- - if true then this operation will trigger import job and
return only when the job is finished (status will be checked
by polling the running job). If false then this operation
returns immediately after the import job is startedjobStatusCheckIntervalMilliseconds
- - how often status of the job should be checked for
completeness. This interval defines time (given in
milliseconds) between two consecutive checks. If not provided
then standard checking strategy applies (each second for jobs
under 10 seconds and each 10 seconds for longer jobs)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.UnsupportedEncodingException
- if the default encoding is not supported for the
stringCsvFile
provided.@Processor(friendlyName="Simulate Excel Import") public Job simulateImportExcel(@Default(value="#[payload]") String excelFileId, String tableViewConfig, @Default(value="false") boolean headerRow, @Default(value="false") boolean sendNotification, @Optional String sheetName, @Optional Integer sheetIndex, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
excelFileId
- - the ID of Excel file uploaded to DGC, used to importtableViewConfig
- - JSON String representation of TableViewConfigheaderRow
- - set if the first row of the sheet is the header (true) or
not (false)sendNotification
- - true to send a notification, false otherwisesheetName
- - the name of the sheet. If the name is null, the first sheet
of the workbook will be used for the importsheetIndex
- - the index of the sheet (zero-based). If the index is null or
negative, the first sheet of the workbook will be used for the
importsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Import Excel") public Job importExcel(@Default(value="#[payload]") InputStream excelFile, @Optional String excelFileId, @Optional String excelFileName, String tableViewConfig, @Default(value="false") boolean headerRow, @Default(value="false") boolean deleteFile, @Default(value="false") boolean sendNotification, @Optional String sheetName, @Optional Integer sheetIndex, @Default(value="true") boolean waitForImportToFinish, @Optional Integer jobStatusCheckIntervalMilliseconds, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
excelFile
- - the Excel file to importexcelFileId
- - the ID of Excel file uploaded to DGC, used to importexcelFileName
- - the optional name of the file to be uploadedtableViewConfig
- - JSON String representation of TableViewConfigheaderRow
- - set if the first row of the sheet is the header (true) or
not (false)deleteFile
- - true if the file must be deleted when the Job is terminated,
false otherwisesendNotification
- - true to send a notification, false otherwisesheetName
- - the name of the sheet. If the name is null, the first sheet
of the workbook will be used for the importsheetIndex
- - the index of the sheet (zero-based). If the index is null or
negative, the first sheet of the workbook will be used for the
importwaitForImportToFinish
- - if true then this operation will trigger import job and
return only when the job is finished (status will be checked
by polling the running job). If false then this operation
returns immediately after the import job is startedjobStatusCheckIntervalMilliseconds
- - how often status of the job should be checked for
completeness. This interval defines time (given in
milliseconds) between two consecutive checks. If not provided
then standard checking strategy applies (each second for jobs
under 10 seconds and each 10 seconds for longer jobs)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Import Metrics") public void importMetricsFromCSV(@Default(value="#[payload]") InputStream metricsFile, @Optional String fileName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
metricsFile
- - the CVS file to importfileName
- - the optional name of the file to be uploadedsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Export CSV") public InputStream exportCSV(String tableViewConfig, @Optional String file, @Default(value=",") String separator, @Default(value="\"") String quote, @Default(value="\\") String escape, @Default(value="true") Boolean headerRow, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
tableViewConfig
- - JSON String representation of TableViewConfigfile
- - the name of the file or null to use a generated file nameseparator
- - the delimiter character used to separate entriesquote
- - the delimiter character used for quoted entriesescape
- - the delimiter character used to escape separator or quote
characterheaderRow
- - set if the file will include a header (true) or not (false)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Export CSV as String") public String exportCSVAsString(String tableViewConfig, @Optional String file, @Default(value=",") String separator, @Default(value="\"") String quote, @Default(value="\\") String escape, @Default(value="true") Boolean headerRow, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken) throws IOException
tableViewConfig
- - JSON String representation of TableViewConfigfile
- - the name of the file or null to use a generated file nameseparator
- - the delimiter character used to separate entriesquote
- - the delimiter character used for quoted entriesescape
- - the delimiter character used to escape separator or quote
characterheaderRow
- - set if the file will include a header (true) or not (false)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.IOException
- if method fails to process exported CSV data.@Processor(friendlyName="Export Excel") public InputStream exportExcel(String tableViewConfig, @Optional String file, @Optional String sheetName, @Default(value="true") Boolean useXLSX, @Default(value="true") Boolean headerRow, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
tableViewConfig
- - JSON String representation of TableViewConfigfile
- - the name of the file or null to use a generated file namesheetName
- - the name of the sheet or null if no sheet name has to be setuseXLSX
- - set if the Excel file to export will be .xlsx file (true) or
a .xls file (false)headerRow
- - set if the file will include a header (true) or not (false)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Export JSON") public InputStream exportJSON(@Default(value="#[payload]") String tableViewConfig, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
tableViewConfig
- - JSON String representation of TableViewConfigsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Download file") public InputStream downloadFile(@Default(value="#[payload]") String fileId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
fileId
- - The id of the file [required]sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Upload file") public String uploadFile(@Default(value="#[payload]") InputStream file, @Optional String fileName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
file
- - the file to uploadfileName
- - name of the file to be uploaded (optional)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add responsibility") public Responsibility addResponsibility(@Default(value="#[payload]") AddResponsibilityRequest addResponsibilityRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addResponsibilityRequest
- - object of type AddResponsibilityRequest
describing
the responsibilitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Responsibility
} based on the
addResponsibilityRequest
.@Processor(friendlyName="Find responsibilities") public List<Responsibility> findResponsibility(@Default(value="#[payload]") FindResponsibilityRequest findResponsibilityRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
findResponsibilityRequest
- - object of type FindResponsibilityRequest
describing
thesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Responsibility
type objects@Processor(friendlyName="Get status") public Status getStatus(String statusId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
statusId
- - the id of the StatussessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Status
type object describing the Status@Processor(friendlyName="Get status by name") public Status getStatusByName(String statusName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
statusName
- - the name of the StatussessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Status
type object describing the Status@Processor(friendlyName="Get attribute type") public NamedResourceReference getAttributeType(String attributeTypeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
attributeTypeId
- - the id of the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
Attribute@Processor(friendlyName="Get attribute type by name") public NamedResourceReference getAttributeTypeByName(String attributeTypeName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
attributeTypeName
- - the name of the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
Attribute@Processor(friendlyName="Get domain type") public NamedResourceReference getDomainType(String domainTypeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainTypeId
- - the id of the domain TypesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
domain Type@Processor(friendlyName="Get domain type by name") public NamedResourceReference getDomainTypeByName(String domainTypeName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
domainTypeName
- - the name of the domain TypesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
domain Type@Processor(friendlyName="Get asset type") public NamedResourceReference getAssetType(String assetTypeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetTypeId
- - the id of the asset TypesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
asset Type@Processor(friendlyName="Get asset type by name") public NamedResourceReference getAssetTypeByName(String assetTypeName, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
assetTypeName
- - the name of the asset TypesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.NamedResourceReference
type object describing the
asset Type@Processor(friendlyName="Get relation type") public RelationType getRelationType(String relationTypeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
relationTypeId
- - the id of the relation TypesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.RelationType
type object describing the relation Type@Processor(friendlyName="Add mapping") public Mapping addMapping(@Default(value="#[payload]") AddMappingRequest addMappingRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addMappingRequest
- - object of type AddMappingRequest
describing the
mappingsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Mapping
type object describing the mapping@Processor(friendlyName="Get mapping") public Mapping getMapping(String mappingId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
mappingId
- - the id of the mappingsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Mapping
type object describing the mapping@Processor(friendlyName="Remove mapping") public void removeMapping(String mappingId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
mappingId
- - the id of the mappingsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Remove mapping by external entity id") public void removeMappingExtEntityId(String extSystemId, String extEntityId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
extSystemId
- - the id of the external systemextEntityId
- - the id of the the external entitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Remove mapping by resource id") public void removeMappingByResourceId(String extSystemId, String resourceId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
extSystemId
- - the id of the external systemresourceId
- - the id of the Asset or Domain in DGCsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Remove all mappings to external system") public void cleanMappings(String extSystemId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
extSystemId
- - the id of the external systemsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Find mapping by external entity id") public Mapping findMappingByExtEntityId(String extSystemId, String extEntityId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
extSystemId
- - the id of the external systemextEntityId
- - the id of the external entitysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Mapping
type object describing the mapping@Processor(friendlyName="Find mapping by resource id") public Mapping findMappingByResourceId(String extSystemId, String resourceId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
extSystemId
- - the id of the external systemresourceId
- - the id of the Asset or Domain in DGCsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Mapping
type object describing the mapping@Paged @Processor(friendlyName="Find mappings") public org.mule.streaming.ProviderAwarePagingDelegate<Mapping,CollibraDGCConnector> findMappings(@Default(value="#[payload]") FindMappingsRequest findMappingRequest, org.mule.streaming.PagingConfiguration pagingConfiguration, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
findMappingRequest
- - object of type FindMappingsRequest
describing the
mappingspagingConfiguration
- - the query pagination configurationsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Change mapping") public Mapping changeMapping(@Default(value="#[payload]") ChangeMappingRequest changeMappingRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeMappingRequest
- - object of type ChangeMappingRequest
describing the
mappingsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Mapping
type object@Processor(friendlyName="Add attribute") public Attribute addAttribute(@Default(value="#[payload]") AddAttributeRequest addAttributeRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addAttributeRequest
- - object of type AddAttributeRequest
that represents
the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
type object@Processor(friendlyName="Add multivalue attribute") public Attribute addMultivalueListAttribute(@Default(value="#[payload]") AddMultivalueAttributeRequest addMultivalueAttributeRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addMultivalueAttributeRequest
- - object of type AddMultivalueAttributeRequest
that
represents the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
type object@Processor(friendlyName="Get attribute") public Attribute getAttribute(String attributeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
attributeId
- - the id of the attributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
type object@Processor(friendlyName="Find attributes") public List<Attribute> findAttributes(@Default(value="#[payload]") FindAttributesRequest findAttributesRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
findAttributesRequest
- - object of type FindAttributesRequest
that represents
the querrysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
type objects that represents
the Attributes@Processor(friendlyName="Change attribute") public Attribute changeAttribute(@Default(value="#[payload]") ChangeAttributeRequest changeAttributeRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeAttributeRequest
- - object of type changeAttributeRequest
that
represents the querrysessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
that was modified based on
changeAttributeRequest
@Processor(friendlyName="Change multivalue attribute") public Attribute changeMultivalueListAttribute(@Default(value="#[payload]") ChangeMultivalueAttributeRequest changeMultivalueAttributeRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
changeMultivalueAttributeRequest
request.changeMultivalueAttributeRequest
- - object of type ChangeMultivalueAttributeRequest
describing the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Attribute
type object@Processor(friendlyName="Remove attribute") public void removeAttribute(String attributeId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
attributeId
- - the id of the AttributesessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Start workflow") public StartWorkflowResponse startWorkflow(StartWorkflowRequest startWorkflowRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
startWorkflowRequest
- - object of type StartWorkflowRequest
describing the
workflowsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.StartWorkflowResponse
@Processor(friendlyName="Send message event to workflow") public void sendWorkflowMessageEvent(SendWorkflowMessageEventRequest sendWorkflowMessageEventRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
sendWorkflowMessageEventRequest
- - object of type SendWorkflowMessageEventRequest
describing message eventsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.@Processor(friendlyName="Add issue") public Asset addIssue(@Default(value="#[payload]") AddIssueRequest addIssueRequest, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
addIssueRequest
- - object of type AddIssueRequest
describing the issue
to be createdsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Asset
@Processor(friendlyName="Upsert assets by external entity ID") @MetaDataScope(value=UpsertByExternalIdMetaDataCategory.class) public List<Map<String,Object>> upsertAssets(@MetaDataKeyParam(affects=BOTH) String assetTypeId, @Default(value="#[payload]") List<Map<String,Object>> assets, String defaultDomainId, String externalSystemId, @Optional String fileName, @Placement(order=40) @Default(value="false") boolean sendNotification, @Placement(order=50) @Optional Integer batchSize, @Placement(order=50) @Optional Integer jobStatusCheckIntervalMilliseconds, @FriendlyName(value="Update responsibilities and return DGC IDs of assets") @Placement(order=51) @Default(value="true") boolean updateResponsibilitiesAndReturnDGCIDsOfAssets, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken) throws IOException
assetTypeId
- - The id of a type for assets which are created. Type of
assets which are updated will not change.assets
- - Assets that are going to be imported where each asset is in
form of Map<String, Object>
. Keys (properties)
'externalId' and 'name' are obligatory. Additionally if the
'defaultDomainId' is not defined as an argument of this
operation then it should be defined in here as 'defaultDomain'
property. (The 'defaultDomain' property requires defining
'name' or 'id' properties of the domain where the asset has to
be upserted. If you only provide only the 'name' of the domain
then additionally the 'name' or 'id' of the community in which
the specified domain is located needs to be given). All assets
should have the same structure (same attributes and relations
that are upserted). Only attributes and relations for which
keys exist in the input assets argument (
Map<String,Object>
) are considered to be in scope o
upsert. If given asset in DGC already contains attributes or
relations which are not in the scope of upsert (keys of those
don't exist in the object structure) then those properties
will be left untouched.defaultDomainId
- - The id of a parent domain for assets which are created. The
domain of the assets which are updated will not change. If
this property is provided in each asset as 'defaultDomain'
then it is not obligatory here. (any string like: 'IGNORED'
can be put in this field and it will not be used in that
case).externalSystemId
- - Any string that serves as identifier of given systems and is
unique across all systems integrated with DGC (for more
information see
https://compass.collibra.com/display/DOC/Integration
+Framework)fileName
- - the name of the file which is used to represent upsert
operation in the DGC (visible in Activities table)sendNotification
- - Boolean
to signal whether notification should be
sentjobStatusCheckIntervalMilliseconds
- - how often status of the job should be checked for
completeness. This interval defines time (given in
milliseconds) between two consecutive checks. If not provided
then standard checking strategy applies (each second for jobs
under 10 seconds and each 10 seconds for longer jobs)batchSize
- - the size of batch to be processed by collibra instance.updateResponsibilitiesAndReturnDGCIDsOfAssets
- - (Advanced) whether the responsibilities should be updated
and DGC IDs of assets that are imported should be returned in
the response of this operation. In some situation this is not
needed. In those cases it should be skipped as it may cause
performance problems. If argument is set to false - the id
property of each asset in response of this request is not set
and responsibilities are not imported.sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.List
of upserted assets using the
externalSystemId
IOException
- if upsertByExternalId
fails to upsert the existing
Assets list using the External Id@Processor(friendlyName="Upsert assets by name") @MetaDataScope(value=UpsertByNameMetaDataCategory.class) public List<Map<String,Object>> upsertAssetsByName(@MetaDataKeyParam(affects=BOTH) String assetTypeId, @Default(value="#[payload]") List<Map<String,Object>> assets, @Optional String fileName, @Placement(order=40) @Default(value="false") boolean sendNotification, @Placement(order=50) @Optional Integer batchSize, @Placement(order=50) @Optional Integer jobStatusCheckIntervalMilliseconds, @FriendlyName(value="Update responsibilities and return DGC IDs of assets") @Placement(order=51) @Default(value="true") boolean updateResponsibilitiesAndReturnDGCIDsOfAssets, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken) throws IOException
assetTypeId
- - The id of a type for assets which are created. Type of
assets which are updated will not change.assets
- - Assets that are going to be imported where each asset is in
form of Map<String, Object>
. Keys 'name' and 'domain'
are obligatory. (The 'domain' property requires defining
'name' or 'id' properties of the domain where the asset has to
be upserted. If you only provide only the 'name' of the domain
then additionally the 'name' or 'id' of the community in which
the specified domain is located needs to be given). All assets
should have the same structure (same attributes and relations
that are upserted). Only attributes and relations for which
keys exist in the input assets argument (
Map<String,Object>
) are considered to be in scope o
upsert. If given asset in DGC already contains attributes or
relations which are not in the scope of upsert (keys of those
don't exist in the object structure) then those properties
will be left untouched.fileName
- - the name of the file which is used to represent upsert
operation in the DGC (visible in Activities table)sendNotification
- - Boolean
to signal whether notification should be
sentbatchSize
- - the size of batch to be processed by collibra instance.updateResponsibilitiesAndReturnDGCIDsOfAssets
- - (Advanced) whether the responsibilities should be updated
and DGC IDs of assets that are imported should be returned in
the response of this operation. In some situation this is not
needed. In those cases it should be skipped as it may cause
performance problems. If argument is set to false - the id
property of each asset in response of this request is not set
and responsibilities are not imported.jobStatusCheckIntervalMilliseconds
- - how often status of the job should be checked for
completeness. This interval defines time (given in
milliseconds) between two consecutive checks. If not provided
then standard checking strategy applies (each second for jobs
under 10 seconds and each 10 seconds for longer jobs)sessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.List
of upserted assets.IOException
- if upsertByName
fails to upsert the existing Assets
list by Name@Processor(friendlyName="Get Job") public Job getJob(String jobId, @Placement(order=100) @Default(value="#[sessionVars.dgcSessionId]") String sessionId, @Placement(order=100) @Default(value="#[sessionVars.dgcCsrfToken]") String csrfToken)
jobId
- - the id of the JobsessionId
- - Id an id on an open session with DGC. An existing session
from ConnectionStrategy will be used for this method. If
session is provided, a check will be made to make sure that
the session id matches the one in ConnectionStrategy.csrfToken
- - CSRF Token.Copyright © 2010–2019. All rights reserved.