azure.purview.catalog.rest.glossary package¶

azure.purview.catalog.rest.glossary.build_list_glossaries_request(*, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all glossaries registered with Atlas.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "categories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "parentCategoryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            }
        ],
        "language": "str (optional)",
        "terms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "usage": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_create_glossary_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Create a glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – Glossary definition, terms & categories can be anchored to a glossary. Using the anchor attribute when creating the Term/Category.
content (Any) – Glossary definition, terms & categories can be anchored to a glossary. Using the anchor attribute when creating the Term/Category.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}


# response body for status code(s): 200
response_body == {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_create_glossary_categories_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Create glossary category in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – An array of glossary category definitions to be created.
content (Any) – An array of glossary category definitions to be created.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    {
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "childrenCategories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "parentCategoryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            }
        ],
        "parentCategory": {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "terms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]


# response body for status code(s): 200
response_body == [
    {
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "childrenCategories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "parentCategoryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            }
        ],
        "parentCategory": {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "terms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]

azure.purview.catalog.rest.glossary.build_create_glossary_category_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Create a glossary category.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – The glossary category definition. A category must be anchored to a Glossary when creating. Optionally, terms belonging to the category and the hierarchy can also be defined during creation.
content (Any) – The glossary category definition. A category must be anchored to a Glossary when creating. Optionally, terms belonging to the category and the hierarchy can also be defined during creation.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}


# response body for status code(s): 200
response_body == {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_get_glossary_category_request(category_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get specific glossary category by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: category_guid (str) – The globally unique identifier of the category.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_update_glossary_category_request(category_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the given glossary category by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

category_guid (str) – The globally unique identifier of the category.

Keyword Arguments

json (Any) – The glossary category to be updated.
content (Any) – The glossary category to be updated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}


# response body for status code(s): 200
response_body == {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_delete_glossary_category_request(category_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete a glossary category.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: category_guid (str) – The globally unique identifier of the category.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

azure.purview.catalog.rest.glossary.build_partial_update_glossary_category_request(category_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the glossary category partially.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

category_guid (str) – The globally unique identifier of the category.

Keyword Arguments

json (Any) – A map containing keys as attribute names and values as corresponding attribute values for partial update.
content (Any) – A map containing keys as attribute names and values as corresponding attribute values for partial update.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "str": "str (optional)"
}


# response body for status code(s): 200
response_body == {
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "childrenCategories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "parentCategory": {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_list_related_categories_request(category_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won’t work even they are passed.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

category_guid (str) – The globally unique identifier of the category.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "str": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_list_category_terms_request(category_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all terms associated with the specific category.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

category_guid (str) – The globally unique identifier of the category.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "description": "str (optional)",
        "displayText": "str (optional)",
        "expression": "str (optional)",
        "relationGuid": "str (optional)",
        "source": "str (optional)",
        "status": "str (optional)",
        "steward": "str (optional)",
        "termGuid": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_create_glossary_term_request(*, json: Any = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Create a glossary term.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – The glossary term definition. A term must be anchored to a Glossary at the time of creation. Optionally it can be categorized as well.
content (Any) – The glossary term definition. A term must be anchored to a Glossary at the time of creation. Optionally it can be categorized as well.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}


# response body for status code(s): 200
response_body == {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_get_glossary_term_request(term_guid: str, *, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get a specific glossary term by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: term_guid (str) – The globally unique identifier for glossary term.
Keyword Arguments: include_term_hierarchy (bool) – Whether include term hierarchy.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_update_glossary_term_request(term_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the given glossary term by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

json (Any) – The glossary term to be updated.
content (Any) – The glossary term to be updated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}


# response body for status code(s): 200
response_body == {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_delete_glossary_term_request(term_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete a glossary term.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: term_guid (str) – The globally unique identifier for glossary term.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

azure.purview.catalog.rest.glossary.build_partial_update_glossary_term_request(term_guid: str, *, json: Any = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the glossary term partially.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

json (Any) – A map containing keys as attribute names and values as corresponding attribute values to be updated.
content (Any) – A map containing keys as attribute names and values as corresponding attribute values to be updated.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "str": "str (optional)"
}


# response body for status code(s): 200
response_body == {
    "abbreviation": "str (optional)",
    "anchor": {
        "displayText": "str (optional)",
        "glossaryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    },
    "antonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "assignedEntities": [
        {
            "displayText": "str (optional)",
            "entityStatus": "str (optional)",
            "relationshipAttributes": {
                "attributes": {
                    "str": "object (optional)"
                },
                "lastModifiedTS": "str (optional)",
                "typeName": "str (optional)"
            },
            "relationshipGuid": "str (optional)",
            "relationshipStatus": "str (optional)",
            "relationshipType": "str (optional)"
        }
    ],
    "attributes": {
        "str": {
            "str": "object (optional)"
        }
    },
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "relationGuid": "str (optional)",
            "status": "str (optional)"
        }
    ],
    "classifies": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "contacts": {
        "str": [
            {
                "id": "str (optional)",
                "info": "str (optional)"
            }
        ]
    },
    "createTime": "float (optional)",
    "createdBy": "str (optional)",
    "examples": [
        "str (optional)"
    ],
    "isA": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "preferredToTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacedBy": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "replacementTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "resources": [
        {
            "displayName": "str (optional)",
            "url": "str (optional)"
        }
    ],
    "seeAlso": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "status": "str (optional)",
    "synonyms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "templateName": [
        "object (optional)"
    ],
    "translatedTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "translationTerms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "updateTime": "float (optional)",
    "updatedBy": "str (optional)",
    "usage": "str (optional)",
    "validValues": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "validValuesFor": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_create_glossary_terms_request(*, json: Any = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Create glossary terms in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – An array of glossary term definitions to be created in bulk.
content (Any) – An array of glossary term definitions to be created in bulk.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    {
        "abbreviation": "str (optional)",
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "antonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "assignedEntities": [
            {
                "displayText": "str (optional)",
                "entityStatus": "str (optional)",
                "relationshipAttributes": {
                    "attributes": {
                        "str": "object (optional)"
                    },
                    "lastModifiedTS": "str (optional)",
                    "typeName": "str (optional)"
                },
                "relationshipGuid": "str (optional)",
                "relationshipStatus": "str (optional)",
                "relationshipType": "str (optional)"
            }
        ],
        "attributes": {
            "str": {
                "str": "object (optional)"
            }
        },
        "categories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "relationGuid": "str (optional)",
                "status": "str (optional)"
            }
        ],
        "classifies": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "contacts": {
            "str": [
                {
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ]
        },
        "createTime": "float (optional)",
        "createdBy": "str (optional)",
        "examples": [
            "str (optional)"
        ],
        "isA": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredToTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacedBy": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacementTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "resources": [
            {
                "displayName": "str (optional)",
                "url": "str (optional)"
            }
        ],
        "seeAlso": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "status": "str (optional)",
        "synonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "templateName": [
            "object (optional)"
        ],
        "translatedTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "translationTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "updateTime": "float (optional)",
        "updatedBy": "str (optional)",
        "usage": "str (optional)",
        "validValues": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "validValuesFor": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]


# response body for status code(s): 200
response_body == [
    {
        "abbreviation": "str (optional)",
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "antonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "assignedEntities": [
            {
                "displayText": "str (optional)",
                "entityStatus": "str (optional)",
                "relationshipAttributes": {
                    "attributes": {
                        "str": "object (optional)"
                    },
                    "lastModifiedTS": "str (optional)",
                    "typeName": "str (optional)"
                },
                "relationshipGuid": "str (optional)",
                "relationshipStatus": "str (optional)",
                "relationshipType": "str (optional)"
            }
        ],
        "attributes": {
            "str": {
                "str": "object (optional)"
            }
        },
        "categories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "relationGuid": "str (optional)",
                "status": "str (optional)"
            }
        ],
        "classifies": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "contacts": {
            "str": [
                {
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ]
        },
        "createTime": "float (optional)",
        "createdBy": "str (optional)",
        "examples": [
            "str (optional)"
        ],
        "isA": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredToTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacedBy": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacementTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "resources": [
            {
                "displayName": "str (optional)",
                "url": "str (optional)"
            }
        ],
        "seeAlso": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "status": "str (optional)",
        "synonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "templateName": [
            "object (optional)"
        ],
        "translatedTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "translationTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "updateTime": "float (optional)",
        "updatedBy": "str (optional)",
        "usage": "str (optional)",
        "validValues": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "validValuesFor": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]

azure.purview.catalog.rest.glossary.build_get_entities_assigned_with_term_request(term_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all related objects assigned with the specified term.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "displayText": "str (optional)",
        "entityStatus": "str (optional)",
        "relationshipAttributes": {
            "attributes": {
                "str": "object (optional)"
            },
            "lastModifiedTS": "str (optional)",
            "typeName": "str (optional)"
        },
        "relationshipGuid": "str (optional)",
        "relationshipStatus": "str (optional)",
        "relationshipType": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_assign_term_to_entities_request(term_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Assign the given term to the provided list of related objects.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

json (Any) – An array of related object IDs to which the term has to be associated.
content (Any) – An array of related object IDs to which the term has to be associated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    {
        "displayText": "str (optional)",
        "entityStatus": "str (optional)",
        "relationshipAttributes": {
            "attributes": {
                "str": "object (optional)"
            },
            "lastModifiedTS": "str (optional)",
            "typeName": "str (optional)"
        },
        "relationshipGuid": "str (optional)",
        "relationshipStatus": "str (optional)",
        "relationshipType": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_remove_term_assignment_from_entities_request(term_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete the term assignment for the given list of related objects.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

json (Any) – An array of related object IDs from which the term has to be dissociated.
content (Any) – An array of related object IDs from which the term has to be dissociated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    {
        "displayText": "str (optional)",
        "entityStatus": "str (optional)",
        "relationshipAttributes": {
            "attributes": {
                "str": "object (optional)"
            },
            "lastModifiedTS": "str (optional)",
            "typeName": "str (optional)"
        },
        "relationshipGuid": "str (optional)",
        "relationshipStatus": "str (optional)",
        "relationshipType": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_delete_term_assignment_from_entities_request(term_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete the term assignment for the given list of related objects.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

json (Any) – An array of related object IDs from which the term has to be dissociated.
content (Any) – An array of related object IDs from which the term has to be dissociated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    {
        "displayText": "str (optional)",
        "entityStatus": "str (optional)",
        "relationshipAttributes": {
            "attributes": {
                "str": "object (optional)"
            },
            "lastModifiedTS": "str (optional)",
            "typeName": "str (optional)"
        },
        "relationshipGuid": "str (optional)",
        "relationshipStatus": "str (optional)",
        "relationshipType": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_list_related_terms_request(term_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won’t work even they are passed.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

term_guid (str) – The globally unique identifier for glossary term.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "str": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.glossary.build_get_glossary_request(glossary_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get a specific Glossary by its GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: glossary_guid (str) – The globally unique identifier for glossary.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_update_glossary_request(glossary_guid: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the given glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

json (Any) – The glossary definition to be updated.
content (Any) – The glossary definition to be updated.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}


# response body for status code(s): 200
response_body == {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_delete_glossary_request(glossary_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete a glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: glossary_guid (str) – The globally unique identifier for glossary.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

azure.purview.catalog.rest.glossary.build_list_glossary_categories_request(glossary_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the categories belonging to a specific glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "childrenCategories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "parentCategoryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            }
        ],
        "parentCategory": {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "terms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]

azure.purview.catalog.rest.glossary.build_list_glossary_categories_headers_request(glossary_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the category headers belonging to a specific glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "categoryGuid": "str (optional)",
        "description": "str (optional)",
        "displayText": "str (optional)",
        "parentCategoryGuid": "str (optional)",
        "relationGuid": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_get_detailed_glossary_request(glossary_guid: str, *, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get a specific glossary with detailed information.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: glossary_guid (str) – The globally unique identifier for glossary.
Keyword Arguments: include_term_hierarchy (bool) – Whether include term hierarchy.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "categoryInfo": {
        "str": {
            "anchor": {
                "displayText": "str (optional)",
                "glossaryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            },
            "childrenCategories": [
                {
                    "categoryGuid": "str (optional)",
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "parentCategoryGuid": "str (optional)",
                    "relationGuid": "str (optional)"
                }
            ],
            "parentCategory": {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "parentCategoryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            },
            "terms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ]
        }
    },
    "termInfo": {
        "str": {
            "abbreviation": "str (optional)",
            "anchor": {
                "displayText": "str (optional)",
                "glossaryGuid": "str (optional)",
                "relationGuid": "str (optional)"
            },
            "antonyms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "assignedEntities": [
                {
                    "displayText": "str (optional)",
                    "entityStatus": "str (optional)",
                    "relationshipAttributes": {
                        "attributes": {
                            "str": "object (optional)"
                        },
                        "lastModifiedTS": "str (optional)",
                        "typeName": "str (optional)"
                    },
                    "relationshipGuid": "str (optional)",
                    "relationshipStatus": "str (optional)",
                    "relationshipType": "str (optional)"
                }
            ],
            "attributes": {
                "str": {
                    "str": "object (optional)"
                }
            },
            "categories": [
                {
                    "categoryGuid": "str (optional)",
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "relationGuid": "str (optional)",
                    "status": "str (optional)"
                }
            ],
            "classifies": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "contacts": {
                "str": [
                    {
                        "id": "str (optional)",
                        "info": "str (optional)"
                    }
                ]
            },
            "createTime": "float (optional)",
            "createdBy": "str (optional)",
            "examples": [
                "str (optional)"
            ],
            "isA": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "preferredTerms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "preferredToTerms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "replacedBy": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "replacementTerms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "resources": [
                {
                    "displayName": "str (optional)",
                    "url": "str (optional)"
                }
            ],
            "seeAlso": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "status": "str (optional)",
            "synonyms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "templateName": [
                "object (optional)"
            ],
            "translatedTerms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "translationTerms": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "updateTime": "float (optional)",
            "updatedBy": "str (optional)",
            "usage": "str (optional)",
            "validValues": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "validValuesFor": [
                {
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ]
        }
    }
}

azure.purview.catalog.rest.glossary.build_partial_update_glossary_request(glossary_guid: str, *, json: Any = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

json (Any) – A map containing keys as attribute names and values as corresponding attribute values.
content (Any) – A map containing keys as attribute names and values as corresponding attribute values.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "str": "str (optional)"
}


# response body for status code(s): 200
response_body == {
    "categories": [
        {
            "categoryGuid": "str (optional)",
            "description": "str (optional)",
            "displayText": "str (optional)",
            "parentCategoryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        }
    ],
    "language": "str (optional)",
    "terms": [
        {
            "description": "str (optional)",
            "displayText": "str (optional)",
            "expression": "str (optional)",
            "relationGuid": "str (optional)",
            "source": "str (optional)",
            "status": "str (optional)",
            "steward": "str (optional)",
            "termGuid": "str (optional)"
        }
    ],
    "usage": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_list_glossary_terms_request(glossary_guid: str, *, include_term_hierarchy: Optional[bool] = False, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get terms belonging to a specific glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

include_term_hierarchy (bool) – Whether include term hierarchy.
limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "abbreviation": "str (optional)",
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "antonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "assignedEntities": [
            {
                "displayText": "str (optional)",
                "entityStatus": "str (optional)",
                "relationshipAttributes": {
                    "attributes": {
                        "str": "object (optional)"
                    },
                    "lastModifiedTS": "str (optional)",
                    "typeName": "str (optional)"
                },
                "relationshipGuid": "str (optional)",
                "relationshipStatus": "str (optional)",
                "relationshipType": "str (optional)"
            }
        ],
        "attributes": {
            "str": {
                "str": "object (optional)"
            }
        },
        "categories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "relationGuid": "str (optional)",
                "status": "str (optional)"
            }
        ],
        "classifies": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "contacts": {
            "str": [
                {
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ]
        },
        "createTime": "float (optional)",
        "createdBy": "str (optional)",
        "examples": [
            "str (optional)"
        ],
        "isA": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredToTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacedBy": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacementTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "resources": [
            {
                "displayName": "str (optional)",
                "url": "str (optional)"
            }
        ],
        "seeAlso": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "status": "str (optional)",
        "synonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "templateName": [
            "object (optional)"
        ],
        "translatedTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "translationTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "updateTime": "float (optional)",
        "updatedBy": "str (optional)",
        "usage": "str (optional)",
        "validValues": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "validValuesFor": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]

azure.purview.catalog.rest.glossary.build_list_glossary_term_headers_request(glossary_guid: str, *, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = 'ASC', **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get term headers belonging to a specific glossary.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
sort (str) – The sort order, ASC (default) or DESC.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "description": "str (optional)",
        "displayText": "str (optional)",
        "expression": "str (optional)",
        "relationGuid": "str (optional)",
        "source": "str (optional)",
        "status": "str (optional)",
        "steward": "str (optional)",
        "termGuid": "str (optional)"
    }
]

azure.purview.catalog.rest.glossary.build_import_glossary_terms_via_csv_request(glossary_guid: str, *, files: Optional[Dict[str, Any]] = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Import Glossary Terms from local csv file.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

files (dict[str, Any]) – Multipart input for files. See the template in our example to find the input shape.
content (Any) – Multipart input for files. See the template in our example to find the input shape.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# multipart input template you can fill out and use as your `files` input.
files = {
    "file": "IO. The csv file to import glossary terms from."
}


# response body for status code(s): 202
response_body == {
    "createTime": "str (optional)",
    "errorCode": "int (optional)",
    "errorMessage": "str (optional)",
    "id": "str (optional)",
    "importedTerms": "str (optional)",
    "lastUpdateTime": "str (optional)",
    "status": "str (optional)",
    "totalTermsDetected": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_import_glossary_terms_via_csv_by_glossary_name_request(glossary_name: str, *, files: Optional[Dict[str, Any]] = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Import Glossary Terms from local csv file by glossaryName.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_name (str) – The name of the glossary.

Keyword Arguments

files (dict[str, Any]) – Multipart input for files. See the template in our example to find the input shape.
content (Any) – Multipart input for files. See the template in our example to find the input shape.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# multipart input template you can fill out and use as your `files` input.
files = {
    "file": "IO. The csv file to import glossary terms from."
}


# response body for status code(s): 202
response_body == {
    "createTime": "str (optional)",
    "errorCode": "int (optional)",
    "errorMessage": "str (optional)",
    "id": "str (optional)",
    "importedTerms": "str (optional)",
    "lastUpdateTime": "str (optional)",
    "status": "str (optional)",
    "totalTermsDetected": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_get_import_csv_operation_status_request(operation_guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the status of import csv operation.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: operation_guid (str) – The globally unique identifier for async operation/job.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "createTime": "str (optional)",
    "errorCode": "int (optional)",
    "errorMessage": "str (optional)",
    "id": "str (optional)",
    "importedTerms": "str (optional)",
    "lastUpdateTime": "str (optional)",
    "status": "str (optional)",
    "totalTermsDetected": "str (optional)"
}

azure.purview.catalog.rest.glossary.build_export_glossary_terms_as_csv_request(glossary_guid: str, *, json: Any = None, content: Any = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Export Glossary Terms as csv file.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_guid (str) – The globally unique identifier for glossary.

Keyword Arguments

json (Any) – An array of term guids.
content (Any) – An array of term guids.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = [
    "str (optional)"
]

azure.purview.catalog.rest.glossary.build_list_terms_by_glossary_name_request(glossary_name: str, *, limit: Optional[int] = None, offset: Optional[int] = None, include_term_hierarchy: Optional[bool] = False, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get terms by glossary name.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

glossary_name (str) – The name of the glossary.

Keyword Arguments

limit (int) – The page size - by default there is no paging.
offset (int) – The offset for pagination purpose.
include_term_hierarchy (bool) – Whether include term hierarchy.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "abbreviation": "str (optional)",
        "anchor": {
            "displayText": "str (optional)",
            "glossaryGuid": "str (optional)",
            "relationGuid": "str (optional)"
        },
        "antonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "assignedEntities": [
            {
                "displayText": "str (optional)",
                "entityStatus": "str (optional)",
                "relationshipAttributes": {
                    "attributes": {
                        "str": "object (optional)"
                    },
                    "lastModifiedTS": "str (optional)",
                    "typeName": "str (optional)"
                },
                "relationshipGuid": "str (optional)",
                "relationshipStatus": "str (optional)",
                "relationshipType": "str (optional)"
            }
        ],
        "attributes": {
            "str": {
                "str": "object (optional)"
            }
        },
        "categories": [
            {
                "categoryGuid": "str (optional)",
                "description": "str (optional)",
                "displayText": "str (optional)",
                "relationGuid": "str (optional)",
                "status": "str (optional)"
            }
        ],
        "classifies": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "contacts": {
            "str": [
                {
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ]
        },
        "createTime": "float (optional)",
        "createdBy": "str (optional)",
        "examples": [
            "str (optional)"
        ],
        "isA": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "preferredToTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacedBy": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "replacementTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "resources": [
            {
                "displayName": "str (optional)",
                "url": "str (optional)"
            }
        ],
        "seeAlso": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "status": "str (optional)",
        "synonyms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "templateName": [
            "object (optional)"
        ],
        "translatedTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "translationTerms": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "updateTime": "float (optional)",
        "updatedBy": "str (optional)",
        "usage": "str (optional)",
        "validValues": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ],
        "validValuesFor": [
            {
                "description": "str (optional)",
                "displayText": "str (optional)",
                "expression": "str (optional)",
                "relationGuid": "str (optional)",
                "source": "str (optional)",
                "status": "str (optional)",
                "steward": "str (optional)",
                "termGuid": "str (optional)"
            }
        ]
    }
]