Azure.Analytics.Purview.UnifiedCatalog (preview:2025-09-15)

2025/10/01 • 50 new methods

EnumerateDomains (new)
Description :  Enumerates business domains with optional continuation token and write-obligation filtering.
Reference :  Link ¶

⚼ Request

GET:  /businessdomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skipToken:
{
Description: skiptoken ,
Required: False ,
}
string ,
writeOnly:
{
Description: writeOnly ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
value:
{
Description: The Domain items on this page ,
Required: True ,
}
[
{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateDomain (new)
Description :  Creates a new business domain.
Reference :  Link ¶

⚼ Request

POST:  /businessdomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
domain:
{
Description: Domain payload to create. ,
Required: True ,
}
{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDomainById (new)
Description :  Retrieves a business domain by identifier.
Reference :  Link ¶

⚼ Request

GET:  /businessdomains/{domainId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateDomain (new)
Description :  Updates an existing business domain.
Reference :  Link ¶

⚼ Request

PUT:  /businessdomains/{domainId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
domainId:
{
Description: The unique identifier of the critical data domain. ,
Format: uuid ,
Required: True ,
}
string ,
domain:
{
Description: Updated domain payload. ,
Required: True ,
}
{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the domain. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the domain. ,
Enum:
{
FunctionalUnit: The status is FunctionalUnit. ,
LineOfBusiness: The status is LineOfBusiness. ,
DataDomain: The status is DataDomain. ,
Regulatory: The status is Regulatory. ,
Project: The status is Project. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the domain. ,
Required: False ,
}
string ,
isRestricted:
{
Description: Whether the domain is restricted. ,
Required: False ,
}
boolean ,
systemData:
{
Description: The system data of the domain. ,
Required: True ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the domain. ,
Required: False ,
}
string ,
parentId:
{
Description: Identifier of the domain to retrieve. ,
Format: uuid ,
Required: True ,
}
string ,
thumbnail:
{
Description: The thumbnail properties of the domain. ,
Required: True ,
}
{
color:
{
Description: The color of the thumbnail. ,
Required: False ,
}
string ,
}
,
domains:
{
Description: The list of platform domains. ,
Required: True ,
}
[
{
name:
{
Description: The name of the platform domain. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the platform domain. ,
Required: False ,
}
string ,
relatedCollections:
{
Description: The related collections of the platform domain. ,
Required: False ,
}
[
{
name:
{
Description: The name of the related collection. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the related collection. ,
Required: False ,
}
string ,
parentCollection:
{
Description: The parent collection of the related collection. ,
Required: False ,
}
{
type:
{
Description: The type of the parent collection. ,
Enum:
{
CollectionReference: Collection reference type. ,
}
,
Required: False ,
}
enum ,
refName:
{
Description: The reference name of the parent collection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
managedAttributes:
{
Description: The managed attributes associated with the domain. ,
Required: True ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteDomainById (new)
Description :  Deletes an existing business domain.
Reference :  Link ¶

⚼ Request

DELETE:  /businessdomains/{domainId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListCriticalDataElement (new)
Description :  Searches and retrieves critical data elements based on domain, keyword, and other filters.
Reference :  Link ¶

⚼ Request

GET:  /criticalDataElements
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
domainId:
{
Description: Whether to return minimal information for referred Domains. ,
Format: uuid ,
Required: False ,
}
string ,
keyword:
{
Description: Search keyword. ,
Required: False ,
}
string ,
orderBy:
{
Description: Expressions that specify the order of returned results. ,
Required: False ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The CriticalDataElement items on this page ,
Required: True ,
}
[
{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateCriticalDataElement (new)
Description :  Creates a new critical data element in the catalog.
Reference :  Link ¶

⚼ Request

POST:  /criticalDataElements
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElement:
{
Description: the critical data element to update. ,
Required: True ,
}
{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCriticalDataElementById (new)
Description :  Searches and retrieves critical data elements based on Id.
Reference :  Link ¶

⚼ Request

GET:  /criticalDataElements/{criticalDataElementId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateCriticalDataElement (new)
Description :  Updates an existing critical data element in the catalog.
Reference :  Link ¶

⚼ Request

PUT:  /criticalDataElements/{criticalDataElementId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
criticalDataElement:
{
Description: the critical data element to update. ,
Required: True ,
}
{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteCriticalDataElementById (new)
Description :  Deletes an existing critical data element in the catalog.
Reference :  Link ¶

⚼ Request

DELETE:  /criticalDataElements/{criticalDataElementId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListCriticalDataElementRelationships (new)
Description :  Lists relationships for the specified CDE and entity category.
Reference :  Link ¶

⚼ Request

GET:  /criticalDataElements/{criticalDataElementId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The body associated with the critical data element output. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CdeRelationship items on this page ,
Required: True ,
}
[
{
relationshipType:
{
Description: Type of the relationship. ,
Required: False ,
}
string ,
entityId:
{
Description: Unique identifier of the related entity. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateCriticalDataElementRelationship (new)
Description :  Creates a relationship between the specified CDE and another entity.
Reference :  Link ¶

⚼ Request

POST:  /criticalDataElements/{criticalDataElementId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The type of entity for the relationship. ,
Required: False ,
}
string ,
relationship:
{
Description: The input properties for creating the relationship. ,
Required: True ,
}
{
description:
{
Description: The first additional property. ,
Required: False ,
}
string ,
entityId:
{
Description: The second additional property. ,
Required: False ,
}
string ,
relationshipType:
{
Description: The third additional property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: System metadata for the relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: Description of the relationship. ,
Required: False ,
}
string ,
relationshipType:
{
Description: Type of the relationship. ,
Required: False ,
}
string ,
entityId:
{
Description: Unique identifier of the related entity. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteCriticalDataElementRelationship (new)
Description :  Deletes a relationship between the CDE and the specified entity.
Reference :  Link ¶

⚼ Request

DELETE:  /criticalDataElements/{criticalDataElementId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
criticalDataElementId:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The type of entity for the relationship. ,
Required: False ,
}
string ,
entityId:
{
Description: The unique identifier of the related entity. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCriticalDataElementFacets (new)
Description :  Retrieves facets for critical data elements.
Reference :  Link ¶

⚼ Request

POST:  /criticalDataElements/facets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
request:
{
Description: The request body containing query criteria. ,
Required: True ,
}
{
ids:
{
Description: To filter by Ids. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: To filter by domain Ids. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: To filter by name keyword. ,
Required: False ,
}
string ,
owners:
{
Description: To filter by owners. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: To filter by status. ,
Enum:
{
Draft: The entity is in draft state. ,
Published: The entity is published and active. ,
Expired: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: To filter by multiple status. ,
Required: False ,
}
[
string ,
]
,
facets:
{
Description: To filter by multiple facets. ,
Required: False ,
}
[
{
name:
{
Description: name ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
facets:
{
Description: The list of facets. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QueryCriticalDataElements (new)
Description :  Queries critical data elements based on various criteria.
Reference :  Link ¶

⚼ Request

POST:  /criticalDataElements/query
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
duplicatecheck:
{
Description: The number of duplicate checks to perform. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The request body containing query criteria. ,
Required: True ,
}
{
skip:
{
Description: Number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: Ordering criteria for the results. ,
Required: False ,
}
[
{
field:
{
Description: The field name to order by. ,
Required: False ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Required: False ,
}
string ,
}
,
]
,
ids:
{
Description: To filter by Ids. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: To filter by domain Ids. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: To filter by name keyword. ,
Required: False ,
}
string ,
owners:
{
Description: To filter by owners. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: To filter by status. ,
Enum:
{
Draft: The entity is in draft state. ,
Published: The entity is published and active. ,
Expired: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: To filter by multiple status. ,
Required: False ,
}
[
string ,
]
,
managedAttributes:
{
Description: To filter by managed attributes. ,
Required: False ,
}
[
{
field:
{
Description: The field name to filter on. ,
Required: False ,
}
string ,
operator:
{
Description: The comparison operator to use for filtering. ,
Required: False ,
}
string ,
value:
{
Description: The value to compare against. ,
Required: False ,
}
string ,
type:
{
Description: The data type of the filter value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of critical data elements. ,
Required: True ,
}
[
{
status:
{
Description: The current status of the critical data element. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: The data type of the critical data element. ,
Enum:
{
TEXT: Text data type. ,
NUMBER: Numeric data type. ,
DATETIME: Date and time data type. ,
BOOLEAN: Boolean data type. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The unique identifier of the critical data element. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the critical data element. ,
Required: False ,
}
string ,
systemData:
{
Description: System metadata including creation and modification information. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The unique identifier of the domain this element belongs to. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the critical data element. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with this critical data element. ,
Required: False ,
}
object ,
managedAttributes:
{
Description: Managed attributes associated with this critical data element. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListDataProducts (new)
Description :  Lists data products with optional domain filter, sorting and pagination.
Reference :  Link ¶

⚼ Request

GET:  /dataProducts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
domainId:
{
Description: Optional domain identifier filter. ,
Format: uuid ,
Required: False ,
}
string ,
orderBy:
{
Description: Expressions that specify the order of returned results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProduct items on this page ,
Required: True ,
}
[
{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateDataProduct (new)
Description :  Creates a new data product.
Reference :  Link ¶

⚼ Request

POST:  /dataProducts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProduct:
{
Description: The data product payload. ,
Required: True ,
}
{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDataProductById (new)
Description :  Retrieves a data product by its dataProductId.
Reference :  Link ¶

⚼ Request

GET:  /dataProducts/{dataProductId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateDataProduct (new)
Description :  Updates a data product by its DataProductId.
Reference :  Link ¶

⚼ Request

PUT:  /dataProducts/{dataProductId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the critical data product. ,
Format: uuid ,
Required: True ,
}
string ,
dataProduct:
{
Description: Updated data product payload. ,
Required: True ,
}
{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteDataProductById (new)
Description :  Deletes a data product by its dataProductId.
Reference :  Link ¶

⚼ Request

DELETE:  /dataProducts/{dataProductId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListDataProductRelationships (new)
Description :  Lists relationships for a data product filtered by entity category.
Reference :  Link ¶

⚼ Request

GET:  /dataProducts/{dataProductId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: Required entity category to list relationships for. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProductRelationship items on this page ,
Required: True ,
}
[
{
systemData:
{
Description: System metadata for the relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: Description of the relationship. ,
Required: False ,
}
string ,
relationshipType:
{
Description: Type of the relationship. ,
Required: False ,
}
string ,
entityId:
{
Description: Unique identifier of the related entity. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateDataProductRelationship (new)
Description :  Creates a relationship for a data product.
Reference :  Link ¶

⚼ Request

POST:  /dataProducts/{dataProductId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the critical data product. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: Category of the entity to relate to (required). ,
Required: True ,
}
string ,
relationship:
{
Description: Relationship payload as JSON. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
systemData:
{
Description: System metadata for the relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: Description of the relationship. ,
Required: False ,
}
string ,
relationshipType:
{
Description: Type of the relationship. ,
Required: False ,
}
string ,
entityId:
{
Description: Unique identifier of the related entity. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteDataProductRelationship (new)
Description :  Deletes a relationship between the data product and a specified entity.
Reference :  Link ¶

⚼ Request

DELETE:  /dataProducts/{dataProductId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier of the critical data product. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: Category of the related entity (required). ,
Required: True ,
}
string ,
entityId:
{
Description: Identifier of the related entity (required). ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDataProductFacets (new)
Description :  Retrieves facets for data products based on the supplied facets request.
Reference :  Link ¶

⚼ Request

POST:  /dataProducts/facets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
request:
{
Description: Facet request specifying which facets to compute. ,
Required: True ,
}
{
ids:
{
Description: To filter by Ids. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: To filter by domain Ids. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: To filter by name keyword. ,
Required: False ,
}
string ,
owners:
{
Description: To filter by owners. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: To filter by status. ,
Enum:
{
Draft: The entity is in draft state. ,
Published: The entity is published and active. ,
Expired: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: To filter by multiple status. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: To filter by type. ,
Required: False ,
}
string ,
types:
{
Description: To filter by multiple types. ,
Required: False ,
}
[
string ,
]
,
facets:
{
Description: To filter by multiple facets. ,
Required: False ,
}
[
{
name:
{
Description: name ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
facets:
{
Description: The list of facets. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QueryDataProducts (new)
Description :  Queries data products using the provided filter payload.
Reference :  Link ¶

⚼ Request

POST:  /dataProducts/query
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
duplicatecheck:
{
Description: Optional duplicate-check flag (1 to enable exact search). ,
Format: int32 ,
Required: False ,
}
integer ,
dataProductOwner:
{
Description: Optional flag to restrict results to owned data products. ,
Required: False ,
}
boolean ,
request:
{
Description: Query request containing filters and pagination. ,
Required: True ,
}
{
skip:
{
Description: Number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: To order the records. ,
Required: False ,
}
[
{
field:
{
Description: The field name to order by. ,
Required: False ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Required: False ,
}
string ,
}
,
]
,
ids:
{
Description: To filter by Ids. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: To filter by domain Ids. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: To filter by name keyword. ,
Required: False ,
}
string ,
type:
{
Description: To filter by type. ,
Required: False ,
}
string ,
types:
{
Description: To filter by multiple types. ,
Required: False ,
}
[
string ,
]
,
owners:
{
Description: To filter by owners. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: To filter by status. ,
Enum:
{
Draft: The entity is in draft state. ,
Published: The entity is published and active. ,
Expired: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: To filter by multiple status. ,
Required: False ,
}
[
string ,
]
,
managedAttributes:
{
Description: To filter by managed attributes. ,
Required: False ,
}
[
{
field:
{
Description: The field name to filter on. ,
Required: False ,
}
string ,
operator:
{
Description: The comparison operator to use for filtering. ,
Required: False ,
}
string ,
value:
{
Description: The value to compare against. ,
Required: False ,
}
string ,
type:
{
Description: The data type of the filter value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of data products. ,
Required: True ,
}
[
{
status:
{
Description: The status of the data product. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of the data product. ,
Enum:
{
Master: The status is Master. ,
Reference: The status is Reference. ,
Analytical: The status is Analytical. ,
AI: The status is AI. ,
MasterDataAndReferenceData: The status is MasterDataAndReferenceData. ,
BusinessSystemOrApplication: The status is BusinessSystemOrApplication. ,
ModelTypes: The status is ModelTypes. ,
DashboardsOrReports: The status is DashboardsOrReports. ,
Operational: The status is Operational. ,
MLAITrainingDataSet: The status is MLAITrainingDataSet. ,
MLAITestingDataSet: The status is MLAITestingDataSet. ,
TransactionalDataset: The status is TransactionalDataset. ,
AnalyticsModel: The status is AnalyticsModel. ,
SemanticModel: The status is SemanticModel. ,
}
,
Required: False ,
}
enum ,
updateFrequency:
{
Description: The update frequency of the data product. ,
Enum:
{
Hourly: The status is Hourly. ,
Daily: The status is Daily. ,
Weekly: The status is Weekly. ,
Monthly: The status is Monthly. ,
Quarterly: The status is Quarterly. ,
Yearly: The status is Yearly. ,
}
,
Required: False ,
}
enum ,
managedAttributes:
{
Description: The managed attributes associated with the data product. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
id:
{
Description: The unique identifier of the data product. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the data product. ,
Required: False ,
}
string ,
systemData:
{
Description: The system data of the data product. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
domain:
{
Description: The domain of the data product. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the data product. ,
Required: False ,
}
string ,
businessUse:
{
Description: The business use of the data product. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the data product. ,
Required: False ,
}
object ,
termsOfUse:
{
Description: The terms of use for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
documentation:
{
Description: The documentation links for the data product. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the external link. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of the external link. ,
Required: False ,
}
string ,
dataAssetId:
{
Description: The data asset identifier associated with the link. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
sensitivityLabel:
{
Description: The sensitivity label of the data product. ,
Required: False ,
}
string ,
endorsed:
{
Description: Whether the data product is endorsed. ,
Required: False ,
}
boolean ,
activeSubscriberCount:
{
Description: The number of active subscribers. ,
Format: int32 ,
Required: False ,
}
integer ,
dataQualityScore:
{
Description: The data quality score of the data product. ,
Format: double ,
Required: False ,
}
number ,
audience:
{
Description: The target audience for the data product. ,
Required: False ,
}
[
string ,
]
,
additionalProperties:
{
Description: Additional properties of the data product. ,
Required: False ,
}
{
assetCount:
{
Description: The number of assets in the data product. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListObjectives (new)
Description :  Lists objectives with optional filters, sorting and pagination.
Reference :  Link ¶

⚼ Request

GET:  /objectives
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
keyword:
{
Description: Optional search keyword to match objective definition. ,
Required: False ,
}
string ,
domainId:
{
Description: Optional domain identifier filter. ,
Required: False ,
}
string ,
orderBy:
{
Description: Expressions that specify the order of returned results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ObjectiveWithAdditionalProperties items on this page ,
Required: True ,
}
[
{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateObjective (new)
Description :  Creates a new objective (OKR).
Reference :  Link ¶

⚼ Request

POST:  /objectives
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objective:
{
Description: The objective payload, including additional properties. ,
Required: True ,
}
{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetObjectiveById (new)
Description :  Retrieves an objective by identifier.
Reference :  Link ¶

⚼ Request

GET:  /objectives/{objectiveId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateObjective (new)
Description :  Updates an existing objective (OKR) by ID.
Reference :  Link ¶

⚼ Request

PUT:  /objectives/{objectiveId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the critical data objective. ,
Format: uuid ,
Required: True ,
}
string ,
objective:
{
Description: Updated objective payload. ,
Required: True ,
}
{
status:
{
Description: The overall status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: False ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for objective query. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteObjectiveById (new)
Description :  Deletes an objective by identifier.
Reference :  Link ¶

⚼ Request

DELETE:  /objectives/{objectiveId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListKeyResults (new)
Description :  Lists key results for a given objective.
Reference :  Link ¶

⚼ Request

GET:  /objectives/{objectiveId}/keyResults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The KeyResult items on this page ,
Required: True ,
}
[
{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateKeyResult (new)
Description :  Creates a key result under the specified objective.
Reference :  Link ¶

⚼ Request

POST:  /objectives/{objectiveId}/keyResults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the critical data objective. ,
Format: uuid ,
Required: True ,
}
string ,
keyResult:
{
Description: Key result payload. ,
Required: True ,
}
{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}
,
}

⚐ Response (201)

{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetKeyResultById (new)
Description :  Retrieves a key result by its identifier under the specified objective
Reference :  Link ¶

⚼ Request

GET:  /objectives/{objectiveId}/keyResults/{keyResultId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the critical data objective. ,
Format: uuid ,
Required: True ,
}
string ,
keyResultId:
{
Description: The unique identifier of the key result (OKR). ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: True ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: True ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateKeyResult (new)
Description :  Updates a key result under the specified objective.
Reference :  Link ¶

⚼ Request

PUT:  /objectives/{objectiveId}/keyResults/{keyResultId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the critical data objective. ,
Format: uuid ,
Required: True ,
}
string ,
keyResultId:
{
Description: The unique identifier of the key result (OKR). ,
Format: uuid ,
Required: True ,
}
string ,
keyResult:
{
Description: Updated key result payload. ,
Required: True ,
}
{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: False ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of key results. ,
Required: True ,
}
[
{
status:
{
Description: The status of the key result. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the key result. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the key result. ,
Format: uuid ,
Required: False ,
}
string ,
definition:
{
Description: The definition of the key result. ,
Required: False ,
}
string ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: False ,
}
string ,
progress:
{
Description: The progress of the key result. ,
Format: double ,
Required: False ,
}
number ,
goal:
{
Description: The goal value for the key result. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: The maximum value for the key result. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteKeyResultById (new)
Description :  Deletes a key result by its identifier under the specified objective.
Reference :  Link ¶

⚼ Request

DELETE:  /objectives/{objectiveId}/keyResults/{keyResultId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
objectiveId:
{
Description: The unique identifier of the critical data objective. ,
Format: uuid ,
Required: True ,
}
string ,
keyResultId:
{
Description: The unique identifier of the key result (OKR). ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetObjectiveFacets (new)
Description :  Retrieves the facets for objectives (OKRs).
Reference :  Link ¶

⚼ Request

POST:  /objectives/facets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
request:
{
Description: Facet request specifying which facets to compute. ,
Required: True ,
}
{
ids:
{
Description: Filter by objective IDs. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: Filter by domain IDs. ,
Required: False ,
}
[
string ,
]
,
definition:
{
Description: Filter by objective definition. ,
Required: False ,
}
string ,
owners:
{
Description: Filter by objective owners. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Filter by objective status. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: Filter by multiple objective statuses. ,
Required: False ,
}
[
string ,
]
,
facets:
{
Description: Filter by facet objects. ,
Required: False ,
}
[
{
name:
{
Description: The name of the facet. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
facets:
{
Description: The list of facets. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QueryObjectives (new)
Description :  Queries objectives (OKRs) based on specified criteria.
Reference :  Link ¶

⚼ Request

POST:  /objectives/query
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
duplicatecheck:
{
Description: Optional duplicate-check flag (1 to enable exact search). ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: Query request containing filters and pagination. ,
Required: True ,
}
{
skip:
{
Description: Number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: Order by specifications for the query. ,
Required: False ,
}
[
{
field:
{
Description: The field name to order by. ,
Required: False ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Required: False ,
}
string ,
}
,
]
,
ids:
{
Description: Filter by objective IDs. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: Filter by domain IDs. ,
Required: False ,
}
[
string ,
]
,
definition:
{
Description: Filter by objective definition. ,
Required: False ,
}
string ,
status:
{
Description: Filter by objective status. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: Filter by multiple objective statuses. ,
Required: False ,
}
[
string ,
]
,
owners:
{
Description: Filter by objective owners. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of objectives with additional properties. ,
Required: True ,
}
[
{
status:
{
Description: The status of the objective. ,
Enum:
{
Draft: The status is Draft. ,
Published: The status is published. ,
Closed: The status is Closed. ,
}
,
Required: False ,
}
enum ,
systemData:
{
Description: The system data associated with the objective. ,
Required: False ,
}
{
createdAt:
{
Description: The created time of the record. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The user who Last modified the record. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
closedAt:
{
Description: The time when the record was closed. ,
Format: date-time ,
Required: False ,
}
string ,
closedBy:
{
Description: The user who closed the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
id:
{
Description: The unique identifier of the objective. ,
Format: uuid ,
Required: True ,
}
string ,
definition:
{
Description: The definition of the objective. ,
Required: True ,
}
string ,
domain:
{
Description: The domain associated with the objective. ,
Format: uuid ,
Required: False ,
}
string ,
targetDate:
{
Description: The target date for the objective. ,
Format: date-time ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the objective. ,
Required: False ,
}
object ,
additionalProperties:
{
Description: Additional properties for the objective. ,
Required: False ,
}
{
overallStatus:
{
Description: The overall status of the objective. ,
Enum:
{
NotTracked: The status is NotTracked. ,
OnTrack: The status is OnTrack. ,
Behind: The status is Behind. ,
AtRisk: The status is AtRisk. ,
}
,
Required: False ,
}
enum ,
overallProgress:
{
Description: The overall progress of the objective. ,
Format: double ,
Required: False ,
}
number ,
overallGoal:
{
Description: The overall goal value for the objective. ,
Format: double ,
Required: False ,
}
number ,
overallMax:
{
Description: The maximum value for the objective. ,
Format: double ,
Required: False ,
}
number ,
keyResultsCount:
{
Description: The number of key results associated with the objective. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListPolicies (new)
Description :  Lists policies with optional continuation token.
Reference :  Link ¶

⚼ Request

GET:  /policies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skipToken:
{
Description: Optional continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
values:
{
Description: The list of catalog values. ,
Required: True ,
}
[
{
name:
{
Description: The name of the catalog. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the catalog. ,
Required: True ,
}
string ,
version:
{
Description: The version of the catalog. ,
Format: int32 ,
Required: True ,
}
integer ,
properties:
{
Description: The properties of the catalog. ,
Required: True ,
}
{
description:
{
Description: The description of the catalog. ,
Required: False ,
}
string ,
decisionRules:
{
Description: The type of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of decision rule. ,
Required: True ,
}
string ,
effect:
{
Description: The unique identifier of the decision rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The name of the decision rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The attribute rules of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of attribute rule. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the attribute rule. ,
Required: True ,
}
string ,
name:
{
Description: The name of the attribute rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The description of the attribute rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
entity:
{
Description: The entity reference of the catalog. ,
Required: True ,
}
{
type:
{
Description: The type of the entity. ,
Required: True ,
}
string ,
referenceName:
{
Description: The reference name of the entity. ,
Required: True ,
}
string ,
}
,
parentEntityName:
{
Description: The parent entity name of the catalog. ,
Required: False ,
}
string ,
}
,
}
,
]
,
skipToken:
{
Description: The continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdatePolicy (new)
Description :  Updates a policy by its identifier.
Reference :  Link ¶

⚼ Request

PUT:  /policies/{policyId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
policyId:
{
Description: The unique identifier of the policy. ,
Format: uuid ,
Required: True ,
}
string ,
request:
{
Description: Updated policy payload. ,
Required: True ,
}
{
name:
{
Description: The name of the catalog. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the catalog. ,
Required: True ,
}
string ,
version:
{
Description: The version of the catalog. ,
Format: int32 ,
Required: True ,
}
integer ,
properties:
{
Description: The properties of the catalog. ,
Required: True ,
}
{
description:
{
Description: The description of the catalog. ,
Required: False ,
}
string ,
decisionRules:
{
Description: The type of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of decision rule. ,
Required: True ,
}
string ,
effect:
{
Description: The unique identifier of the decision rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The name of the decision rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The attribute rules of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of attribute rule. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the attribute rule. ,
Required: True ,
}
string ,
name:
{
Description: The name of the attribute rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The description of the attribute rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
entity:
{
Description: The entity reference of the catalog. ,
Required: True ,
}
{
type:
{
Description: The type of the entity. ,
Required: True ,
}
string ,
referenceName:
{
Description: The reference name of the entity. ,
Required: True ,
}
string ,
}
,
parentEntityName:
{
Description: The parent entity name of the catalog. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the catalog. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the catalog. ,
Required: True ,
}
string ,
version:
{
Description: The version of the catalog. ,
Format: int32 ,
Required: True ,
}
integer ,
properties:
{
Description: The properties of the catalog. ,
Required: True ,
}
{
description:
{
Description: The description of the catalog. ,
Required: False ,
}
string ,
decisionRules:
{
Description: The type of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of decision rule. ,
Required: True ,
}
string ,
effect:
{
Description: The unique identifier of the decision rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The name of the decision rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
attributeRules:
{
Description: The attribute rules of the catalog. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of attribute rule. ,
Required: True ,
}
string ,
id:
{
Description: The unique identifier of the attribute rule. ,
Required: True ,
}
string ,
name:
{
Description: The name of the attribute rule. ,
Required: True ,
}
string ,
dnfCondition:
{
Description: The description of the attribute rule. ,
Required: True ,
}
[
{
attributeName:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
attributeValueIncludes:
{
Description: The operator of the condition. ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: The values included in the condition. ,
Required: False ,
}
[
string ,
]
,
fromRule:
{
Description: The rule from which the condition is derived. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
entity:
{
Description: The entity reference of the catalog. ,
Required: True ,
}
{
type:
{
Description: The type of the entity. ,
Required: True ,
}
string ,
referenceName:
{
Description: The reference name of the entity. ,
Required: True ,
}
string ,
}
,
parentEntityName:
{
Description: The parent entity name of the catalog. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListTerm (new)
Description :  Lists terms with optional domain/parent/keyword filters and pagination.
Reference :  Link ¶

⚼ Request

GET:  /terms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
domainId:
{
Description: The unique identifier of the domain. ,
Format: uuid ,
Required: False ,
}
string ,
parentId:
{
Description: The unique identifier of the parent term. ,
Format: uuid ,
Required: False ,
}
string ,
keyword:
{
Description: Search keyword. ,
Required: False ,
}
string ,
depth:
{
Description: The depth of the term. ,
Format: int32 ,
Required: False ,
}
integer ,
orderBy:
{
Description: Expressions that specify the order of returned results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Term items on this page ,
Required: True ,
}
[
{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateTerm (new)
Description :  Creates a new term in the catalog.
Reference :  Link ¶

⚼ Request

POST:  /terms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
term:
{
Description: Term payload. ,
Required: True ,
}
{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetTerm (new)
Description :  Retrieves a single term by identifier.
Reference :  Link ¶

⚼ Request

GET:  /terms/{termId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateTerm (new)
Description :  Updates an existing term
Reference :  Link ¶

⚼ Request

PUT:  /terms/{termId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the critical data term or Parent term identifier. ,
Format: uuid ,
Required: True ,
}
string ,
term:
{
Description: Updated term payload. ,
Required: True ,
}
{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteTerm (new)
Description :  Deletes a term by its unique identifier.
Reference :  Link ¶

⚼ Request

DELETE:  /terms/{termId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListHierarchyTerms (new)
Description :  Lists hierarchical terms under the specified term id.
Reference :  Link ¶

⚼ Request

GET:  /terms/{termId}/hierarchies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the critical data term or Parent term identifier. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of terms. ,
Required: True ,
}
[
{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListRelatedEntities (new)
Description :  Lists related entities for a term by category and optional relationship type.
Reference :  Link ¶

⚼ Request

GET:  /terms/{termId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The type of entity to retrieve relationships for. ,
Required: False ,
}
string ,
relationshipType:
{
Description: Optional relationship type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TermRelationship items on this page ,
Required: True ,
}
[
{
systemData:
{
Description: System metadata for the term relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: description for the term relationship ,
Required: False ,
}
string ,
entityId:
{
Description: The unique identifier of the entity. ,
Format: uuid ,
Required: True ,
}
string ,
relationshipType:
{
Description: The type of the term relationship. ,
Enum:
{
Related: The status is Related. ,
Synonym: The status is Synonym. ,
Parent: The status is Parent. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AddRelatedEntity (new)
Description :  Adds a related entity to a term.
Reference :  Link ¶

⚼ Request

POST:  /terms/{termId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the critical data term or Parent term identifier. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The type of entity to retrieve relationships for. ,
Required: False ,
}
string ,
termRelation:
{
Description: Relationship payload. ,
Required: True ,
}
{
systemData:
{
Description: System metadata for the term relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: description for the term relationship ,
Required: False ,
}
string ,
entityId:
{
Description: The unique identifier of the entity. ,
Format: uuid ,
Required: True ,
}
string ,
relationshipType:
{
Description: The type of the term relationship. ,
Enum:
{
Related: The status is Related. ,
Synonym: The status is Synonym. ,
Parent: The status is Parent. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: System metadata for the term relationship. ,
Required: False ,
}
{
lastModifiedAt:
{
Description: The timestamp when the entity was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the entity. ,
Format: uuid ,
Required: False ,
}
string ,
createdAt:
{
Description: The timestamp when the entity was created. ,
Required: False ,
}
string ,
createdBy:
{
Description: Unique identifier of the asset. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: description for the term relationship ,
Required: False ,
}
string ,
entityId:
{
Description: The unique identifier of the entity. ,
Format: uuid ,
Required: True ,
}
string ,
relationshipType:
{
Description: The type of the term relationship. ,
Enum:
{
Related: The status is Related. ,
Synonym: The status is Synonym. ,
Parent: The status is Parent. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteRelatedTerm (new)
Description :  Deletes a related entity from a term.
Reference :  Link ¶

⚼ Request

DELETE:  /terms/{termId}/relationships
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
termId:
{
Description: The unique identifier of the critical data term or Parent term identifier. ,
Format: uuid ,
Required: True ,
}
string ,
entityType:
{
Description: The type of entity to retrieve relationships for. ,
Required: False ,
}
string ,
relationshipType:
{
Description: Optional relationship type. ,
Required: False ,
}
string ,
entityId:
{
Description: Related entity identifier. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetTermFacets (new)
Description :  Retrieves facets for terms.
Reference :  Link ¶

⚼ Request

POST:  /terms/facets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
request:
{
Description: Facet request specifying which facets to compute. ,
Required: True ,
}
{
ids:
{
Description: To filter by Ids. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: To filter by domain Ids. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: To filter by name keyword. ,
Required: False ,
}
string ,
owners:
{
Description: To filter by owners. ,
Required: False ,
}
[
string ,
]
,
acronyms:
{
Description: To filter by acronyms. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: To filter by status. ,
Enum:
{
Draft: The entity is in draft state. ,
Published: The entity is published and active. ,
Expired: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: To filter by multiple status. ,
Required: False ,
}
[
string ,
]
,
facets:
{
Description: To filter by multiple facets. ,
Required: False ,
}
[
{
name:
{
Description: name ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
facets:
{
Description: The list of facets. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QueryTerms (new)
Description :  Queries terms based on the provided request.
Reference :  Link ¶

⚼ Request

POST:  /terms/query
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
duplicatecheck:
{
Description: The bypassObligations to skip obligations. ,
Format: int32 ,
Required: False ,
}
integer ,
request:
{
Description: The request body containing query criteria. ,
Required: True ,
}
{
skip:
{
Description: Number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: Order by specifications for the query. ,
Required: False ,
}
[
{
field:
{
Description: The field name to order by. ,
Required: False ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Required: False ,
}
string ,
}
,
]
,
ids:
{
Description: Filter by term IDs. ,
Required: False ,
}
[
string ,
]
,
domainIds:
{
Description: Filter by domain IDs. ,
Required: False ,
}
[
string ,
]
,
nameKeyword:
{
Description: Filter by name keyword. ,
Required: False ,
}
string ,
status:
{
Description: Filter by term status. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: False ,
}
enum ,
multiStatus:
{
Description: Filter by multiple term statuses. ,
Required: False ,
}
[
string ,
]
,
owners:
{
Description: Filter by term owners. ,
Required: False ,
}
[
string ,
]
,
acronyms:
{
Description: Filter by term acronyms. ,
Required: False ,
}
[
string ,
]
,
managedAttributes:
{
Description: Filter by managed attributes. ,
Required: False ,
}
[
{
field:
{
Description: The field name to filter on. ,
Required: False ,
}
string ,
operator:
{
Description: The comparison operator to use for filtering. ,
Required: False ,
}
string ,
value:
{
Description: The value to compare against. ,
Required: False ,
}
string ,
type:
{
Description: The data type of the filter value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of terms. ,
Required: True ,
}
[
{
status:
{
Description: The status of the term. ,
Enum:
{
DRAFT: The entity is in draft state. ,
PUBLISHED: The entity is published and active. ,
EXPIRED: The entity has expired and is no longer active. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The unique identifier of the term. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The name of the term. ,
Required: True ,
}
string ,
systemData:
{
Description: The system data of the term. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp when the record was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The unique identifier of the user who created the record. ,
Format: uuid ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The timestamp when the record was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The unique identifier of the user who last modified the record. ,
Format: uuid ,
Required: False ,
}
string ,
expiredAt:
{
Description: The timestamp when the record expires. ,
Format: date-time ,
Required: False ,
}
string ,
expiredBy:
{
Description: The unique identifier of the user who expired the record. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the term. ,
Required: False ,
}
string ,
contacts:
{
Description: The contacts associated with the term. ,
Required: False ,
}
object ,
domain:
{
Description: The domain associated with the term. ,
Format: uuid ,
Required: True ,
}
string ,
parentId:
{
Description: The parent term identifier. ,
Format: uuid ,
Required: False ,
}
string ,
acronyms:
{
Description: The list of acronyms for the term. ,
Required: False ,
}
[
string ,
]
,
resources:
{
Description: The resources associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
isLeaf:
{
Description: Whether the term is a leaf node. ,
Required: False ,
}
boolean ,
managedAttributes:
{
Description: The managed attributes associated with the term. ,
Required: False ,
}
[
{
name:
{
Description: The name of the managed attribute. ,
Required: False ,
}
string ,
value:
{
Description: The value of the attribute. ,
Required: False ,
}
string ,
isRequired:
{
Description: Whether this attribute is required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}