# Serialized Form

- ## Package com.collibra.dgc.core.api.dto

  - ### Class CursorPagedRequest

    class CursorPagedRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -2437266910255498196L

    - #### Serialized Fields

      - ##### cursor

            String cursor

        Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value. For the next pages, the value must be taken from the response (`nextCursor` property).

  - ### Class CursorPagedResponse

    class CursorPagedResponse extends PagedResponse<T> implements Serializable
    serialVersionUID:
      -5474327239652448988L

    - #### Serialized Fields

      - ##### nextCursor

            String nextCursor

        Cursor value to be passed in next call to retrieve next page of results. Not returned for last page or when offset pagination is used.

  - ### Class PagedRequest

    class PagedRequest extends Object implements Serializable
    serialVersionUID:
      3519734888693302325L

    - #### Serialized Fields

      - ##### countLimit

            int countLimit

        Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

      - ##### limit

            int limit

        The maximum number of results to retrieve. If not set (limit = `0`), the default limit will be used. The maximum allowed limit is 1000.

      - ##### offset

            int offset

        The first result to retrieve. If not set (offset = `0`), results will be retrieved starting from row `0`.

  - ### Class PagedResponse

    class PagedResponse extends Object implements Serializable
    serialVersionUID:
      7699972011312598164L

    - #### Serialized Fields

      - ##### limit

            long limit

        Deprecated.
        This field will become private in the next major release. Methods `PagedResponse.getLimit()`, `PagedResponse.setLimit(long)` should be used instead.
        The maximum number of results to be returned.

      - ##### offset

            long offset

        Deprecated.
        This field will become private in the next major release. Methods `PagedResponse.getOffset()`, `PagedResponse.setOffset(long)` should be used instead.
        The offset for the results.

      - ##### results

            List<T> results

        The list of results.

      - ##### total

            long total

        Deprecated.
        This field will become private in the next major release. Methods `PagedResponse.getTotal()`, `PagedResponse.setTotal(long)` should be used instead.
        The total number of results.

- ## Package com.collibra.dgc.core.api.dto.activitystream

  - ### Class ActivityPagedResponse

    class ActivityPagedResponse extends PagedResponse<Activity> implements Serializable
    serialVersionUID:
      1L

  - ### Class FindActivitiesRequest

    class FindActivitiesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      1710470084924083304L

    - #### Serialized Fields

      - ##### activityType

            ActivityType activityType

        The type of the activity.

      - ##### callCountEnabled

            boolean callCountEnabled

        Flag to indicate if the number of calls standing behind the activity should be returned or not. Note that by default that count will be not calculated as it brings an important performance penalty.

      - ##### callId

            String callId

        The ID of the call.

      - ##### categories

            Set<ActivityFilterCategory> categories

        The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT, STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS].

      - ##### contextId

            UUID contextId

        The ID of the context which the activities should be searched for.

      - ##### endDate

            Long endDate

        The end date of the searched activities, expressed as a Unix timestamp in milliseconds.

      - ##### involvedPeopleIds

            Set<UUID> involvedPeopleIds

        The list of IDs of the people that should be involved in searched activities.

      - ##### involvedRoleIds

            Set<UUID> involvedRoleIds

        The list of IDs of the roles that should be involved in searched activities.

      - ##### performedByRoleIds

            Set<UUID> performedByRoleIds

        The list of IDs of the roles assigned to users who performed searched activities.

      - ##### performedByUserId

            UUID performedByUserId

        The ID of the user who performed searched activities.

      - ##### resourceDiscriminators

            Set<String> resourceDiscriminators

      - ##### resourceTypes

            Set<ResourceType> resourceTypes

        Deprecated, for removal: This API element is subject to removal in a future version.
        Use `FindActivitiesRequest.resourceDiscriminators` instead.
        The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance].

      - ##### startDate

            Long startDate

        The start date of the searched activities, expressed as a Unix timestamp in milliseconds.

      - ##### taskId

            UUID taskId

        The ID of the task which contains the basic find activities request.

- ## Package com.collibra.dgc.core.api.dto.application

- ## Package com.collibra.dgc.core.api.dto.articulation

  - ### Class ArticulationRuleRequest

    class ArticulationRuleRequest extends Object implements Serializable
    serialVersionUID:
      -2329787104025124081L

    - #### Serialized Fields

      - ##### attributeTypeId

            UUID attributeTypeId

        The ID of the attribute type.

      - ##### id

            UUID id

        The ID of the articulation rule.

      - ##### operation

            @NotNull ArticulationOperation operation

        Required. The `operation` ADD or SET.

      - ##### score

            @jakarta.validation.constraints.NotNull double score

        Required. The articulation score (between 0 and 100).

      - ##### statusId

            UUID statusId

        The ID of the status.

- ## Package com.collibra.dgc.core.api.dto.assignment

  - ### Class AddAssignmentRequest

    class AddAssignmentRequest extends Object implements Serializable
    serialVersionUID:
      1669573173430554350L

    - #### Serialized Fields

      - ##### articulationRules

            List<@NotNull @Valid ArticulationRuleRequest> articulationRules

        The articulation rule definitions.

      - ##### assetTypeId

            @NotNull UUID assetTypeId

        Required. The ID of the asset type corresponding to the assignment.

      - ##### characteristicTypes

            @Valid List<@NotNull @Valid CharacteristicTypeAssignmentReference> characteristicTypes

        The list of characteristic types to be assigned, along with their assignment modalities.

      - ##### dataQualityRuleIds

            List<@NotNull UUID> dataQualityRuleIds

        Deprecated.
        The list of data quality rule IDs will be removed from the next major release.
        The list of IDs of the data quality rules.

      - ##### defaultStatusId

            UUID defaultStatusId

        Deprecated.
        The ID of the default status for the asset type. This property will be ignored. The default status is the first status in the list of assigned statuses of the assignment.

      - ##### domainTypeIds

            List<@NotNull UUID> domainTypeIds

        The list of IDs of the domain types.

      - ##### id

            UUID id

        The ID of the new assignment.

      - ##### scopeId

            UUID scopeId

        The ID of the scope the assignment corresponds to.

      - ##### statusIds

            @NotNull @Size(min=1) List<@NotNull UUID> statusIds

        Required. The list of IDs of the statuses. The first element in the list is used as default status id.

      - ##### validationRuleIds

            List<@NotNull UUID> validationRuleIds

        The list of IDs of the validation rules.

  - ### Class AddScopeRequest

    class AddScopeRequest extends Object implements Serializable
    serialVersionUID:
      942509895159971106L

    - #### Serialized Fields

      - ##### communityIds

            List<UUID> communityIds

        The list of IDs for communities assigned to the new scope.

      - ##### description

            @Size(max=255) String description

        The description of the new scope.

      - ##### domainIds

            List<UUID> domainIds

        The list of IDs for domains assigned to the new scope.

      - ##### id

            UUID id

        The ID of the new scope. Should be unique within all scopes. It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new scope.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The public id that will be assigned to the new Scope.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

  - ### Class ChangeAssignmentRequest

    class ChangeAssignmentRequest extends Object implements Serializable
    serialVersionUID:
      -6992997420180418361L

    - #### Serialized Fields

      - ##### articulationRules

            List<@NotNull @Valid ArticulationRuleRequest> articulationRules

        The articulation rule definitions.

      - ##### assignmentId

            @NotNull UUID assignmentId

        Required. The ID of the assignment to change.

      - ##### characteristicTypes

            @Valid List<@NotNull @Valid CharacteristicTypeAssignmentReference> characteristicTypes

        The list of characteristic types to be assigned, along with their assignment modalities.

      - ##### dataQualityRuleIds

            List<@NotNull UUID> dataQualityRuleIds

        Deprecated.
        The list of data quality rule IDs will be removed in the future.
        The list of IDs of the data quality rules.

      - ##### defaultStatusId

            UUID defaultStatusId

        Deprecated.
        The ID of the default status for the asset type. This property will be ignored. The default status is the first status in the list of assigned statuses of the assignment.

      - ##### domainTypeIds

            List<@NotNull UUID> domainTypeIds

        The list of IDs of the domain types.

      - ##### scopeId

            UUID scopeId

        Deprecated.
        The ID of the scope is ignored, and will be removed in the future.
        The ID of the scope the assignment corresponds to.

      - ##### statusIds

            List<@NotNull UUID> statusIds

        The list of IDs of the statuses. The first element in the list is used as default status id.

      - ##### validationRuleIds

            List<@NotNull UUID> validationRuleIds

        The list of IDs of the validation rules.

  - ### Class ChangeScopeRequest

    class ChangeScopeRequest extends Object implements Serializable
    serialVersionUID:
      1669573173430554313L

    - #### Serialized Fields

      - ##### communityIds

            List<UUID> communityIds

        The new list of IDs of communities that should included in the scope.

      - ##### description

            @Size(max=255) String description

        The new description for the scope.

      - ##### domainIds

            List<UUID> domainIds

        The new list of IDs of domains that should included in the scope.

      - ##### id

            @NotNull UUID id

        Required. The ID of the scope to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the scope.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Scope.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

  - ### Class CharacteristicTypeAssignmentReference

    class CharacteristicTypeAssignmentReference extends Object implements Serializable
    serialVersionUID:
      7592414458917402366L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The ID of the reference.

      - ##### max

            Integer max

        The maximum allowed, unlimited when null.

      - ##### min

            @jakarta.validation.constraints.Min(0L) int min

        The minimum allowed.

      - ##### readOnly

            Boolean readOnly

        When set to `true`, the value of the assigned Characteristic Type cannot be edited by the user. Only applicable to AttributeType assignment lines. When `null`, the existing read-only flag is preserved on change paths (allowing clients that pre-date this field to send change requests without unintentionally clearing it).

      - ##### relationTypeDirection

            RelationTypeDirection relationTypeDirection

        The relation type direction, if the referenced resource is a relation type; otherwise null.

      - ##### relationTypeRestriction

            UUID relationTypeRestriction

        The relation type restriction of the target asset type, if the referenced resource is a relation type; otherwise null. When specified, it effectively replaces the source asset type of the relation when relationTypeDirection = TO_SOURCE or the target asset type of the relation when relationTypeDirection = TO_TARGET. You can specify the relation type restriction only when relationTypeDirection is not null. If specified, it must be an ID of a subtype of the source or target asset type, depending on the value of relationTypeDirection.

      - ##### resourceDiscriminator

            @Pattern(regexp="^\\w*AttributeType$|^DerivedRelationType$|^RelationType$|^ComplexRelationType$") String resourceDiscriminator

        Either this field, or the resourceType is required. The resource discriminator. Possible values: 'AttributeType', 'RelationType', 'DerivedRelationType' and 'ComplexRelationType'.

      - ##### type

            ResourceType type

        Deprecated, for removal: This API element is subject to removal in a future version.
        Deprecated in favour of resourceDiscriminator
        Either this field, or the resourceDiscriminator is required. The resource type.

  - ### Class FindAssignmentsForResourceRequest

    class FindAssignmentsForResourceRequest extends Object implements Serializable
    serialVersionUID:
      -8139125494753347206L

    - #### Serialized Fields

      - ##### resourceDiscriminator

            String resourceDiscriminator

      - ##### resourceId

            UUID resourceId

      - ##### resourceType

            ResourceType resourceType

        Deprecated, for removal: This API element is subject to removal in a future version.

  - ### Class RemoveScopeRequest

    class RemoveScopeRequest extends Object implements Serializable
    serialVersionUID:
      1669573173430554313L

    - #### Serialized Fields

      - ##### deleteAssignments

            boolean deleteAssignments

        Indicates any assignments linked to the given scope should also be deleted.

      - ##### scopeId

            @NotNull UUID scopeId

        Required. The ID of the scope to be removed. Silently ignored if the ID is provided as path parameter of the request.

- ## Package com.collibra.dgc.core.api.dto.customization

  - ### Class CustomizationBackup

    class CustomizationBackup extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### data

            InputStream data

        The data of the customization backup.

      - ##### fileName

            String fileName

        The filename of the customization archive.

  - ### Class RestoreCustomizationBackupRequest

    class RestoreCustomizationBackupRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### fileStream

            @NotNull InputStream fileStream

        Required. The file content: a stream of a zip file containing the customization folders.

      - ##### name

            @NotNull @Size(min=1) String name

        Required. The name of the zip archive containing the customizations.

- ## Package com.collibra.dgc.core.api.dto.diagram

  - ### Class AddDiagramPictureRequest

    class AddDiagramPictureRequest extends Object implements Serializable
    serialVersionUID:
      2364899768952303973L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the Asset for which the picture should be taken.

      - ##### viewId

            @NotNull UUID viewId

        Required. The ID of the View for which the picture should be taken.

- ## Package com.collibra.dgc.core.api.dto.file

  - ### Class AddFileRequest

    class AddFileRequest extends Object implements Serializable
    serialVersionUID:
      4072403735523328822L

    - #### Serialized Fields

      - ##### name

            @NotNull @Size(min=1) String name

        Required. The name of the file.

  - ### Class NewFileResponse

    class NewFileResponse extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### fileId

            UUID fileId

