Sign in
latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

View Permissions

Finds view permissions with given criteria.

Finds view permissions with given criteria.

get/viewPermissions

Query parameters

offsetinteger

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

limitinteger

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

countLimitinteger

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

userIdstring uuid

The ID of the user for whom the view permission applies.

userGroupIdstring uuid

The ID of the user group for whose members the view permission applies.

resourceIdstring uuid

The ID of the community or domain to which the view permissions apply.

resourceType'View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context'

Deprecated. Use <code>Community</code> or <code>Domain</code> to only retrieve view permissions assigned directly on a community or domain respectively. Do not use this filter in conjunction with the <code>resourceId</code> parameter.

resourceDiscriminatorstring

Use <code>Community</code> or <code>Domain</code> to only retrieve view permissions assigned directly on a community or domain respectively. Do not use this filter in conjunction with the <code>resourceId</code> parameter.

includeInheritedboolean

When you provide a <code>resourceId</code>, setting this parameter to <code>true</code> also returns the view permissions inherited from a parent community.

Response

default response

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.