Purview Distribution Service REST API Document (stable:2023-01-01)

2025/12/05 • 3 new methods

DatasourcePreferences_List (new)
Description :  Get Datasource Preferences for given scope.
Reference :  Link ¶

⚼ Request

GET:  /datasource-preferences
{
scope:
{
Description: Id for any resource managed by Purview. ,
Required: True ,
}
string ,
api-version:
{
Description: The api-version of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Consent details. ,
Required: False ,
}
[
{
kind:
{
Description: Consent kind. ,
Required: False ,
}
string ,
status:
{
Description: Consent status. ,
Required: False ,
}
string ,
excludedScopes:
{
Description: List of scopes opted out of this consent. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
accountInfo:
{
Description: Details of the purview account governing the requested resource. ,
Required: False ,
}
{
id:
{
Description: Id of the Purview account. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Purview account. ,
Required: False ,
}
string ,
location:
{
Description: Location (Region) of the Purview account. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id of the Purview account. ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: Endpoint of the Purview account. This will be used by the RPs to call Purview APIs. ,
Required: False ,
}
string ,
}
,
frequency:
{
Description: This is an ISO8601 time span value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Error description. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PolicyElements_List (new)
Description :  Get policies for given scope.
Reference :  Link ¶

⚼ Request

GET:  /policy-elements
{
scope:
{
Description: Id for any resource managed by Purview. ,
Required: True ,
}
string ,
filter:
{
Description: Filter supporting full OData syntax. ,
Required: False ,
}
string ,
api-version:
{
Description: The api-version of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
syncToken:
{
Description: This sync token represents the latest checkpoint for policies. Client need to pass this value while fetching subsequent delta changes using policy-events API. ,
Required: False ,
}
string ,
nextLink:
{
Description: Link to fetch next set of policy elements. ,
Required: False ,
}
string ,
value:
{
Description: List of policy elements. ,
Required: False ,
}
[
{
id:
{
Description: Id of the policy element. ,
Required: True ,
}
string ,
scopes:
{
Description: List of scopes included in this policy. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: Current version of policy element. This is auto incremented with each change. Starts with 1. ,
Format: int64 ,
Required: True ,
}
integer ,
elementJson:
{
Description: Policy element serialized json payload. ,
Required: False ,
}
string ,
kind:
{
Description: Represents the kind of policy element. ,
Enum:
{
Policy: No description available. ,
PolicySet: No description available. ,
AttributeRule: No description available. ,
}
,
Required: True ,
}
enum ,
updatedAt:
{
Description: Time at which this policy element was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Error description. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PolicyEvents_List (new)
Description :  Get policy events for given scope.
Reference :  Link ¶

⚼ Request

GET:  /policy-events
{
scope:
{
Description: Id for any resource managed by Purview. ,
Required: True ,
}
string ,
syncToken:
{
Description: This sync token represents the latest checkpoint for policies. Client need to pass this value while fetching subsequent delta changes. ,
Required: True ,
}
string ,
api-version:
{
Description: The api-version of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
syncToken:
{
Description: This sync token represents the latest checkpoint for policies. Client need to pass this value while fetching subsequent delta changes. ,
Required: True ,
}
string ,
value:
{
Description: List of policy elements. ,
Required: False ,
}
[
{
id:
{
Description: Id of the policy element. ,
Required: True ,
}
string ,
scopes:
{
Description: List of scopes included in this policy. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: Current version of policy element. This is auto incremented with each change. Starts with 1. ,
Format: int64 ,
Required: True ,
}
integer ,
elementJson:
{
Description: Policy element serialized json payload. ,
Required: False ,
}
string ,
kind:
{
Description: Represents the kind of policy element. ,
Enum:
{
Policy: No description available. ,
PolicySet: No description available. ,
AttributeRule: No description available. ,
}
,
Required: True ,
}
enum ,
updatedAt:
{
Description: Time at which this policy element was last updated. ,
Format: date-time ,
Required: True ,
}
string ,
eventType:
{
Description: Type of event. Format: //. For Example: Microsoft.Purview/PolicyElements/Delete. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Default error model. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Error description. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}