- ## Package com.collibra.dgc.core.api.dto.instance.asset

  - ### Class AddAssetRequest

    class AddAssetRequest extends Object implements Serializable
    serialVersionUID:
      -4304958906627022597L

    - #### Serialized Fields

      - ##### displayName

            @Size(min=1,max=2000) String displayName

        The display name of the new asset.

      - ##### domainId

            @NotNull UUID domainId

        Required. The ID of the domain that the new asset should be added to.

      - ##### excludedFromAutoHyperlinking

            Boolean excludedFromAutoHyperlinking

        Whether or not to exclude the new asset from auto hyperlinking.

      - ##### id

            UUID id

        The ID of the new asset.

      - ##### name

            @NotNull @Size(min=1,max=2000) String name

        Required. The full name of the new asset. Should be unique within the domain.

      - ##### statusId

            UUID statusId

        The ID of the status of the new asset.

      - ##### typeId

            UUID typeId

        The ID of the asset type of the new asset.

      - ##### typePublicId

            String typePublicId

        The public ID of the asset type of the new asset.

  - ### Class AddAssetTagsRequest

    class AddAssetTagsRequest extends Object implements Serializable
    serialVersionUID:
      4445853157533710537L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset.

      - ##### tagNames

            @NotNull List<String> tagNames

        Required. The names of the tags to be applied on given asset.

  - ### Class ChangeAssetRequest

    class ChangeAssetRequest extends Object implements Serializable
    serialVersionUID:
      6927939346836723445L

    - #### Serialized Fields

      - ##### displayName

            @Size(min=1,max=2000) String displayName

        The new display name for the asset.

      - ##### domainId

            UUID domainId

        The ID of the new domain for the asset.

      - ##### excludedFromAutoHyperlinking

            Boolean excludedFromAutoHyperlinking

        Whether the asset should be excluded from hyperlinking or not.

      - ##### id

            @NotNull UUID id

        Required. The ID of the asset to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=2000) String name

        The new full name for the asset.

      - ##### statusId

            UUID statusId

        The ID of the new status for the asset.

      - ##### typeId

            UUID typeId

        The ID of the new asset type for the asset.

      - ##### typePublicId

            String typePublicId

        The public ID of the new asset type for the asset.

  - ### Class FindAssetsRequest

    class FindAssetsRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      -6376919145177221741L

    - #### Serialized Fields

      - ##### communityId

            UUID communityId

        The ID of the community to find the assets in.

      - ##### domainId

            UUID domainId

        The ID of the domain to find the assets in.

      - ##### excludeMeta

            boolean excludeMeta

        The exclude meta flag. If this is set to true then the assets from meta domains will not be returned (meta domains are the domains which were not created by the user manually). Defaults to `true`.

      - ##### name

            String name

        The name of the asset to search for (either display name or full name).

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive. Defaults to `ANYWHERE`.

      - ##### sortField

            @NotNull FindAssetsRequest.SortField sortField

        The field on which the results are sorted. Defaults to `NAME`.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order. Defaults to `ASC` (ascending).

      - ##### statusId

            List<UUID> statusId

        Deprecated, for removal: This API element is subject to removal in a future version.
        use statusIds instead
        The list of IDs of the statuses. The returned assets have one of statuses specified by this parameter.

      - ##### statusIds

            List<UUID> statusIds

        The list of IDs of the statuses. The returned assets have one of statuses specified by this parameter.

      - ##### tagNames

            List<String> tagNames

        The list of names of tags. The returned assets have one of tags with names specified by this parameter.

      - ##### typeId

            List<UUID> typeId

        Deprecated, for removal: This API element is subject to removal in a future version.
        typeId has been deprecated, please use typeIds instead.
        The list of IDs of the asset types. The returned assets are of one of types specified by this parameter.

      - ##### typeIds

            List<UUID> typeIds

        The list of IDs of the asset types. The returned assets are of one of types specified by this parameter.

      - ##### typeInheritance

            boolean typeInheritance

        Whether the type inheritance for the asset type filtering should be applied or not. Defaults to `true`.

      - ##### typePublicIds

            List<String> typePublicIds

        The list of IDs of the asset types. The returned assets are of one of types specified by this parameter.

  - ### Class FindRelatedAssetsRequest

    class FindRelatedAssetsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -3921748593016482751L

    - #### Serialized Fields

      - ##### relationDirection

            RelationDirection relationDirection

        The direction in which the relation is traversed. Use `RelationDirection.TO_TARGET` to follow relations from the source asset to their targets, or `RelationDirection.TO_SOURCE` to follow relations in the opposite direction.

      - ##### relationTypePublicId

            String relationTypePublicId

        The public ID of the relation type to traverse (e.g. `"ColumnIsPartOfTable"`).

      - ##### sourceAssetId

            UUID sourceAssetId

        The ID of the asset whose relations are traversed.

  - ### Class RemoveAssetTagsRequest

    class RemoveAssetTagsRequest extends Object implements Serializable
    serialVersionUID:
      7729115666569797062L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset.

      - ##### tagNames

            @NotNull List<String> tagNames

        Required. The names of the tags to be removed from given asset.

  - ### Class SetAssetAttributesRequest

    class SetAssetAttributesRequest extends Object implements Serializable
    serialVersionUID:
      8727738157645905193L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset this attribute should belong to.

      - ##### typeId

            UUID typeId

        The ID of the attribute type for the new attribute.

      - ##### typePublicId

            String typePublicId

        The public ID of the attribute type for the new attribute.

      - ##### values

            @NotNull List<Object> values

        Required. The values for the new attribute.

  - ### Class SetAssetRelationsRequest

    class SetAssetRelationsRequest extends Object implements Serializable
    serialVersionUID:
      3003390682541962423L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset.

      - ##### relatedAssetIds

            @NotNull List<UUID> relatedAssetIds

        Required. The IDs of the related assets.

      - ##### relationDirection

            @NotNull SetAssetRelationsRequest.RelationDirection relationDirection

        The relation direction. If TO_SOURCE then related assets will become source assets. Otherwise they will become target assets for created relations.

      - ##### typeId

            UUID typeId

        Required. The ID of the relation type for the relations to be set.

      - ##### typePublicId

            String typePublicId

        The public ID of the relation type for the relations to be set.

  - ### Class SetAssetResponsibilitiesRequest

    class SetAssetResponsibilitiesRequest extends Object implements Serializable
    serialVersionUID:
      3003390682541962423L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset.

      - ##### ownerIds

            @NotNull List<UUID> ownerIds

        Required. The IDs of the owners. An owner is either user or group.

      - ##### roleId

            @NotNull UUID roleId

        Required. The ID of the role for the responsibilities to be set.

  - ### Class SetAssetTagsRequest

    class SetAssetTagsRequest extends Object implements Serializable
    serialVersionUID:
      1261881752266975880L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset.

      - ##### tagNames

            @NotNull List<String> tagNames

        Required. The names of the tags to be applied on given asset.

- ## Package com.collibra.dgc.core.api.dto.instance.attachment

  - ### Class AddAttachmentRequest

    class AddAttachmentRequest extends Object implements Serializable
    serialVersionUID:
      -4134742172173092259L

    - #### Serialized Fields

      - ##### baseResource

            @NotNull @Valid ResourceReference baseResource

        Required. The reference to the resource new attachment should be attached to. An attachment can be added on those resource types: User, Community, Domain, Asset.

      - ##### file

            @NotNull @Valid AddAttachmentRequest.FileReference file

        Required. The reference to the file representing new attachment.

  - ### Class AddAttachmentRequest.FileReference

    class FileReference extends Object implements Serializable
    serialVersionUID:
      -3016675135764241512L

    - #### Serialized Fields

      - ##### fileId

            UUID fileId

        The file id for attachment. It could not be used together with `fileStream`.

      - ##### fileStream

            InputStream fileStream

        The file content for attachment. It could not be used together with `fileId`.

      - ##### name

            @NotNull @Size(min=1) String name

        The display name of the file of this attachment.

  - ### Class FindAttachmentsRequest

    class FindAttachmentsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      8082794557106983905L

    - #### Serialized Fields

      - ##### baseResourceId

            UUID baseResourceId

        The ID of the resource the attachment refers to.

      - ##### fileContentType

            String fileContentType

        The type of the content of the file representing searched attachment.

      - ##### fileName

            String fileName

        The name of the file representing searched attachment.

      - ##### scanState

            AntivirusScanState scanState

      - ##### sortField

            FindAttachmentsRequest.SortField sortField

        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting.

      - ##### uploadDate

            Long uploadDate

        The date of attachment upload. It is the timestamp (in UTC time standard).

      - ##### userId

            UUID userId

        The ID of the user who uploaded the attachment.

- ## Package com.collibra.dgc.core.api.dto.instance.attribute

  - ### Class AddAttributeRequest

    class AddAttributeRequest extends Object implements Serializable
    serialVersionUID:
      8727738157645905193L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset this attribute should belong to.

      - ##### typeId

            UUID typeId

        The ID of the attribute type for the new attribute.

      - ##### typePublicId

            String typePublicId

        The public ID of the attribute type for the new attribute.

      - ##### value

            @NotNull Object value

        Required. The value of this attribute. Expected type of the value depends on the type of the attribute.

        The following list presents type of the value depending on the kind of the attribute.

        - kind: `NumericAttribute` -> value Class: `Double` or `String`
        - kind: `ScriptAttribute` -> value Class: `String`
        - kind: `SingleValueListAttribute` -> value Class: `String`
        - kind: `DateAttribute` -> value class: `Long` or `String`
        - kind: `StringAttribute` -> value class: `String`
        - kind: `BooleanAttribute` -> value class: `Boolean` or `String`
        - kind: `MultiValueListAttribute` -> value class: `List` of `String`

  - ### Class ChangeAttributeRequest

    class ChangeAttributeRequest extends Object implements Serializable
    serialVersionUID:
      8727738157645905193L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The ID of the attribute to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### value

            @NotNull Object value

        Required. The value of this attribute. Expected type of the value depends on the type of the attribute. Following list presents type of the value depending on the kind of the attribute
        - kind: `NumericAttribute` -> value Class: `Double` or `String`
        - kind: `ScriptAttribute` -> value Class: `String`
        - kind: `SingleValueListAttribute` -> value Class: `String`
        - kind: `DateAttribute` -> value class: `Long` or `String`
        - kind: `StringAttribute` -> value class: `String`
        - kind: `BooleanAttribute` -> value class: `Boolean` or `String`
        - kind: `MultiValueListAttribute` -> value class: `List` of `String`

  - ### Class FindAttributesRequest

    class FindAttributesRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      -8042689116780117516L

    - #### Serialized Fields

      - ##### assetId

            UUID assetId

        The ID of the asset to find the attributes in, or null if no asset filtering should be applied.

      - ##### sortField

            @NotNull FindAttributesRequest.SortField sortField

        The field on which the results are sorted. Defaults to `LAST_MODIFIED`.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order. Defaults to `DESC`. (descending)

      - ##### typeIds

            List<UUID> typeIds

        The list of IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

      - ##### typePublicIds

            List<String> typePublicIds

        The list of public IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

- ## Package com.collibra.dgc.core.api.dto.instance.comment

  - ### Class AddCommentRequest

    class AddCommentRequest extends Object implements Serializable
    serialVersionUID:
      479180967890225791L

    - #### Serialized Fields

      - ##### baseResource

            @Valid ResourceReference baseResource

        Deprecated, for removal: This API element is subject to removal in a future version.
        Please use the combination of `AddCommentRequest.commentableResourceId` and `AddCommentRequest.commentableResourceDiscriminator`
        The resource which the new comment should be attached to. For a Comment, the resourceType/resourceDiscriminator of a baseResource can be: `Asset`, `Domain`, `Community`, `Rating`

      - ##### commentableResourceDiscriminator

            String commentableResourceDiscriminator

        The discriminator of the resource to which the new comment should be attached to. The combination of `AddCommentRequest.commentableResourceId` and `AddCommentRequest.commentableResourceDiscriminator` replaces the `AddCommentRequest.baseResource` field. These should not be used together.Possible values for a discriminator of a Commentable Resource are: `Asset`, `Domain`, `Community`, `Rating`

      - ##### commentableResourceId

            UUID commentableResourceId

        The identifier of the resource to which the new comment should be attached to. The combination of `AddCommentRequest.commentableResourceId` and `AddCommentRequest.commentableResourceDiscriminator` replaces the `AddCommentRequest.baseResource` field. These should not be used together.

      - ##### content

            @NotNull @Size(min=1) String content

        Required. The actual HTML content of the comment to be added. Can contain user mentions using syntax `[@User:$userId]` where $userId is the ID of mentioned user. For example: `[@User:00000000-0000-0000-0000-000000900002]`.

      - ##### parentId

            UUID parentId

        The id of the parent comment. If not null - the comment is the reply for the parent comment. Comment threads are not supported, replying to a reply will cause an illegal argument exception.

  - ### Class ChangeCommentRequest

    class ChangeCommentRequest extends Object implements Serializable
    serialVersionUID:
      8185455416601910760L

    - #### Serialized Fields

      - ##### content

            @Size(min=1) String content

        The new content of the comment to be changed. Can contain user mentions using syntax `[@User:$userId]` where $userId is the ID of mentioned user.

      - ##### id

            @NotNull UUID id

        Required. The ID of the comment to be changed.

      - ##### resolved

            Boolean resolved

        Whether the comment is resolved.

  - ### Class FindCommentsRequest

    class FindCommentsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      8082794557106983005L

    - #### Serialized Fields

      - ##### baseResourceId

            UUID baseResourceId

        The ID of the resource which the searched comments refer to.

      - ##### parentId

            UUID parentId

        The ID of the comment which the reply comments should be searched for.

      - ##### resolved

            Boolean resolved

        Whether the searched comments should be resolved.

      - ##### rootComment

            Boolean rootComment

        Whether the searched comments should be root comments (not reply comments).

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting on the date the comment was created.

      - ##### userId

            UUID userId

        The ID of the user. By default, filters comments to include only those created by this user.

      - ##### userThreads

            Boolean userThreads

        Specifies whether to search for root comments created by or mentioning the user `userId`, or root comments with replies created by or mentioning the user `userId`.

- ## Package com.collibra.dgc.core.api.dto.instance.community

  - ### Class AddCommunityRequest

    class AddCommunityRequest extends Object implements Serializable
    serialVersionUID:
      -7134669093597681253L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the new community.

      - ##### id

            UUID id

        The ID of the new community.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name (required) of the new community. Should be unique across all communities.

      - ##### parentId

            UUID parentId

        The ID of the parent for the new community.

  - ### Class ChangeCommunityRequest

    class ChangeCommunityRequest extends Object implements Serializable
    serialVersionUID:
      2701658781848199466L

    - #### Serialized Fields

      - ##### description

            String description

        The new description for the community.

      - ##### id

            @NotNull UUID id

        Required. The ID of the community to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the community.

      - ##### parentId

            UUID parentId

        The ID of the new parent community for the community.

      - ##### removeScopeOverlapOnMove

            Boolean removeScopeOverlapOnMove

        Whether scopes assigned to community and its children should be removed on move if there are any inherited scopes in new parent community.

  - ### Class FindCommunitiesRequest

    class FindCommunitiesRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      559348336687254992L

    - #### Serialized Fields

      - ##### excludeMeta

            boolean excludeMeta

        The exclude meta flag. If this is set to true then the meta communities will not be returned (meta communities are i.e. communities not created manually by the user). Defaults to `true`.

      - ##### name

            String name

        The name of the community to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive. Defaults to `ANYWHERE`.

      - ##### parentId

            UUID parentId

        The ID of the parent community to find the communities in.

      - ##### sortField

            @NotNull FindCommunitiesRequest.SortField sortField

        The field on which the results are sorted. Defaults to `NAME`.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order. Defaults to `ASC` (ascending).

- ## Package com.collibra.dgc.core.api.dto.instance.complexrelation

  - ### Class AddComplexRelationRequest

    class AddComplexRelationRequest extends Object implements Serializable
    serialVersionUID:
      1541556244992555085L

    - #### Serialized Fields

      - ##### attributes

            Map<UUID,List<AttributeValue>> attributes

        Deprecated.
        use `AddComplexRelationRequest.attributesForTypePublicId` instead.
        The attributes that the new complex relation should contain.

      - ##### attributesForTypePublicId

            Map<String,List<AttributeValue>> attributesForTypePublicId

        The attributes that the new complex relation should contain, with types identified by public ID.

      - ##### complexRelationTypeId

            UUID complexRelationTypeId

        Required. The ID of the type of the complex relation.

      - ##### complexRelationTypePublicId

            String complexRelationTypePublicId

        The public ID of the type of the complex relation.

      - ##### id

            UUID id

        The ID of the new complex relation.

      - ##### legs

            List<ComplexRelationLegRequest> legs

        The list of legs that the new complex relation should contain.

      - ##### relations

            Map<RelationTypeIdWithDirection,List<RelatedAssetId>> relations

        The relations that the new complex relation should contain.

  - ### Class AttributeValue

    class AttributeValue extends Object implements Serializable
    serialVersionUID:
      6018845046785127759L

    - #### Serialized Fields

      - ##### value

            String value

      - ##### values

            List<String> values

  - ### Class ChangeComplexRelationRequest

    class ChangeComplexRelationRequest extends Object implements Serializable
    serialVersionUID:
      1541556244992555085L

    - #### Serialized Fields

      - ##### attributes

            Map<UUID,List<AttributeValue>> attributes

        Deprecated.
        use `ChangeComplexRelationRequest.attributesForTypePublicId` instead
        The new attributes that the new complex relation should contain.

      - ##### attributesForTypePublicId

            Map<String,List<AttributeValue>> attributesForTypePublicId

        The new attributes that the new complex relation should contain, designated by type public ID.

      - ##### id

            @NotNull UUID id

        Required. The ID of the complex relation to be changed.

      - ##### legs

            List<ComplexRelationLegRequest> legs

        The new list of legs that the changed complex relation should contain.

      - ##### partialAttributesUpdate

            boolean partialAttributesUpdate

        When partialAttributesUpdate is false, all existing attribute values are replaced by the provided ones. If no value is provided for an attribute type, then all corresponding values are removed. When partialAttributesUpdate is true, only the values for the attribute types provided in the request are replaced. If no value is provided for one of them, then the existing values are kept. The default parameter value is false.

      - ##### relations

            Map<RelationTypeIdWithDirection,List<RelatedAssetId>> relations

        The new relations that the new complex relation should contain.

  - ### Class ComplexRelationAttributeRequest

    class ComplexRelationAttributeRequest extends Object implements Serializable
    serialVersionUID:
      1541512347772555085L

    - #### Serialized Fields

      - ##### attributeTypeId

            @NotNull UUID attributeTypeId

        Required. The ID of the type of the single attribute for complex relation.

      - ##### value

            List<String> value

        The value of the attribute attached to the complex relation.

  - ### Class ComplexRelationLegRequest

    class ComplexRelationLegRequest extends Object implements Serializable
    serialVersionUID:
      -3339681084926543304L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset attached to the leg of the complex relation.

      - ##### legTypeId

            UUID legTypeId

        Deprecated, for removal: This API element is subject to removal in a future version.
        Use `ComplexRelationLegRequest.relationTypePublicId` instead.
        The ID of the type of the single leg for complex relation. Must be specified if `ComplexRelationLegRequest.relationTypeId` and `ComplexRelationLegRequest.relationTypePublicId` are not specified.

      - ##### relationTypeId

            UUID relationTypeId

        The ID of the type of the relation for complex relation. Must be specified if `ComplexRelationLegRequest.legTypeId` and `ComplexRelationLegRequest.relationTypePublicId` are not specified.

      - ##### relationTypePublicId

            String relationTypePublicId

        The public ID of the type of the relation of the leg. Must be specified if `ComplexRelationLegRequest.legTypeId` and `ComplexRelationLegRequest.relationTypeId` are not specified.

  - ### Class ExportComplexRelationsRequest

    class ExportComplexRelationsRequest extends Object implements Serializable
    serialVersionUID:
      8865982058601631861L

    - #### Serialized Fields

      - ##### complexRelationTypeId

            @NotNull UUID complexRelationTypeId

        Required. The ID of the ComplexRelationType for which the export will be executed.

      - ##### domainId

            UUID domainId

        The ID of the Domain to filter on (optional).

      - ##### fileName

            String fileName

        The name of the file. (optional) if not provided a name is generated.

      - ##### includeHeaderRow

            boolean includeHeaderRow

        Set if the file will include a header (`true`) or not (`false`). Default value is `false`.

      - ##### removeFormatting

            boolean removeFormatting

        Remove text formatting (`true`) or not (`false`). Default value is `false`.

      - ##### storeAsAttachment

            boolean storeAsAttachment

        Sets if the export should be stored as an attachment (`true`) or not (`false`) of the provided `ExportComplexRelationsRequest.domainId`.

      - ##### supportRoundtrip

            boolean supportRoundtrip

        Adds characteristics to support reimport (`true`) or not (`false`). Default value is `false`.

  - ### Class ExportComplexRelationsToCSVRequest

    class ExportComplexRelationsToCSVRequest extends ExportComplexRelationsRequest implements Serializable
    serialVersionUID:
      -3415665328794103332L

    - #### Serialized Fields

      - ##### escape

            String escape

        The delimiter character used to escape separator or quote character. If not provided default value `'\\'` is used.

      - ##### quote

            String quote

        The delimiter character used for quoted entries. If not provided default value `'\"'` is used.

      - ##### separator

            String separator

        The delimiter character used to separate entries. If not provided default value `';'` is used.

  - ### Class ExportComplexRelationsToExcelRequest

    class ExportComplexRelationsToExcelRequest extends ExportComplexRelationsRequest implements Serializable
    serialVersionUID:
      -1509009018447611143L

    - #### Serialized Fields

      - ##### sheetName

            String sheetName

        The name of the sheet

      - ##### xlsx

            boolean xlsx

        Deprecated.
        The parameter will be removed. In the future only XLSX files will be supported.
        Set if the Excel file to export will be '.xlsx' file (`true`) or a '.xls' file (`false`) Default value is (`true`)

  - ### Class FindComplexRelationsRequest

    class FindComplexRelationsRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      -5355166209546738908L

    - #### Serialized Fields

      - ##### assetId

            UUID assetId

        The ID of the asset for which complex relations should be found.

      - ##### typeId

            UUID typeId

        The ID of the type of complex relations to search for.

      - ##### typePublicIds

            List<String> typePublicIds

        The The list of Public ID of the type of complex relations to search for.

  - ### Class RelatedAssetId

    class RelatedAssetId extends Object implements Serializable
    serialVersionUID:
      -1389880689781496877L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. the id of the related asset

  - ### Class RelationTypeIdWithDirection

    class RelationTypeIdWithDirection extends Object implements Serializable
    serialVersionUID:
      -7755361135109661767L

    - #### Serialized Fields

      - ##### direction

            @NotNull RelationTypeIdWithDirection.Direction direction

        Required. The direction of the relation.

      - ##### relationTypeId

            UUID relationTypeId

        Deprecated.
        use `RelationTypeIdWithDirection.relationTypePublicId` instead.
        Required. The ID of the relation type.

      - ##### relationTypePublicId

            String relationTypePublicId

        The public ID of the relation type.

- ## Package com.collibra.dgc.core.api.dto.instance.domain

  - ### Class AddDomainRequest

    class AddDomainRequest extends Object implements Serializable
    serialVersionUID:
      -6857066519914882555L

    - #### Serialized Fields

      - ##### communityId

            @NotNull UUID communityId

        Required. The ID of the community that the new domain should be added to.

      - ##### description

            String description

        The description of the new domain.

      - ##### excludedFromAutoHyperlinking

            Boolean excludedFromAutoHyperlinking

      - ##### id

            UUID id

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new domain. Should be unique within the community.

      - ##### typeId

            UUID typeId

        The ID of the domain type of the new domain.

      - ##### typePublicId

            String typePublicId

        The public ID of the domain type of the new domain.

  - ### Class ChangeDomainRequest

    class ChangeDomainRequest extends Object implements Serializable
    serialVersionUID:
      -4375406183218766399L

    - #### Serialized Fields

      - ##### communityId

            UUID communityId

        The ID of the new community for the domain.

      - ##### description

            String description

        The new description for the domain.

      - ##### excludedFromAutoHyperlinking

            Boolean excludedFromAutoHyperlinking

        Whether the domain should be excluded from hyperlinking or not.

      - ##### id

            @NotNull UUID id

        Required. The ID of the domain to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the domain.

      - ##### removeScopeOverlapOnMove

            Boolean removeScopeOverlapOnMove

        Whether scopes assigned to domain should be removed on move if there are any inherited scopes in new community.

      - ##### typeId

            UUID typeId

        The ID of the new domain type for the domain.

      - ##### typePublicId

            String typePublicId

        The public ID of the new domain type for the domain.

  - ### Class FindDomainsRequest

    class FindDomainsRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      1234534888693302325L

    - #### Serialized Fields

      - ##### communityId

            UUID communityId

        The ID of the community to find the domains in.

      - ##### excludeMeta

            boolean excludeMeta

        The exclude meta flag. If this is set to true then the meta domains will not be returned (meta domains are i.e. domains not created manually by the user). Defaults to `true`.

      - ##### includeSubCommunities

            boolean includeSubCommunities

        whether to include sub-communities. When `true`, direct sub-communities of the community referenced by the `communityId` parameter are also included in the search. Sub-communities of those sub-communities are not included.

      - ##### name

            String name

        The name of the domain to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive. Defaults to `ANYWHERE`.

      - ##### typeId

            UUID typeId

        The ID of the domain type to search for. Returned domains are of this type. Ignored if `typeIds` is also provided.

      - ##### typeIds

            List<UUID> typeIds

        The IDs of the domain types to search for. Returned domains are of these types. When provided, `typeId` is ignored.

      - ##### typePublicId

            String typePublicId

        The public ID of the domain type to search for. Returned domains are of this type.

- ## Package com.collibra.dgc.core.api.dto.instance.issue

  - ### Class AddIssueRequest

    class AddIssueRequest extends Object implements Serializable
    serialVersionUID:
      472032504269998260L

    - #### Serialized Fields

      - ##### categoryIds

            List<UUID> categoryIds

        The list of IDs of assets which represent categories for this issue. Each asset in this list should be of type Issue Category.

      - ##### description

            @NotNull String description

        Required. The description for the issue.

      - ##### name

            @NotNull String name

        Required. The name of the subject for which the issue is being created.

      - ##### priority

            String priority

        The priority for the issue.

      - ##### relatedAssets

            List<RelatedAssetReference> relatedAssets

        The list of assets which the issue is related to.

      - ##### requesterId

            UUID requesterId

        The requester of the issue.

      - ##### responsibleCommunityId

            UUID responsibleCommunityId

        The ID of the community responsible for handling the issue.

      - ##### typeId

            @NotNull UUID typeId

        Required. The type ID of the issue to be created.

  - ### Class FindIssuesRequest

    class FindIssuesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -356203156619934320L

    - #### Serialized Fields

      - ##### onlyOpenIssues

            boolean onlyOpenIssues

        Whether only open issues should be returned.

      - ##### sortField

            FindIssuesRequest.SortField sortField

        The field on which the results are sorted. Default is `NAME`.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order of the results.

      - ##### userRelation

            FindIssuesRequest.IssueUserRelation userRelation

        The relation of the user with the issues to be returned. By default all issues for the current user will be returned.

  - ### Class MoveIssueRequest

    class MoveIssueRequest extends Object implements Serializable
    serialVersionUID:
      -8608862918986285785L

    - #### Serialized Fields

      - ##### communityId

            @NotNull UUID communityId

        Required. The id of the community where to move the issue to.

      - ##### issueId

            @NotNull UUID issueId

        Required. The id of the issue to be moved.

  - ### Class RelatedAssetReference

    class RelatedAssetReference extends Object implements Serializable
    serialVersionUID:
      472032114269998260L

    - #### Serialized Fields

      - ##### assetId

            UUID assetId

        The ID of the asset which the issue is related to.

      - ##### direction

            Boolean direction

        The direction of the relation where true means the issue is the source and false means the issue is the target.

      - ##### relationTypeId

            UUID relationTypeId

        The ID of relation type for related asset.

- ## Package com.collibra.dgc.core.api.dto.instance.jdbc

  - ### Class FindJdbcDriverRequest

    class FindJdbcDriverRequest extends PagedRequest implements Serializable
    serialVersionUID:
      456786543456L

    - #### Serialized Fields

      - ##### databaseName

            String databaseName

      - ##### databaseVersion

            String databaseVersion

- ## Package com.collibra.dgc.core.api.dto.instance.rating

  - ### Class AddRatingRequest

    class AddRatingRequest extends Object implements Serializable
    serialVersionUID:
      -8426540823242972169L

    - #### Serialized Fields

      - ##### assetId

            @NotNull UUID assetId

        Required. The ID of the asset to which rating will be assigned.

      - ##### rating

            @NotNull Double rating

        Required. The rating value of the new rating. Allowed values are {0.2, 0.4, 0.6, 0.8, 1.0} (e.g., 0.2 for 1 star, 1.0 for 5 stars).

      - ##### review

            String review

        The text field which could be optionally added with rating.

  - ### Class ChangeRatingRequest

    class ChangeRatingRequest extends Object implements Serializable
    serialVersionUID:
      6048664031566226755L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The ID of the rating.

      - ##### rating

            @NotNull Double rating

        Required. The new rating value. Allowed values are {0.2, 0.4, 0.6, 0.8, 1.0} (e.g., 0.2 for 1 star, 1.0 for 5 stars).

      - ##### review

            String review

        The new review value.

  - ### Class FindRatingsRequest

    class FindRatingsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5047766018507303838L

    - #### Serialized Fields

      - ##### assetId

            UUID assetId

        The ID of the asset to which the rating belongs to.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting on the date the rating was created.

      - ##### userId

            UUID userId

        The ID of the rating's author.

- ## Package com.collibra.dgc.core.api.dto.instance.relation

  - ### Class AddRelationRequest

    class AddRelationRequest extends Object implements Serializable
    serialVersionUID:
      2373658319931435563L

    - #### Serialized Fields

      - ##### endingDate

            Long endingDate

        Deprecated, for removal: This API element is subject to removal in a future version.
        To be removed without replacement.
        The ending date of the relation.

      - ##### sourceId

            @NotNull UUID sourceId

        Required. The ID of the source of the relation.

      - ##### startingDate

            Long startingDate

        Deprecated, for removal: This API element is subject to removal in a future version.
        To be removed without replacement.
        The starting date of the relation.

      - ##### targetId

            @NotNull UUID targetId

        Required. The ID of the target of the relation.

      - ##### typeId

            UUID typeId

        The ID of the type of the relation.

      - ##### typePublicId

            String typePublicId

        The public ID of the type of the relation.

  - ### Class ChangeRelationRequest

    class ChangeRelationRequest extends Object implements Serializable
    serialVersionUID:
      -652664819561894343L

    - #### Serialized Fields

      - ##### endingDate

            Long endingDate

        Deprecated, for removal: This API element is subject to removal in a future version.
        To be removed without replacement.
        The new ending date for the relation.

      - ##### id

            @NotNull UUID id

        Required. The ID of the relation that will be changed.

        Silently ignored if the ID is provided as path parameter of the request.

      - ##### sourceId

            UUID sourceId

        The ID of the new source for the relation.

      - ##### startingDate

            Long startingDate

        Deprecated, for removal: This API element is subject to removal in a future version.
        To be removed without replacement.
        The new starting date for the relation.

      - ##### targetId

            UUID targetId

        The ID of the new target for the relation.

  - ### Class FindRelationsRequest

    class FindRelationsRequest extends CursorPagedRequest implements Serializable
    serialVersionUID:
      73847268423L

    - #### Serialized Fields

      - ##### relationTypeId

            UUID relationTypeId

        The ID of the type of relations to search for.

      - ##### sourceId

            UUID sourceId

        The ID of the source of relations to search for.

      - ##### sourceTargetLogicalOperator

            LogicalOperator sourceTargetLogicalOperator

        The logical operator determining how to combine the source and target criteria: AND or OR. Defaults to `AND`.

      - ##### targetId

            UUID targetId

        The ID of the target of relations to search for.

      - ##### typePublicId

            String typePublicId

        The public ID of the type of relations to search for.

- ## Package com.collibra.dgc.core.api.dto.instance.responsibility

  - ### Class AddResponsibilityRequest

    class AddResponsibilityRequest extends Object implements Serializable
    serialVersionUID:
      2438944044465196681L

    - #### Serialized Fields

      - ##### ownerId

            @NotNull UUID ownerId

        Required. The ID of the user who the responsibility is created for.

      - ##### resourceDiscriminator

            String resourceDiscriminator

        The discriminator for distinguishing the type of the resource which the responsibility is created for. Valid values are : "Community", "Domain" or "Asset"

      - ##### resourceId

            UUID resourceId

        The ID of the resource which the responsibility is created for. NOTE: if null, a global responsibility is created.

      - ##### resourceType

            ResourceType resourceType

        Deprecated, for removal: This API element is subject to removal in a future version.
        This property will be removed in the future. Use `AddResponsibilityRequest.resourceDiscriminator` instead.
        The type of the resource for which the Responsibility is created. The value should be one of [Community, Asset, Domain]. Deprecated in favour of resourceDiscriminator. If both are present, the value of resourceDiscriminator will be used.

      - ##### roleId

            @NotNull UUID roleId

        Required. The ID of the role that should be assigned to user.

  - ### Class FindResponsibilitiesRequest

    class FindResponsibilitiesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -4194144446109022848L

    - #### Serialized Fields

      - ##### excludeEmptyGroups

            boolean excludeEmptyGroups

        Whether responsibilities that are only assigned to empty groups should be excluded.

      - ##### globalOnly

            boolean globalOnly

        Deprecated.
        Whether only global responsibilities should be searched.

      - ##### includeInherited

            boolean includeInherited

        Whether inherited responsibilities should be included in the search results.

      - ##### ownerIds

            List<UUID> ownerIds

        The list of IDs of the owners for which the responsibilities should be found.

      - ##### resourceIds

            List<UUID> resourceIds

        The list of IDs of the resources for which the responsibilities should be found.

      - ##### roleIds

            List<UUID> roleIds

        The list of IDs of the roles for which the responsibilities should be found.

      - ##### sortField

            FindResponsibilitiesRequest.SortField sortField

        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting.

      - ##### type

            FindResponsibilitiesRequest.TypeMatchMode type

        Indicates which type of responsibilities should be searched for. Usage is mutually exclusive with the deprecated `FindResponsibilitiesRequest.globalOnly` flag.

- ## Package com.collibra.dgc.core.api.dto.job

  - ### Class CancelJobRequest

    class CancelJobRequest extends Object implements Serializable
    serialVersionUID:
      -4950372958263664416L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The id of the job to cancel.

      - ##### message

            String message

        A message for the cancellation.

  - ### Class FindJobsRequest

    class FindJobsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -8680940115213425612L

    - #### Serialized Fields

      - ##### createdBy

            UUID createdBy

        The ID of the user who created the searched job.

      - ##### maxVisibility

            int maxVisibility

        Deprecated, for removal: This API element is subject to removal in a future version.
        Ignored, use visible instead, this will be removed in the future.
        The maximum visibility of the job. Defaults to no limit on visibility.

      - ##### name

            String name

        The name of the job to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode for the name.

      - ##### results

            List<JobResult> results

        The list of results which the jobs should be searched for.

      - ##### sortField

            FindJobsRequest.SortField sortField

        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting.

      - ##### states

            List<JobState> states

        The list of states which the jobs should be searched for.

      - ##### types

            List<String> types

        The list of types of the jobs.

      - ##### visible

            Boolean visible

        The visibility of the jobs. Defaults to all jobs (both visible and non-visible).

- ## Package com.collibra.dgc.core.api.dto.mapping

  - ### Class AddMappingRequest

    class AddMappingRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the mapped resource.

      - ##### externalEntityId

            @NotNull @Size(min=1,max=255) String externalEntityId

        Required. The external ID of the mapped resource.

      - ##### externalEntityUrl

            @Size(min=1,max=255) String externalEntityUrl

        The external URL of the mapped resource.

      - ##### externalSystemId

            @NotNull @Size(min=1,max=36) String externalSystemId

        Required. The ID of the external system that the mapped resource belongs to.

      - ##### id

            UUID id

        The ID of the new mapping.

      - ##### lastSyncDate

            Long lastSyncDate

        The timestamp (in UTC time standard) of the last synchronization of mapped resource.

      - ##### mappedResourceId

            @NotNull UUID mappedResourceId

        The ID of the mapped resource.

      - ##### syncAction

            SyncAction syncAction

        The type of the action performed during last successful synchronization.

  - ### Class ChangeMappingByExternalEntityRequest

    class ChangeMappingByExternalEntityRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the mapped resource.

      - ##### externalEntityId

            @NotNull @Size(min=1,max=255) String externalEntityId

        Required. The external ID of the mapped resource.

      - ##### externalEntityUrl

            @Size(min=1,max=255) String externalEntityUrl

        The external URL of the mapped resource.

      - ##### externalSystemId

            @NotNull @Size(min=1,max=36) String externalSystemId

        Required. The ID of the external system that the mapped resource belongs to.

      - ##### lastSyncDate

            Long lastSyncDate

        The timestamp (in UTC time standard) of the last synchronization of mapped resource.

      - ##### mappedResourceId

            UUID mappedResourceId

        The ID of the mapped resource.

      - ##### syncAction

            SyncAction syncAction

        The type of the action performed during last successful synchronization.

  - ### Class ChangeMappingByMappedResourceRequest

    class ChangeMappingByMappedResourceRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the mapped resource.

      - ##### externalEntityId

            @Size(min=1,max=255) String externalEntityId

        The external ID of the mapped resource.

      - ##### externalEntityUrl

            @Size(min=1,max=255) String externalEntityUrl

        The external URL of the mapped resource.

      - ##### externalSystemId

            @NotNull @Size(min=1,max=36) String externalSystemId

        Required. The ID of the external system that the mapped resource belongs to.

      - ##### lastSyncDate

            Long lastSyncDate

        The timestamp (in UTC time standard) of the last synchronization of mapped resource.

      - ##### mappedResourceId

            @NotNull UUID mappedResourceId

        Required. The ID of the mapped resource.

      - ##### syncAction

            SyncAction syncAction

        The type of the action performed during last successful synchronization.

  - ### Class ChangeMappingRequest

    class ChangeMappingRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the mapped resource.

      - ##### externalEntityId

            @Size(min=1,max=255) String externalEntityId

        The external ID of the mapped resource.

      - ##### externalEntityUrl

            @Size(min=1,max=255) String externalEntityUrl

        The external URL of the mapped resource.

      - ##### externalSystemId

            @Size(min=1,max=36) String externalSystemId

        The ID of the external system that the mapped resource belongs to.

      - ##### id

            @NotNull UUID id

        Required. The ID of the mapping to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### lastSyncDate

            Long lastSyncDate

        The timestamp (in UTC time standard) of the last synchronization of mapped resource.

      - ##### mappedResourceId

            UUID mappedResourceId

        The ID of the mapped resource.

      - ##### syncAction

            SyncAction syncAction

        The type of the action performed during last successful synchronization.

  - ### Class FindMappingsRequest

    class FindMappingsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### externalEntityId

            @Size(min=1,max=255) String externalEntityId

      - ##### externalSystemId

            @Size(min=1,max=36) String externalSystemId

        The ID of the external system that the mapped resource belongs to.

      - ##### mappedResourceId

            @Size(min=1,max=36) String mappedResourceId

      - ##### mappedResourceType

            FindMappingsRequest.MappedResourceType mappedResourceType

        The type of the mapped resource.

      - ##### syncAction

            SyncAction syncAction

        The type of the action performed during last successful synchronization.

  - ### Class GetMappingByExternalEntityRequest

    class GetMappingByExternalEntityRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### externalEntityId

            @NotNull @Size(min=1,max=255) String externalEntityId

        Required. The external ID of the mapped resource.

      - ##### externalSystemId

            @NotNull @Size(min=1,max=36) String externalSystemId

        Required. The ID of the external system that the mapped resource belongs to.

  - ### Class GetMappingByMappedResourceRequest

    class GetMappingByMappedResourceRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### externalSystemId

            @NotNull @Size(min=1,max=36) String externalSystemId

        The ID of the external system that the mapped resource belongs to.

      - ##### mappedResourceId

            @NotNull UUID mappedResourceId

        The ID of the mapped resource.

- ## Package com.collibra.dgc.core.api.dto.meta.assettype

  - ### Class AddAssetTypeRequest

    class AddAssetTypeRequest extends Object implements Serializable
    serialVersionUID:
      -1456195549472481391L

    - #### Serialized Fields

      - ##### acronymCode

            @Pattern(regexp="^([A-Za-z0-9]{1,4})$") String acronymCode

        A code representing the acronym that should be shown. Must have at least 1 and at most 4 alphanumeric characters.

      - ##### color

            @Size(max=7) @Pattern(regexp="^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$") String color

        The color of the symbol in hex format (starting with '#' followed by either 3 or 6 hex digits).

      - ##### description

            @Size(max=4000) String description

        The description of the new Asset Type.

      - ##### displayNameEnabled

            @jakarta.validation.constraints.NotNull boolean displayNameEnabled

        Required. Whether the display name should be enabled for all Assets of the type being created.

      - ##### iconCode

            String iconCode

        The icon code, a code representing the icon that should be shown.

      - ##### id

            UUID id

        The UUID that will be assigned to the new Asset Type.

        The UUID should be unique within all Asset Types, and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new Asset Type. Should be unique within all Asset Types.

      - ##### parentId

            UUID parentId

        The ID of the parent for the new Asset Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The public id that will be assigned to the new Asset Type.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

      - ##### ratingEnabled

            @jakarta.validation.constraints.NotNull boolean ratingEnabled

        Required. Whether ratings should be enabled for all Assets of the type being created.

      - ##### symbolType

            @NotNull AssetTypeSymbolType symbolType

        Required. The symbol type.

  - ### Class ChangeAssetTypeRequest

    class ChangeAssetTypeRequest extends Object implements Serializable
    serialVersionUID:
      -38440852800535802L

    - #### Serialized Fields

      - ##### acronymCode

            @Pattern(regexp="^([A-Za-z0-9]{1,4})$") String acronymCode

        The acronym code, a code representing the acronym that should be shown.

      - ##### color

            @Size(max=7) @Pattern(regexp="^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$") String color

        The color of the symbol, in a hex format e.g. '#000000'. This format always includes the '#' and has a size of 7.

      - ##### description

            @Size(max=4000) String description

        The new description for the Asset Type.

      - ##### displayNameEnabled

            Boolean displayNameEnabled

        Whether display name should be enabled for all Assets of changed type.

      - ##### iconCode

            String iconCode

        The icon code, a code representing the icon that should be shown.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Asset Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Asset Type.

      - ##### parentId

            UUID parentId

        The ID of the new parent for the Asset Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Asset Type.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

      - ##### ratingEnabled

            Boolean ratingEnabled

        Whether rating should be enabled for all Assets of given type.

      - ##### symbolType

            AssetTypeSymbolType symbolType

        The symbol type.

      - ##### traitIds

            List<UUID> traitIds

  - ### Class FindAssetTypesRequest

    class FindAssetTypesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5522976967220645342L

    - #### Serialized Fields

      - ##### displayNameEnabled

            Boolean displayNameEnabled

        Whether only Asset Types with display names enabled (or disabled) should be searched.

      - ##### excludeFinal

            Boolean excludeFinal

        Whether the final Asset Types should be excluded from the results or not.

      - ##### excludeMeta

            Boolean excludeMeta

        Whether the meta Asset Types should be excluded from the results or not.

      - ##### excludeUnlicensedProducts

            Boolean excludeUnlicensedProducts

        Whether the Asset Types belonging to products for which no license is active should be excluded from the results or not.

      - ##### name

            String name

        The name of the Asset Type to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

      - ##### parentId

            UUID parentId

        The ID of the parent to find the Asset Types in.

      - ##### topLevel

            Boolean topLevel

        Whether only top level Asset Types should be searched or not.

  - ### Class FindSubAssetTypesRequest

    class FindSubAssetTypesRequest extends Object implements Serializable
    serialVersionUID:
      674511065782579879L

    - #### Serialized Fields

      - ##### assetTypeId

            @NotNull UUID assetTypeId

        Required. The ID of the Asset Type to search the subtypes for.

      - ##### directSubTypesOnly

            boolean directSubTypesOnly

        Whether we should only list the direct subtypes, or all subtypes.

      - ##### includeParent

            boolean includeParent

        Whether parent Asset Type should be included in the search result.

- ## Package com.collibra.dgc.core.api.dto.meta.attributetype

  - ### Class AddAttributeTypeRequest

    class AddAttributeTypeRequest extends Object implements Serializable
    serialVersionUID:
      1159795964037878720L

    - #### Serialized Fields

      - ##### allowedValues

            List<String> allowedValues

        List of allowed values. This property is only applicable to Attribute Types of kind "Single Value List" or "Multi Value List".

      - ##### description

            @Size(max=4000) String description

        The description of the new Attribute Type.

      - ##### id

            UUID id

        The ID of the new Attribute Type. Should be unique within all Attribute Types.

        It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### isInteger

            Boolean isInteger

        Whether Attribute Type holds an integer value. This property is only applicable to Attribute Types of kind "Numeric".

      - ##### kind

            @NotNull AttributeKind kind

        Required. The kind of the new Attribute Type.

      - ##### language

            @Size(max=255) String language

        Deprecated, for removal: This API element is subject to removal in a future version.
        This parameter will be removed from the next major release, and has no effect.
        The script language of the new Attribute Type, for script Attribute Types.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new Attribute Type. Should be unique within all Attribute Types.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The public id that will be assigned to the new Attribute Type.

        It must be unique within all Attribute Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

      - ##### statisticsEnabled

            Boolean statisticsEnabled

        Whether statistics should be enabled. This property is only applicable to Attribute Types of kind "Numeric" or "Boolean".

      - ##### stringType

            StringType stringType

  - ### Class ChangeAttributeTypeRequest

    class ChangeAttributeTypeRequest extends Object implements Serializable
    serialVersionUID:
      4782496456417840748L

    - #### Serialized Fields

      - ##### allowedValues

            List<String> allowedValues

        List of allowed values. This property is only applicable to Attribute Types of kind "Single Value List" or "Multi Value List"."

      - ##### description

            @Size(max=4000) String description

        The new description for the Attribute Type.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Attribute Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### isInteger

            Boolean isInteger

        Whether Attribute Type holds integer value. This property is only applicable to Attribute Types of kind "Numeric".

      - ##### language

            @Size(max=255) String language

        Deprecated, for removal: This API element is subject to removal in a future version.
        This parameter will be removed from the next major release, and has no effect.
        The new script language of the new Attribute Type, for script Attribute Types.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Attribute Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Attribute Type.

        It must be unique within all Attribute Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

      - ##### statisticsEnabled

            Boolean statisticsEnabled

        Whether statistics should be enabled. This property is only applicable to Attribute Types of kind "Numeric" or "Boolean".

      - ##### stringType

            StringType stringType

        Whether the Attribute Type holds rich text or plain text. This property is only applicable to Attribute Types of kind "String".

  - ### Class FindAttributeTypesRequest

    class FindAttributeTypesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5522976967220645342L

    - #### Serialized Fields

      - ##### isInteger

            Boolean isInteger

        Whether only integer-type Attribute Types should be searched or not. This property is only applicable to Attribute Types of kind "Numeric".

      - ##### kind

            AttributeKind kind

        The kind of the Attribute Type to search for.

      - ##### language

            String language

        Deprecated, for removal: This API element is subject to removal in a future version.
        This parameter will be removed from the next major release, and has no effect.
        The language of the Attribute Type to search for.

      - ##### name

            String name

        The name of the Attribute Type to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

      - ##### sortField

            FindAttributeTypesRequest.SortField sortField

        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting.

      - ##### statisticsEnabled

            Boolean statisticsEnabled

        Whether the Attribute Types should be searched with statistics enabled or not. This property is only applicable to Attribute Types of kind "Numeric" or "Boolean".

- ## Package com.collibra.dgc.core.api.dto.meta.complexrelation

  - ### Class AddComplexRelationTypeRequest

    class AddComplexRelationTypeRequest extends Object implements Serializable
    serialVersionUID:
      -1456195549472481391L

    - #### Serialized Fields

      - ##### acronymCode

            @Pattern(regexp="^([A-Za-z0-9]{1,4})$") String acronymCode

        The acronym code of the new Complex Relation Type.

      - ##### attributeTypes

            @NotNull List<ComplexRelationAttributeTypeRequest> attributeTypes

        The list of attribute types for the new Complex Relation Type.

      - ##### color

            @Size(max=7) @Pattern(regexp="^#([A-Fa-f0-9]{6})$") String color

        The color of the symbol, in a hex format e.g. '#000000'. This format always includes the '#' and has a size of 7.

      - ##### description

            @Size(max=4000) String description

        The description of the new Complex Relation Type.

      - ##### iconCode

            String iconCode

        The icon code of the new Complex Relation Type.

      - ##### id

            UUID id

        The ID of the new Complex Relation Type. Should be unique within all Complex Relation Types. It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### legTypes

            @NotNull @Size(min=1) List<ComplexRelationLegTypeRequest> legTypes

        Required. The list of leg types for the new Complex Relation Type. At least one leg should be specified

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new Complex Relation Type. Should be unique within all Complex Relation Types.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The public id that will be assigned to the new Complex Relation Type.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

      - ##### symbolType

            @NotNull AssetTypeSymbolType symbolType

        Required. The symbol type.

  - ### Class ChangeComplexRelationTypeRequest

    class ChangeComplexRelationTypeRequest extends Object implements Serializable
    serialVersionUID:
      -1456195549472481391L

    - #### Serialized Fields

      - ##### acronymCode

            @Pattern(regexp="^([A-Za-z0-9]{1,4})$") String acronymCode

        The new acronym code for the Complex Relation Type.

      - ##### attributeTypes

            List<ComplexRelationAttributeTypeRequest> attributeTypes

        The new list of attribute types for the Complex Relation Type.

      - ##### color

            @Size(max=7) @Pattern(regexp="^#([A-Fa-f0-9]{6})$") String color

        The color of the symbol, in a hex format e.g. '#000000'. This format always includes the '#' and has a size of 7.

      - ##### description

            @Size(max=4000) String description

        The new description for the Complex Relation Type.

      - ##### iconCode

            String iconCode

        The new icon code for the Complex Relation Type.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Complex Relation Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### legTypes

            List<ComplexRelationLegTypeRequest> legTypes

        The new list of leg types for the Complex Relation Type.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Complex Relation Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Complex Relation Type.

        It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

      - ##### symbolType

            AssetTypeSymbolType symbolType

        The new symbol type.

  - ### Class ComplexRelationAttributeTypeRequest

    class ComplexRelationAttributeTypeRequest extends Object implements Serializable
    serialVersionUID:
      -4066172902623436872L

    - #### Serialized Fields

      - ##### attributeTypeId

            @NotNull UUID attributeTypeId

        Required. The ID of the Attribute Type.

      - ##### id

            UUID id

        The ID of the Complex Relation Attribute Type. If specified, it will be used to create a new Complex Relation Attribute Type if none exists, or as id for the existing Complex Relation Attribute Type. If not specified, a random id will be generated and used to create a new Complex Relation Attribute Type if none exists, or as id for the existing Complex Relation Attribute Type.

      - ##### max

            Integer max

        The maximum number of Attribute Type occurrences.

      - ##### min

            int min

        The minimum number of Attribute Type occurrences.

  - ### Class ComplexRelationLegTypeRequest

    class ComplexRelationLegTypeRequest extends Object implements Serializable
    serialVersionUID:
      -4066172902623436871L

    - #### Serialized Fields

      - ##### assetTypeId

            @NotNull UUID assetTypeId

        Required. The ID of the Asset Type of the Relation.

      - ##### coRole

            String coRole

        The name of the role that the target plays.

      - ##### id

            UUID id

        The id of the Complex Relation Leg Type. The Leg Type will be created with this id or updated. If left empty on update the Leg Type will be recreated.

      - ##### max

            Integer max

        The maximum number of Leg Type occurrences.

      - ##### min

            int min

        The minimum number of Leg Type occurrences.

      - ##### relationTypeId

            UUID relationTypeId

        The id of the Relation Type of the Leg Type.

      - ##### role

            @NotNull String role

        Required. The name of the role that the source plays.

  - ### Class FindComplexRelationTypesRequest

    class FindComplexRelationTypesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      8825923598067134428L

    - #### Serialized Fields

      - ##### name

            String name

        The name of the Complex Relation Type to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

- ## Package com.collibra.dgc.core.api.dto.meta.domaintype

  - ### Class AddDomainTypeRequest

    class AddDomainTypeRequest extends Object implements Serializable
    serialVersionUID:
      -6289982405461706997L

    - #### Serialized Fields

      - ##### description

            @Size(max=4000) String description

        The description of the new Domain Type.

      - ##### id

            UUID id

        The ID of the new Domain Type. Should be unique within all Domain Types. It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new Domain Type. Should be unique within all Domain Types.

      - ##### parentId

            UUID parentId

        The ID of the parent of the new Domain Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The public id that will be assigned to the new Domain Type.

        It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

  - ### Class ChangeDomainTypeRequest

    class ChangeDomainTypeRequest extends Object implements Serializable
    serialVersionUID:
      2300260398939651976L

    - #### Serialized Fields

      - ##### description

            @Size(max=4000) String description

        The new description for the Domain Type.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Domain Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Domain Type.

      - ##### parentId

            UUID parentId

        The ID of the new parent for the Domain Type.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Domain Type.

        It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

  - ### Class FindDomainTypesRequest

    class FindDomainTypesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5522976967220645342L

    - #### Serialized Fields

      - ##### excludeMeta

            Boolean excludeMeta

        Whether the meta Domain Types should be excluded from search or not.

      - ##### name

            String name

        The name of the Domain Type to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. The search is case-insensitive.

      - ##### parentId

            UUID parentId

        The ID of the parent to find the Domain Types in.

      - ##### topLevel

            Boolean topLevel

        Whether only top level Domain Types should be searched or not.

  - ### Class FindSubDomainTypesRequest

    class FindSubDomainTypesRequest extends Object implements Serializable
    serialVersionUID:
      674511065782579879L

    - #### Serialized Fields

      - ##### domainTypeId

            @NotNull UUID domainTypeId

        Required. The ID of the Domain Type to search the subtypes for. Supplied as a path parameter in the REST API, not as a query parameter.

      - ##### includeParent

            boolean includeParent

        Whether parent Domain Type should be included in the search result.

- ## Package com.collibra.dgc.core.api.dto.meta.relationtype

  - ### Class AddRelationTypeRequest

    class AddRelationTypeRequest extends Object implements Serializable
    serialVersionUID:
      1219961766586522392L

    - #### Serialized Fields

      - ##### coRole

            @NotNull @Size(min=1,max=255) String coRole

        Required. The name of the role that the target plays.

      - ##### description

            @Size(max=4000) String description

        The description of the Relation Type.

      - ##### id

            UUID id

        The ID of the new Relation Type. Should be unique within all Relation Types.

        It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### publicId

            String publicId

        The public id that will be assigned to the new Relation Type.

        It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

      - ##### role

            @NotNull @Size(min=1,max=255) String role

        Required. The name of the role that the source plays.

      - ##### sourceTypeId

            @NotNull UUID sourceTypeId

        Required. The ID of the source type for the new Relation Type.

      - ##### targetTypeId

            @NotNull UUID targetTypeId

        Required. The ID of the source type for the new Relation Type.

  - ### Class ChangeRelationTypeRequest

    class ChangeRelationTypeRequest extends Object implements Serializable
    serialVersionUID:
      -1568562942123326817L

    - #### Serialized Fields

      - ##### coRole

            @Size(min=1,max=255) String coRole

        The new name of the role that the target plays.

      - ##### description

            @Size(max=4000) String description

        The new description of the Relation Type.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Relation Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### publicId

            @Size(min=1,max=260) String publicId

        The new public id for the Relation Type.

        It must be unique within all Relation Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C".

        WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

      - ##### role

            @Size(min=1,max=255) String role

        The new name of the role that the source plays.

      - ##### sourceTypeId

            UUID sourceTypeId

        Deprecated.
        The new source type ID will be removed in the future.
        The ID of the new source type for the Relation Type.

      - ##### targetTypeId

            UUID targetTypeId

        Deprecated.
        The new target type ID will be removed in the future.
        The ID of the new target type for the Relation Type.

  - ### Class FindRelationTypesRequest

    class FindRelationTypesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -8181399169922771236L

    - #### Serialized Fields

      - ##### coRole

            String coRole

        The name of the role that the target plays to search for.

      - ##### role

            String role

        The name of the role that the source plays to search for.

      - ##### roleCoRoleLogicalOperator

            LogicalOperator roleCoRoleLogicalOperator

        The logical operator determining how to combine the role and coRole criteria: AND or OR.

      - ##### sortField

            FindRelationTypesRequest.SortField sortField

        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        The order of sorting.

      - ##### sourceTypeId

            UUID sourceTypeId

        The ID of the source type of the Relation Type to search for.

      - ##### sourceTypeName

            String sourceTypeName

        The name of the source type of the Relation Type to search for.

      - ##### targetTypeId

            UUID targetTypeId

        The ID of the target type of the Relation Type to search for.

      - ##### targetTypeName

            String targetTypeName

        The name of the target type of the Relation Type to search for.

- ## Package com.collibra.dgc.core.api.dto.meta.status

  - ### Class AddStatusRequest

    class AddStatusRequest extends Object implements Serializable
    serialVersionUID:
      -3306689804245335999L

    - #### Serialized Fields

      - ##### description

            @Size(max=4000) String description

        The description of the new Status.

      - ##### id

            UUID id

        The ID of the new Status. Should be unique within all Statuses.

        It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new Status. Should be unique within all Statuses.

  - ### Class ChangeStatusRequest

    class ChangeStatusRequest extends Object implements Serializable
    serialVersionUID:
      -648926594975777536L

    - #### Serialized Fields

      - ##### description

            @Size(max=4000) String description

        The new description for the Status.

      - ##### id

            @NotNull UUID id

        Required. The ID of the Status to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Status.

  - ### Class FindStatusesRequest

    class FindStatusesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -788105254504060745L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the Status to search for.

      - ##### name

            String name

        The name of the Status to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

- ## Package com.collibra.dgc.core.api.dto.meta.trait

  - ### Class ChangeTraitRequest

    class ChangeTraitRequest extends Object implements Serializable
    serialVersionUID:
      9211896362861373652L

    - #### Serialized Fields

      - ##### description

            @Size(max=4000) String description

        The new description for the Trait.

      - ##### id

            @NotNull UUID id

        Required. The id of the Trait to be changed.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the Trait.

  - ### Class FindTraitsRequest

    class FindTraitsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5522976967220645342L

    - #### Serialized Fields

      - ##### name

            String name

        The name of the Trait to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

- ## Package com.collibra.dgc.core.api.dto.navigation

  - ### Class FindMostViewedAssetsRequest

    class FindMostViewedAssetsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### guestExcluded

            boolean guestExcluded

        `true` if guest visits should be excluded.

      - ##### period

            long period

        The time span for which most viewed assets should be found. This time span must be expressed in milliseconds. For instance, to get most viewed assets last 24 hours, period would be `86400000`. If it's unset (period = 0) looks for all time most viewed assets.

  - ### Class FindRecentlyViewedAssetsRequest

    class FindRecentlyViewedAssetsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      1L

  - ### Class RecentlyViewedAssetsRequest

    class RecentlyViewedAssetsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### communityIds

            List<UUID> communityIds

        The list of IDs of the communities. The returned assets are of one of communities specified by this parameter

      - ##### domainIds

            List<UUID> domainIds

        The list of IDs of the domains. The returned assets are of one of domains specified by this parameter

      - ##### name

            String name

        The name of the asset to search for (either display name or full name).

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`.

      - ##### statusIds

            List<UUID> statusIds

        The list of IDs of the statuses. The returned assets have one of statuses specified by this parameter

      - ##### typeIds

            List<UUID> typeIds

        The list of IDs of the asset types. The returned assets are of one of types specified by this parameter

      - ##### typeInheritance

            boolean typeInheritance

        Whether the type inheritance for the asset type filtering should be applied or not.

- ## Package com.collibra.dgc.core.api.dto.quality

  - ### Class AddDataQualityRuleRequest

    class AddDataQualityRuleRequest extends Object implements Serializable
    serialVersionUID:
      4164711043496618351L

    - #### Serialized Fields

      - ##### categorizationRelationTypeId

            @NotNull UUID categorizationRelationTypeId

        Deprecated.
        The ID of the categorization relation type.

      - ##### dataQualityMetrics

            List<DataQualityMetricRequest> dataQualityMetrics

        Deprecated.
        The Data Quality Metrics that should be assigned to the rule that is going to be created.

      - ##### description

            @Size(max=255) String description

        Deprecated.
        The description of the new data quality rule.

      - ##### id

            UUID id

        Deprecated.
        The ID of the new Data Quality Rule. Should be unique within all data quality rules. It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Deprecated.
        The name of the new data quality rule. Should be unique within all data quality rules.

      - ##### profilingEnabled

            boolean profilingEnabled

        Deprecated.
        Indicates whether profiling statistics should be enabled for this rule.

      - ##### relationTraceEntries

            @NotNull @Size(min=1) List<RelationTraceEntryRequest> relationTraceEntries

        Deprecated.
        The list of entries that describes relations along which the data quality result is calculated.

  - ### Class ChangeDataQualityRuleRequest

    class ChangeDataQualityRuleRequest extends Object implements Serializable
    serialVersionUID:
      3455107332252432997L

    - #### Serialized Fields

      - ##### categorizationRelationTypeId

            UUID categorizationRelationTypeId

        Deprecated.
        The ID of the categorization relation type.

      - ##### dataQualityMetrics

            List<DataQualityMetricRequest> dataQualityMetrics

        Deprecated.
        The list of data quality metrics.

      - ##### description

            @Size(max=255) String description

        Deprecated.
        The new description for the data quality rule.

      - ##### id

            @NotNull UUID id

        Deprecated.
        Required. The ID of the data quality rule to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=255) String name

        Deprecated.
        The new name for the data quality rule.

      - ##### profilingEnabled

            boolean profilingEnabled

        Deprecated.
        Indicates whether profiling statistics should be enabled for this rule.

      - ##### relationTraceEntries

            List<RelationTraceEntryRequest> relationTraceEntries

        Deprecated.
        The list of relation trace entries that describes relations along which the data quality result is calculated.

  - ### Class DataQualityMetricRequest

    class DataQualityMetricRequest extends Object implements Serializable
    serialVersionUID:
      -2959062416507408603L

    - #### Serialized Fields

      - ##### attributeTypeId

            UUID attributeTypeId

        Deprecated.
        The ID of the attribute type that defines the value that is used as the data quality metric.

      - ##### countOperation

            DataQualityCountOperation countOperation

        Deprecated.
        The operation that should be performed when aggregating the quality results.

  - ### Class FindDataQualityRulesRequest

    class FindDataQualityRulesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5522976967220645342L

    - #### Serialized Fields

      - ##### name

            String name

        Deprecated.
        The name of the dataquality rule to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        Deprecated.
        The match mode used to compare `name`.

      - ##### sortField

            FindDataQualityRulesRequest.SortField sortField

        Deprecated.
        The field that should be used as reference for sorting.

      - ##### sortOrder

            SortOrder sortOrder

        Deprecated.
        The order of sorting.

  - ### Class RelationTraceEntryRequest

    class RelationTraceEntryRequest extends Object implements Serializable
    serialVersionUID:
      7403101762998804318L

    - #### Serialized Fields

      - ##### relationTypeId

            @NotNull UUID relationTypeId

        Deprecated.
        Required. The ID of the relation type for the relation trace entry.

      - ##### roleDirection

            boolean roleDirection

        Deprecated.
        The direction of the relation to take, true if the relation is followed in role direction.

- ## Package com.collibra.dgc.core.api.dto.query.outputmodule

  - ### Class ExportCSVInJobRequest

    class ExportCSVInJobRequest extends Object implements Serializable
    serialVersionUID:
      8065210125664493260L

    - #### Serialized Fields

      - ##### escape

            String escape

      - ##### fileName

            String fileName

      - ##### headerRow

            boolean headerRow

      - ##### quote

            String quote

      - ##### sendNotification

            boolean sendNotification

      - ##### separator

            String separator

      - ##### tableViewConfig

            @NotNull String tableViewConfig

      - ##### validationEnabled

            boolean validationEnabled

  - ### Class ExportCSVRequest

    class ExportCSVRequest extends Object implements Serializable
    serialVersionUID:
      4232366694838820655L

    - #### Serialized Fields

      - ##### escape

            String escape

      - ##### headerRow

            boolean headerRow

      - ##### quote

            String quote

      - ##### separator

            String separator

      - ##### tableViewConfig

            @NotNull String tableViewConfig

      - ##### validationEnabled

            boolean validationEnabled

  - ### Class ExportCSVToFileRequest

    class ExportCSVToFileRequest extends Object implements Serializable
    serialVersionUID:
      -620230324122585371L

    - #### Serialized Fields

      - ##### escape

            String escape

      - ##### fileName

            String fileName

      - ##### headerRow

            boolean headerRow

      - ##### quote

            String quote

      - ##### separator

            String separator

      - ##### tableViewConfig

            @NotNull String tableViewConfig

      - ##### validationEnabled

            boolean validationEnabled

  - ### Class ExportExcelInJobRequest

    class ExportExcelInJobRequest extends Object implements Serializable
    serialVersionUID:
      5861775104690052338L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### headerRow

            boolean headerRow

      - ##### sendNotification

            boolean sendNotification

      - ##### sheetName

            String sheetName

      - ##### tableViewConfig

            @NotNull String tableViewConfig

      - ##### truncateLongValues

            boolean truncateLongValues

      - ##### useXLSX

            boolean useXLSX

        Deprecated.

      - ##### validationEnabled

            boolean validationEnabled

  - ### Class ExportExcelToFileRequest

    class ExportExcelToFileRequest extends Object implements Serializable
    serialVersionUID:
      1761158641078136553L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### headerRow

            boolean headerRow

      - ##### sheetName

            String sheetName

      - ##### tableViewConfig

            @NotNull String tableViewConfig

      - ##### truncateLongValues

            boolean truncateLongValues

      - ##### useXLSX

            boolean useXLSX

        Deprecated.

      - ##### validationEnabled

            boolean validationEnabled

  - ### Class ExportJSONInJobRequest

    class ExportJSONInJobRequest extends Object implements Serializable
    serialVersionUID:
      -4289855429640914359L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### sendNotification

            boolean sendNotification

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

  - ### Class ExportJSONRequest

    class ExportJSONRequest extends Object implements Serializable
    serialVersionUID:
      4538430200341720770L

    - #### Serialized Fields

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

  - ### Class ExportJSONToFileRequest

    class ExportJSONToFileRequest extends Object implements Serializable
    serialVersionUID:
      -4289855429640914359L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

  - ### Class ExportXMLInJobRequest

    class ExportXMLInJobRequest extends Object implements Serializable
    serialVersionUID:
      -4289855429640914359L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### sendNotification

            boolean sendNotification

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

  - ### Class ExportXMLRequest

    class ExportXMLRequest extends Object implements Serializable
    serialVersionUID:
      4538430200341720770L

    - #### Serialized Fields

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

  - ### Class ExportXMLToFileRequest

    class ExportXMLToFileRequest extends Object implements Serializable
    serialVersionUID:
      -4289855429640914359L

    - #### Serialized Fields

      - ##### fileName

            String fileName

      - ##### validationEnabled

            boolean validationEnabled

      - ##### viewConfig

            @NotNull String viewConfig

- ## Package com.collibra.dgc.core.api.dto.role

  - ### Class AddRoleRequest

    class AddRoleRequest extends Object implements Serializable
    serialVersionUID:
      3079740474071948649L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the role.

      - ##### disabled

            boolean disabled

        Whether the role should be disabled or not.

      - ##### global

            boolean global

        Whether the role should be a global or resource role.

      - ##### id

            UUID id

        The ID of the new role. Should be unique within all roles.

        It should have a format of universally unique identifier (UUID) and should not start with `00000000-0000-0000-` which is a reserved prefix

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the new role. Should be unique within all roles.

      - ##### permissions

            List<Permission> permissions

        The permissions to be granted for this role.

  - ### Class ChangeRoleRequest

    class ChangeRoleRequest extends Object implements Serializable
    serialVersionUID:
      4886068719895873117L

    - #### Serialized Fields

      - ##### description

            String description

        The new description for the role.

      - ##### disabled

            Boolean disabled

        Whether the role should be disabled or not.

      - ##### id

            @NotNull UUID id

        Required. The ID of the role to be changed.

      - ##### name

            @Size(min=1,max=255) String name

        The new name for the role. Should be unique within all roles.

      - ##### permissions

            List<Permission> permissions

        The new permissions to be set. If null, no changes are made, otherwise the current permissions are replaced with the given ones.

  - ### Class FindRolesRequest

    class FindRolesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -6595871567712444106L

    - #### Serialized Fields

      - ##### description

            String description

        The description of the role to search for.

      - ##### global

            Boolean global

        Deprecated.
        Whether global roles should be searched for.

      - ##### includeDisabled

            boolean includeDisabled

      - ##### name

            String name

        The name of the role to search for.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. The search is case-insensitive.

      - ##### ownerId

            UUID ownerId

      - ##### roleInheritanceMode

            FindRolesRequest.RoleInheritanceMode roleInheritanceMode

      - ##### sortField

            RoleRequestSortField sortField

      - ##### sortOrder

            SortOrder sortOrder

      - ##### systemName

            String systemName

      - ##### type

            FindRolesRequest.TypeMatchMode type

        Indicates which type of roles should be searched for. Usage is mutually exclusive with the deprecated `FindRolesRequest.global` flag.

- ## Package com.collibra.dgc.core.api.dto.security.saml

  - ### Class ChangeSamlCertificateRequest

    class ChangeSamlCertificateRequest extends Object implements Serializable
    serialVersionUID:
      -970220808822831524L

    - #### Serialized Fields

      - ##### certificate

            InputStream certificate

        The stream of the certificate in PEM format.

      - ##### type

            SamlCertificateType type

        The type of certificate to be changed.

  - ### Class DeleteSamlCertificateRequest

    class DeleteSamlCertificateRequest extends Object implements Serializable
    serialVersionUID:
      -970220808822831524L

    - #### Serialized Fields

      - ##### type

            SamlCertificateType type

        The type of certificate to be changed.

- ## Package com.collibra.dgc.core.api.dto.tag

  - ### Class ChangeTagRequest

    class ChangeTagRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The ID of the tag.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The new name of the tag.

  - ### Class FindTagsRequest

    class FindTagsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -7893515148438874524L

    - #### Serialized Fields

      - ##### name

            String name

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

  - ### Class MergeTagsRequest

    class MergeTagsRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### fromId

            @NotNull UUID fromId

        Required. Id of the tag to be replaced.

      - ##### toId

            @NotNull UUID toId

        Required. Id of the replacement tag.

- ## Package com.collibra.dgc.core.api.dto.user

  - ### Class AddUserRequest

    class AddUserRequest extends Object implements Serializable
    serialVersionUID:
      -7044822134607759929L

    - #### Serialized Fields

      - ##### additionalEmailAddresses

            List<Email> additionalEmailAddresses

        The additional e-mail addresses of the user.

      - ##### addresses

            List<Address> addresses

        The postal addresses of the user.

      - ##### department

            @Size(max=255) String department

        The organizational department of the new user.

      - ##### emailAddress

            @NotNull @Size(min=1,max=255) String emailAddress

        Required. The e-mail address of the new user.

      - ##### firstName

            String firstName

        The first name of the new user.

      - ##### gender

            Gender gender

        The gender of the user.

      - ##### instantMessagingAccounts

            List<InstantMessagingAccount> instantMessagingAccounts

        The instant messaging accounts of the user.

      - ##### language

            String language

        The language for the user.

      - ##### lastName

            String lastName

        The last name of the new user.

      - ##### licenseType

            LicenseType licenseType

        Deprecated, for removal: This API element is subject to removal in a future version.
        This method will be removed in the future.
        The license type of the user.

      - ##### phones

            List<PhoneNumber> phones

        The phone numbers of the user.

      - ##### title

            @Size(max=255) String title

        The organizational title of the new user.

      - ##### userGroupIds

            List<UUID> userGroupIds

        The groups this newly created user should be added to.

      - ##### userName

            @NotNull @Size(min=1,max=255) String userName

        Required. The username, which should be unique.

      - ##### websites

            List<Website> websites

        The websites of the user.

  - ### Class AddUserToUserGroupsRequest

    class AddUserToUserGroupsRequest extends Object implements Serializable
    serialVersionUID:
      -1226688613788439036L

    - #### Serialized Fields

      - ##### userGroupIds

            @NotNull @Size(min=1) List<UUID> userGroupIds

        Required. The list of IDs of the user groups which the user should be assigned to.

      - ##### userId

            @NotNull UUID userId

        Required. The ID of the user who should be assigned to user groups.

        Silently ignored if the ID is provided as path parameter of the request.

  - ### Class ChangeUserAvatarRequest

    class ChangeUserAvatarRequest extends Object implements Serializable
    serialVersionUID:
      -4134742172173092259L

    - #### Serialized Fields

      - ##### fileId

            @NotNull UUID fileId

        Required. The ID of the file representing to avatar that should be assigned to the user.

      - ##### id

            @NotNull UUID id

        Required. The ID of the user the avatar should be changed for.

  - ### Class ChangeUserRequest

    class ChangeUserRequest extends Object implements Serializable
    serialVersionUID:
      8104201352116462766L

    - #### Serialized Fields

      - ##### additionalEmailAddresses

            List<Email> additionalEmailAddresses

        The additional e-mail addresses of the user.

      - ##### addresses

            List<Address> addresses

        The postal addresses of the user.

      - ##### department

            String department

        The organizational department of the user.

      - ##### email

            @Size(min=1) String email

        The new e-mail address for the user.

      - ##### enabled

            Boolean enabled

        The new enabled flag for the user.

      - ##### firstName

            String firstName

        The new first name for the user.

      - ##### gender

            Gender gender

        The new gender for the user.

      - ##### id

            @NotNull UUID id

        Required. The ID of the user to be changed.

      - ##### instantMessagingAccounts

            List<InstantMessagingAccount> instantMessagingAccounts

        The instant messaging accounts of the user.

      - ##### language

            String language

        The new language for the user.

      - ##### lastName

            String lastName

        The new last name for the user.

      - ##### licenseType

            LicenseType licenseType

        Deprecated.
        The license type of the user.

      - ##### passwordConfirmation

            String passwordConfirmation

        The password confirmation for the user when changing their email.

      - ##### phones

            List<PhoneNumber> phones

        The phone numbers of the user.

      - ##### title

            String title

        The organizational title of the user.

      - ##### username

            String username

        The new username for the user.

      - ##### websites

            List<Website> websites

        The websites of the user.

  - ### Class FindUsersRequest

    class FindUsersRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -8014858480444780560L

    - #### Serialized Fields

      - ##### department

            String department

        The organization department to which the user belongs.

      - ##### groupId

            UUID groupId

        The ID of the group the searched users should belong to.

      - ##### includeDisabled

            boolean includeDisabled

        Whether disabled users should be included in the search results.

      - ##### name

            String name

        The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.

      - ##### nameSearchFields

            Set<NameSearchField> nameSearchFields

        The user fields that will be searched for occurrences of the `FindUsersRequest.name` parameter.

        It defaults to `USERNAME`, `FIRSTNAME`, `LASTNAME`, `FIRSTNAME_LASTNAME` and `LASTNAME_FIRSTNAME`.

      - ##### onlyLoggedIn

            boolean onlyLoggedIn

        Whether only currently logged in users should be returned.

      - ##### sortField

            NameSearchField sortField

      - ##### sortOrder

            SortOrder sortOrder

      - ##### title

            String title

        The organizational title of the user.

      - ##### userIds

            List<String> userIds

        The IDs of the users.

  - ### Class RemoveUserFromUserGroupsRequest

    class RemoveUserFromUserGroupsRequest extends Object implements Serializable
    serialVersionUID:
      -1226688613788439036L

    - #### Serialized Fields

      - ##### userGroupIds

            @NotNull @Size(min=1) List<UUID> userGroupIds

        Required. The list of IDs of the user groups which the user should be removed from.

      - ##### userId

            @NotNull UUID userId

        Required. The ID of the user who should be removed from user groups. Silently ignored if the ID is provided as path parameter of the request.

  - ### Class SetUserGroupsForUserRequest

    class SetUserGroupsForUserRequest extends Object implements Serializable
    serialVersionUID:
      -1226688613788439036L

    - #### Serialized Fields

      - ##### userGroupIds

            @NotNull List<UUID> userGroupIds

        Required. The list of IDs of the user groups which the user should be assigned to.

      - ##### userId

            @NotNull UUID userId

        Required. The ID of the user who should be assigned to the user groups.

        Silently ignored if the ID is provided as path parameter of the request; otherwise required.

- ## Package com.collibra.dgc.core.api.dto.usergroup

  - ### Class AddUserGroupRequest

    class AddUserGroupRequest extends Object implements Serializable
    serialVersionUID:
      6542085492363801413L

    - #### Serialized Fields

      - ##### locallyManaged

            boolean locallyManaged

        Deprecated.
        This feature will be dropped.
        The locallyManaged flag of the user group. Indicates whether this UserGroup is locally managed or not.

      - ##### name

            @NotNull @Size(min=1,max=255) String name

        Required. The name of the user group. Should be unique within all user groups.

  - ### Class AddUserGroupsRequest

    class AddUserGroupsRequest extends Object implements Serializable
    serialVersionUID:
      6542085492363801414L

    - #### Serialized Fields

      - ##### names

            @NotNull @Size(min=1) List<String> names

        Required. The names of the user groups. Each name should be unique within all user groups.

  - ### Class AddUsersToUserGroupRequest

    class AddUsersToUserGroupRequest extends Object implements Serializable
    serialVersionUID:
      3843866647203710644L

    - #### Serialized Fields

      - ##### userGroupId

            @NotNull UUID userGroupId

        Required. The ID of the user group the users should be added to. Silently ignored if the ID is provided as path parameter of the request

      - ##### userIds

            @NotNull @Size(min=1) List<UUID> userIds

        Required. The list of IDs of the users that should be added to the user group.

  - ### Class ChangeUserGroupRequest

    class ChangeUserGroupRequest extends Object implements Serializable
    serialVersionUID:
      3843866647203710644L

    - #### Serialized Fields

      - ##### id

            @NotNull UUID id

        Required. The ID of the user group to be changed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### locallyManaged

            Boolean locallyManaged

        Deprecated.
        This feature will be dropped.
        The locallyManaged flag of the user group. Indicates whether this UserGroup is locally managed or not.

      - ##### name

            @NotNull @Size(min=1) String name

        Required. The name of the user group. Should be unique within all user groups.

  - ### Class FindUserGroupsForUserRequest

    class FindUserGroupsForUserRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -1785652480094046339L

    - #### Serialized Fields

      - ##### userId

            UUID userId

        Deprecated.
        The name of the user group.

  - ### Class FindUserGroupsRequest

    class FindUserGroupsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -1785652480094046339L

    - #### Serialized Fields

      - ##### includeEveryone

            boolean includeEveryone

        Deprecated.
        This search parameter will be removed in the future. In practice setting this value is not enough: there are other system groups like Users that may need to be removed programmatically anyways. System groups cannot be modified (add/remove users) but can be used in the context of assigned responsibilities.
        Indicates if we should include the everyone group or not.

      - ##### name

            String name

        The name of the user group.

      - ##### nameMatchMode

            MatchMode nameMatchMode

        The match mode used to compare `name`. If the match mode is `EXACT` the search is case-sensitive, otherwise the search is case-insensitive.

      - ##### userId

            UUID userId

        The ID of the user who should belong to searched user groups.

  - ### Class RemoveUsersFromUserGroupRequest

    class RemoveUsersFromUserGroupRequest extends Object implements Serializable
    serialVersionUID:
      -1226688613788439036L

    - #### Serialized Fields

      - ##### userGroupId

            @NotNull UUID userGroupId

        Required. The ID of the user groups from which the users should be removed. Silently ignored if the ID is provided as path parameter of the request.

      - ##### userIds

            @NotNull @Size(min=1) List<UUID> userIds

        Required. The list of IDs of the users which should be removed from the user group.

  - ### Class SetUsersForUserGroupRequest

    class SetUsersForUserGroupRequest extends Object implements Serializable
    serialVersionUID:
      -6924522581635764153L

    - #### Serialized Fields

      - ##### userGroupId

            @NotNull UUID userGroupId

        Required. The ID of the user group whose users will be set.

      - ##### userIds

            @NotNull List<UUID> userIds

        Required. The list of user IDs that will be assigned to the group.

- ## Package com.collibra.dgc.core.api.dto.validation

  - ### Class FindValidationResultRequest

    class FindValidationResultRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -7490258410626431582L

    - #### Serialized Fields

      - ##### assetId

            UUID assetId

        The unique identifier of the asset for which we are searching validation results.

      - ##### jobId

            UUID jobId

        The unique identifier of the job for which we are searching validation results.

      - ##### mostRecentExecution

            Boolean mostRecentExecution

        Check the validationResults of only the most recent execution (inside or outside a validation job) according to the other criteria.

      - ##### mostRecentJob

            Boolean mostRecentJob

        Check the validationResults of only the most recent job according to the other criteria.

      - ##### result

            Boolean result

        Filter on the result of validation results.

      - ##### validationRuleId

            UUID validationRuleId

        The unique identifier of the validation rule for which we are searching validation results.

  - ### Class ValidateInJobRequest

    class ValidateInJobRequest extends Object implements Serializable
    serialVersionUID:
      6049385075217704836L

    - #### Serialized Fields

      - ##### assetIds

            List<UUID> assetIds

      - ##### sendNotification

            boolean sendNotification

- ## Package com.collibra.dgc.core.api.dto.viewpermission

  - ### Class AddViewPermissionRequest

    class AddViewPermissionRequest extends Object implements Serializable
    serialVersionUID:
      -2959834217523508865L

    - #### Serialized Fields

      - ##### baseResource

            @NotNull ResourceReference baseResource

        Required. The resource on which we want to provide the view permission.

      - ##### userGroupId

            UUID userGroupId

        The userGroupId of the group that should receive the view permission. Either this or the userId is required.

      - ##### userId

            UUID userId

        The userId of the person who should receive the view permission. Either this or the userGroupId is required.

  - ### Class FindViewPermissionRequest

    class FindViewPermissionRequest extends PagedRequest implements Serializable
    serialVersionUID:
      8038267348818456158L

    - #### Serialized Fields

      - ##### includeInherited

            boolean includeInherited

      - ##### resourceDiscriminator

            String resourceDiscriminator

      - ##### resourceId

            UUID resourceId

      - ##### resourceType

            ResourceType resourceType

        Deprecated, for removal: This API element is subject to removal in a future version.
        Filtering for resourceType should not apply to view permissions.

      - ##### userGroupId

            UUID userGroupId

      - ##### userId

            UUID userId

- ## Package com.collibra.dgc.core.api.dto.workflow

  - ### Class AddAssetTypeAssignmentRuleRequest

    class AddAssetTypeAssignmentRuleRequest extends Object implements Serializable
    serialVersionUID:
      -34210681643086948L

    - #### Serialized Fields

      - ##### assetTypeId

            @NotNull UUID assetTypeId

        Required. The ID of the asset type the added rule should refer to.

      - ##### communityId

            UUID communityId

        The ID of the community the assignment rule should apply for.

      - ##### domainId

            UUID domainId

        The ID of the domain the assignment rule should apply for.

      - ##### exactResourceTypeMatch

            boolean exactResourceTypeMatch

        When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.

      - ##### statusId

            UUID statusId

        The ID of the status the assignment rule should apply for.

      - ##### workflowDefinitionId

            @NotNull UUID workflowDefinitionId

        Required. The ID of the workflow definition containing the assignment rule to be added.

  - ### Class AddDomainTypeAssignmentRuleRequest

    class AddDomainTypeAssignmentRuleRequest extends Object implements Serializable
    serialVersionUID:
      3107705471932233242L

    - #### Serialized Fields

      - ##### communityId

            UUID communityId

        The ID of the community the assignment rule should apply for.

      - ##### domainTypeId

            @NotNull UUID domainTypeId

        Required. The ID of the domain type the added rule should refer to.

      - ##### exactResourceTypeMatch

            boolean exactResourceTypeMatch

        When true, the workflow can only be started for a domain if its type matches exactly the domain type defined in this rule. Child domain types are excluded.

      - ##### workflowDefinitionId

            @NotNull UUID workflowDefinitionId

        Required. The ID of the workflow definition containing the assignment rule to be added.

  - ### Class CancelWorkflowTasksRequest

    class CancelWorkflowTasksRequest extends Object implements Serializable
    serialVersionUID:
      1L

    - #### Serialized Fields

      - ##### reason

            String reason

        The reason for the cancellation of the workflow instance.

      - ##### sendNotification

            @jakarta.validation.constraints.NotNull boolean sendNotification

        Required. Whether or not the user needs to be notified of the job completion.

      - ##### workflowTaskIds

            @NotNull List<UUID> workflowTaskIds

        Required. The list of workflow task IDs to be cancelled.

  - ### Class ChangeAssetTypeAssignmentRuleRequest

    class ChangeAssetTypeAssignmentRuleRequest extends Object implements Serializable
    serialVersionUID:
      5620156480017414031L

    - #### Serialized Fields

      - ##### assetTypeId

            @NotNull UUID assetTypeId

        Required. The ID of the asset type the changed rule should refer to.

      - ##### communityId

            UUID communityId

        The ID of the community the assignment rule should apply for.

      - ##### domainId

            UUID domainId

        The ID of the domain the assignment rule should apply for.

      - ##### exactResourceTypeMatch

            Boolean exactResourceTypeMatch

        When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.

      - ##### ruleId

            @NotNull UUID ruleId

        Required. The ID of the domain type assignment rule. Silently ignored if the ID is provided as path parameter of the request.

      - ##### statusId

            UUID statusId

        The ID of the (Asset Type) status the assignment rule should apply for.

      - ##### workflowDefinitionId

            @NotNull UUID workflowDefinitionId

        Required. The ID of the workflow definition containing the assignment rule to be changed. Silently ignored if the ID is provided as path parameter of the request.

  - ### Class ChangeDomainTypeAssignmentRuleRequest

    class ChangeDomainTypeAssignmentRuleRequest extends Object implements Serializable
    serialVersionUID:
      8747651758168295486L

    - #### Serialized Fields

      - ##### communityId

            UUID communityId

        The ID of the community the assignment rule should apply for.

      - ##### domainTypeId

            @NotNull UUID domainTypeId

        Required. The ID of the domain type the changed rule should refer to.

      - ##### exactResourceTypeMatch

            Boolean exactResourceTypeMatch

        When true, the workflow can only be started for a domain if its type matches exactly the domain type defined in this rule. Child domain types are excluded.

      - ##### ruleId

            @NotNull UUID ruleId

        Required. The ID of the domain type assignment rule. Silently ignored if the ID is provided as path parameter of the request.

      - ##### workflowDefinitionId

            @NotNull UUID workflowDefinitionId

        Required. The ID of the workflow definition containing the assignment rule to be changed. Silently ignored if the ID is provided as path parameter of the request.

  - ### Class ChangeWorkflowDefinitionRequest

    class ChangeWorkflowDefinitionRequest extends Object implements Serializable
    serialVersionUID:
      -4069952754751589567L

    - #### Serialized Fields

      - ##### businessItemResourceType

            WorkflowBusinessItemType businessItemResourceType

        The type of the business item corresponding to the workflow.

      - ##### candidateUserCheckDisabled

            Boolean candidateUserCheckDisabled

        Deprecated.
        Whether the candidate user check for the workflow should be disabled.

      - ##### candidateUserCheckEnabled

            Boolean candidateUserCheckEnabled

        Whether the candidate user check for the workflow should be enabled.

      - ##### configurationVariables

            Map<String,String> configurationVariables

        The configuration variables.

      - ##### description

            String description

        The new description for the workflow definition.

      - ##### enable

            Boolean enable

        Whether the workflow definition should be enabled.

      - ##### exclusivity

            WorkflowExclusivity exclusivity

        Defines the number of times a resource workflow is able to be start (see `WorkflowExclusivity`).

      - ##### globalCreate

            Boolean globalCreate

        Whether the workflow is accessible from the global create menu.

      - ##### guestUserAccessible

            Boolean guestUserAccessible

        Whether the workflow should be accessible by the guest user

      - ##### id

            @NotNull UUID id

        Required. The ID of the workflow definition. Silently ignored if the ID is provided as path parameter of the request.

      - ##### name

            @Size(min=1,max=2000) String name

        The name of the workflow definition.

      - ##### reassignRoleIds

            List<UUID> reassignRoleIds

        The list of IDs identifying the roles allowing to reassign the workflow.

      - ##### registeredUserAccessible

            Boolean registeredUserAccessible

        Whether the workflow should be accessible by the registered user.

      - ##### startEvents

            List<WorkflowStartEventType> startEvents

        The list of workflow start event types.

      - ##### startLabel

            String startLabel

        The start label of the workflow.

      - ##### startRoleIds

            List<UUID> startRoleIds

        The list of IDs identifying the roles allowing to start the workflow.

      - ##### stopRoleIds

            List<UUID> stopRoleIds

        The list of IDs identifying the roles allowing to stop the workflow.

  - ### Class CompleteWorkflowTasksRequest

    class CompleteWorkflowTasksRequest extends Object implements Serializable
    serialVersionUID:
      7986201001769164531L

    - #### Serialized Fields

      - ##### formProperties

            Map<String,String> formProperties

        Deprecated.
        This field will be removed. Please, use `CompleteWorkflowTasksRequest.taskFormProperties`
        The form properties for the workflow tasks to be completed. It allows users to complete workflow tasks using regular forms. This field's value will be ignored if the taskFormProperties field is populated.

      - ##### guestUserId

            UUID guestUserId

        Deprecated.
        This field will be removed without a replacement.
        The ID of the guest user.

      - ##### taskFormProperties

            Map<String,?> taskFormProperties

        The form properties for the workflow tasks to be completed. It allows users to complete workflow tasks using either regular forms or external json form definitions.

      - ##### taskIds

            @NotNull @Size(min=1) List<UUID> taskIds

        Required. The list of IDs for the tasks that should be completed.

  - ### Class DeployWorkflowDefinitionRequest

    class DeployWorkflowDefinitionRequest extends Object implements Serializable
    serialVersionUID:
      -7145637761749082167L

    - #### Serialized Fields

      - ##### fileName

            @NotNull @Size(min=1,max=255) String fileName

        Required. The name of the file.

      - ##### fileStream

            @NotNull InputStream fileStream

        Required. The file describing the workflow to be deployed.

  - ### Class FindWorkflowDefinitionsRequest

    class FindWorkflowDefinitionsRequest extends PagedRequest implements Serializable
    serialVersionUID:
      8894347260407933170L

    - #### Serialized Fields

      - ##### assetIds

            List<UUID> assetIds

        The list of the IDs of business items (assets) for which the workflow definitions should be found.

      - ##### communityIds

            List<UUID> communityIds

        The list of the IDs of business items (communities) for which the workflow definitions should be found.

      - ##### definitionIdPhrase

            String definitionIdPhrase

        The ID (could be partial) of workflow definition.

      - ##### description

            String description

        The description (could be partial) of the workflow definition to search for.

      - ##### domainIds

            List<UUID> domainIds

        The list of the IDs of business items (domains) for which the workflow definitions should be found.

      - ##### enabled

            Boolean enabled

        Whether the found workflow definitions should be enabled.

      - ##### global

            Boolean global

        Whether the found workflow definitions should be global.

      - ##### guardrailsValidationResult

            GuardrailsValidationResult guardrailsValidationResult

      - ##### name

            String name

        The name (could be partial) of the workflow definition to search for.

      - ##### sortField

            FindWorkflowDefinitionsRequest.SortField sortField

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order.

  - ### Class FindWorkflowInstancesRequest

    class FindWorkflowInstancesRequest extends PagedRequest implements Serializable
    serialVersionUID:
      5694106173507161637L

    - #### Serialized Fields

      - ##### businessItemId

            UUID businessItemId

        The ID of the business item that should be contained by the searched workflows.

      - ##### businessItemName

            String businessItemName

        The display name of the business item that should be contained by the searched workflows.

      - ##### parentWorkflowInstanceId

            String parentWorkflowInstanceId

        The ID of the parent workflow instance to query.

      - ##### sortField

            FindWorkflowInstancesRequest.SortField sortField

        The field on which the results are sorted.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order.

      - ##### workflowDefinitionId

            String workflowDefinitionId

        The ID of the workflow definition.

      - ##### workflowDefinitionName

            String workflowDefinitionName

        The name (or a part of it) of the workflow definition.

      - ##### workflowInstanceIdPhrase

            String workflowInstanceIdPhrase

  - ### Class FindWorkflowTasksRequest

    class FindWorkflowTasksRequest extends PagedRequest implements Serializable
    serialVersionUID:
      -6376919145177221741L

    - #### Serialized Fields

      - ##### businessItemId

            UUID businessItemId

        The ID of the business item.

      - ##### businessItemName

            String businessItemName

        The part of the name of the business item.

      - ##### businessItemType

            FindWorkflowTasksRequest.BusinessItemType businessItemType

        The type of the business item.

      - ##### createDate

            Long createDate

        The creation date of the task. It is the timestamp (in UTC time standard).

      - ##### description

            String description

        The part of the task description.

      - ##### dueDate

            Long dueDate

        The due date of the task. It is the timestamp (in UTC time standard).

      - ##### sortField

            FindWorkflowTasksRequest.SortField sortField

        The field on which the results are sorted. On due date by default. For possible values see `FindWorkflowTasksRequest.SortField`.

      - ##### sortOrder

            SortOrder sortOrder

        The sorting order.

      - ##### taskIdPhrase

            String taskIdPhrase

        The part of the id of the task.

      - ##### title

            String title

        The title/name of the task.

      - ##### type

            String type

        The task type.

      - ##### userId

            UUID userId

        The ID of the user for which the tasks need to be returned. If empty, the current logged in user will be used.

      - ##### workflowTaskUserRelation

            FindWorkflowTasksRequest.WorkflowTaskUserRelation workflowTaskUserRelation

        The type of relation between user and searched tasks.

        This could be either set to search for all the tasks the user is permitted to view or just those assigned to the user.

  - ### Class MessageEventReceivedRequest

    class MessageEventReceivedRequest extends Object implements Serializable
    serialVersionUID:
      -3009150891695632495L

    - #### Serialized Fields

      - ##### messageName

            @NotNull @Size(min=1) String messageName

        Required. The name of the message event.

      - ##### processInstanceId

            @NotNull @Size(min=1) String processInstanceId

        The ID of the workflow execution.

      - ##### variables

            Map<String,Object> variables

        The variables of the message event.

  - ### Class StartWorkflowInstancesRequest

    class StartWorkflowInstancesRequest extends Object implements Serializable
    serialVersionUID:
      5808842852449273270L

    - #### Serialized Fields

      - ##### businessItemIds

            List<UUID> businessItemIds

        The list of IDs for the business items.

      - ##### businessItemType

            WorkflowBusinessItemType businessItemType

        The resource type of the passed in business items.

      - ##### formProperties

            Map<String,String> formProperties

        The properties of the workflow.

      - ##### guestUserId

            UUID guestUserId

        Deprecated.
        This field will be removed without a replacement.
        The ID of the guest user starting the workflow.

      - ##### sendNotification

            boolean sendNotification

        Whether notification on starting the workflows should be sent.

      - ##### workflowDefinitionId

            @NotNull UUID workflowDefinitionId

        Required. The ID of the workflow definition.

- ## Package com.collibra.dgc.core.api.model

- ## Package com.collibra.dgc.core.api.model.activitystream

- ## Package com.collibra.dgc.core.api.model.articulation

- ## Package com.collibra.dgc.core.api.model.assignment

- ## Package com.collibra.dgc.core.api.model.file

- ## Package com.collibra.dgc.core.api.model.instance

- ## Package com.collibra.dgc.core.api.model.instance.attribute

- ## Package com.collibra.dgc.core.api.model.job

- ## Package com.collibra.dgc.core.api.model.mapping

- ## Package com.collibra.dgc.core.api.model.meta

- ## Package com.collibra.dgc.core.api.model.meta.inheritance

- ## Package com.collibra.dgc.core.api.model.meta.type

- ## Package com.collibra.dgc.core.api.model.meta.type.attribute

- ## Package com.collibra.dgc.core.api.model.meta.type.symbol

- ## Package com.collibra.dgc.core.api.model.navigation

- ## Package com.collibra.dgc.core.api.model.quality

- ## Package com.collibra.dgc.core.api.model.reference

- ## Package com.collibra.dgc.core.api.model.relationtrace

- ## Package com.collibra.dgc.core.api.model.role

- ## Package com.collibra.dgc.core.api.model.tag

- ## Package com.collibra.dgc.core.api.model.user

- ## Package com.collibra.dgc.core.api.model.usergroup

- ## Package com.collibra.dgc.core.api.model.validation

- ## Package com.collibra.dgc.core.api.model.view

- ## Package com.collibra.dgc.core.api.model.viewpermission

- ## Package com.collibra.dgc.core.api.model.workflow

- ## Package com.collibra.dgc.core.api.model.workflow.task