Atlas REST API: GlossaryREST

GET /v2/glossary

Retrieve all glossaries registered with Atlas

Request Parameters
name	type	description	default
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	Sort order, ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of existing glossaries fitting the search criteria or empty list if nothing matches

Response Body
media type	data type	description
application/json	array of AtlasGlossary (JSON)	List of glossary entities fitting the above criteria
application/json	array of AtlasGlossary (JSON)	List of glossary entities fitting the above criteria

Example

Request

GET /v2/glossary
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

POST /v2/glossary

Create a glossary

Request Body
media type	data type	description
application/json	AtlasGlossary (JSON)	Glossary definition, terms & categories can be anchored to a glossary using the anchor attribute when creating the Term/Category
application/json	AtlasGlossary (JSON)

Response Codes
code	condition
200	If glossary creation was successful
400	If Glossary definition has invalid or missing information
409	If Glossary definition already exists (duplicate qualifiedName)

Response Body
media type	data type	description
application/json	AtlasGlossary (JSON)
application/json	AtlasGlossary (JSON)

Example

Request

POST /v2/glossary
Content-Type: application/json
Accept: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

POST /v2/glossary/categories

Create glossary category in bulk

Request Body
media type	data type	description
application/json	array of AtlasGlossaryCategory (JSON)	glossary category definitions
application/json	array of AtlasGlossaryCategory (JSON)	glossary category definitions

Response Codes
code	condition
200	If BULK glossary category creation was successful
400	If ANY Glossary category definition has invalid or missing information

Response Body
media type	data type	description
application/json	array of AtlasGlossaryCategory (JSON)
application/json	array of AtlasGlossaryCategory (JSON)

Example

Request

POST /v2/glossary/categories
Content-Type: application/json
Accept: application/json

                
[ {
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

POST /v2/glossary/category

Create glossary category

Request Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)	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
application/json	AtlasGlossaryCategory (JSON)

Response Codes
code	condition
200	If glossary category creation was successful
400	If Glossary category definition has invalid or missing information
409	If Glossary category already exists (duplicate qualifiedName)

Response Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)
application/json	AtlasGlossaryCategory (JSON)

Example

Request

POST /v2/glossary/category
Content-Type: application/json
Accept: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

POST /v2/glossary/import

Upload glossary file for creating AtlasGlossaryTerms in bulk

Request Parameters
name	type	description
fileDetail	formdata	FormDataContentDisposition metadata of file
inputStream	formdata	InputStream of file

Request Body
media type	data type
multipart/form-data	(custom)

Response Codes
code	condition
200	If glossary term creation was successful
400	If Glossary term definition has invalid or missing information
409	If Glossary term already exists (duplicate qualifiedName)

Response Body
media type	data type	description
application/json	BulkImportResponse (JSON)
application/json	BulkImportResponse (JSON)

Example

Request

POST /v2/glossary/import
Content-Type: multipart/form-data
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "failedImportInfoList" : [ {
    "childObjectName" : "...",
    "importStatus" : "SUCCESS",
    "parentObjectName" : "...",
    "remarks" : "..."
  }, {
    "childObjectName" : "...",
    "importStatus" : "SUCCESS",
    "parentObjectName" : "...",
    "remarks" : "..."
  } ],
  "successImportInfoList" : [ {
    "childObjectName" : "...",
    "importStatus" : "FAILED",
    "parentObjectName" : "...",
    "remarks" : "..."
  }, {
    "childObjectName" : "...",
    "importStatus" : "FAILED",
    "parentObjectName" : "...",
    "remarks" : "..."
  } ]
}

POST /v2/glossary/term

Create a glossary term

Request Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)	Glossary term definition, a term must be anchored to a Glossary at the time of creation optionally it can be categorized as well
application/json	AtlasGlossaryTerm (JSON)

Response Codes
code	condition
200	If glossary term creation was successful
400	If Glossary term definition has invalid or missing information
409	If Glossary term already exists (duplicate qualifiedName)

Response Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)
application/json	AtlasGlossaryTerm (JSON)

Example

Request

POST /v2/glossary/term
Content-Type: application/json
Accept: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DRAFT"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DRAFT"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

POST /v2/glossary/terms

Create glossary terms in bulk

Request Body
media type	data type	description
application/json	array of AtlasGlossaryTerm (JSON)	glossary term definitions
application/json	array of AtlasGlossaryTerm (JSON)	glossary term definitions

Response Codes
code	condition
200	If Bulk glossary terms creation was successful
400	If any glossary term definition has invalid or missing information

Response Body
media type	data type	description
application/json	array of AtlasGlossaryTerm (JSON)
application/json	array of AtlasGlossaryTerm (JSON)

Example

Request

POST /v2/glossary/terms
Content-Type: application/json
Accept: application/json

                
[ {
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OTHER"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DRAFT"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DRAFT"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

DELETE /v2/glossary/{glossaryGuid}

Delete a glossary

Request Parameters
name	type	description
glossaryGuid	path	unique identifier for glossary

Response Codes
code	condition
204	If glossary delete was successful
404	If glossary guid in invalid

Example

Request

DELETE /v2/glossary/{glossaryGuid}
Content-Type: application/json

                
...

Response

HTTP/1.1 204 No Content

GET /v2/glossary/{glossaryGuid}

Get a specific Glossary

Request Parameters
name	type	description
glossaryGuid	path	unique glossary identifier

Response Codes
code	condition
200	If glossary with given guid exists
404	If glossary GUID is invalid

Response Body
media type	data type	description
application/json	AtlasGlossary (JSON)	Glossary
application/json	AtlasGlossary (JSON)	Glossary

Example

Request

GET /v2/glossary/{glossaryGuid}
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

PUT /v2/glossary/{glossaryGuid}

Update the given glossary

Request Parameters
name	type	description
glossaryGuid	path	unique identifier for glossary

Request Body
media type	data type	description
application/json	AtlasGlossary (JSON)	Updated glossary definition
application/json	AtlasGlossary (JSON)	Updated glossary definition

Response Codes
code	condition
200	If glossary update was successful
404	If glossary guid in invalid
400	If Glossary definition has invalid or missing information

Response Body
media type	data type	description
application/json	AtlasGlossary (JSON)	Glossary
application/json	AtlasGlossary (JSON)	Glossary

Example

Request

PUT /v2/glossary/{glossaryGuid}
Content-Type: application/json
Accept: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

DELETE /v2/glossary/category/{categoryGuid}

Delete a glossary category

Request Parameters
name	type	description
categoryGuid	path	unique identifier for glossary category

Response Codes
code	condition
204	If glossary category delete was successful
404	If glossary category guid in invalid

Example

Request

DELETE /v2/glossary/category/{categoryGuid}
Content-Type: application/json

                
...

Response

HTTP/1.1 204 No Content

GET /v2/glossary/category/{categoryGuid}

Get specific glossary category

Request Parameters
name	type	description
categoryGuid	path	unique identifier for glossary category

Response Codes
code	condition
200	If glossary category exists for given GUID
404	If glossary category GUID is invalid

Response Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)	Glossary category
application/json	AtlasGlossaryCategory (JSON)	Glossary category

Example

Request

GET /v2/glossary/category/{categoryGuid}
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

PUT /v2/glossary/category/{categoryGuid}

Update the given glossary category

Request Parameters
name	type	description
categoryGuid	path	unique identifier for glossary category

Request Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)	updated glossary category
application/json	AtlasGlossaryCategory (JSON)	updated glossary category

Response Codes
code	condition
200	If glossary category partial update was successful
404	If glossary category guid in invalid
400	If Glossary category definition has invalid or missing information

Response Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)	glossary category
application/json	AtlasGlossaryCategory (JSON)	glossary category

Example

Request

PUT /v2/glossary/category/{categoryGuid}
Content-Type: application/json
Accept: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

GET /v2/glossary/import/template

Get sample template for uploading/creating bulk AtlasGlossaryTerm

Response Codes
code	condition
400	If the provided fileType is not supported

Response Body
media type	data type	description
application/octet-stream	object	Template File

Example

Request

GET /v2/glossary/import/template
Content-Type: application/json
Accept: application/octet-stream

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...

DELETE /v2/glossary/term/{termGuid}

Delete a glossary term

Request Parameters
name	type	description
termGuid	path	unique identifier for glossary term

Response Codes
code	condition
204	If glossary term delete was successful
404	If glossary term guid in invalid

Example

Request

DELETE /v2/glossary/term/{termGuid}
Content-Type: application/json

                
...

Response

HTTP/1.1 204 No Content

GET /v2/glossary/term/{termGuid}

Get specific glossary term

Request Parameters
name	type	description
termGuid	path	unique identifier for glossary term

Response Codes
code	condition
200	If glossary term exists for given GUID
404	If glossary term GUID is invalid

Response Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)	Glossary term
application/json	AtlasGlossaryTerm (JSON)	Glossary term

Example

Request

GET /v2/glossary/term/{termGuid}
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

PUT /v2/glossary/term/{termGuid}

Update the given glossary term

Request Parameters
name	type	description
termGuid	path	unique identifier for glossary term

Request Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)	updated glossary term
application/json	AtlasGlossaryTerm (JSON)	updated glossary term

Response Codes
code	condition
200	If glossary term update was successful
404	If glossary term guid in invalid
400	If Glossary temr definition has invalid or missing information

Response Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)	Updated glossary term
application/json	AtlasGlossaryTerm (JSON)	Updated glossary term

Example

Request

PUT /v2/glossary/term/{termGuid}
Content-Type: application/json
Accept: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DEPRECATED"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DRAFT"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

GET /v2/glossary/{glossaryGuid}/categories

Get the categories belonging to a specific glossary

Request Parameters
name	type	description	default
glossaryGuid	path	unique identifier for glossary term
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of glossary categories for the given glossary or an empty list
404	If glossary guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasGlossaryCategory (JSON)	List of associated categories
application/json	array of AtlasGlossaryCategory (JSON)	List of associated categories

Example

Request

GET /v2/glossary/{glossaryGuid}/categories
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

GET /v2/glossary/{glossaryGuid}/detailed

Get a specific Glossary

Request Parameters
name	type	description
glossaryGuid	path	unique glossary identifier

Response Codes
code	condition
200	If glossary exists for given GUID
404	If glossary GUID is invalid

Response Body
media type	data type	description
application/json	AtlasGlossaryExtInfo (JSON)	Glossary
application/json	AtlasGlossaryExtInfo (JSON)	Glossary

Example

Request

GET /v2/glossary/{glossaryGuid}/detailed
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categoryInfo" : {
    "property1" : {
      "anchor" : {
        "displayText" : "...",
        "glossaryGuid" : "...",
        "relationGuid" : "..."
      },
      "childrenCategories" : [ {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      }, {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      } ],
      "parentCategory" : {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      },
      "terms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "additionalAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "longDescription" : "...",
      "name" : "...",
      "qualifiedName" : "...",
      "shortDescription" : "...",
      "guid" : "..."
    },
    "property2" : {
      "anchor" : {
        "displayText" : "...",
        "glossaryGuid" : "...",
        "relationGuid" : "..."
      },
      "childrenCategories" : [ {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      }, {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      } ],
      "parentCategory" : {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "parentCategoryGuid" : "...",
        "relationGuid" : "..."
      },
      "terms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "additionalAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "longDescription" : "...",
      "name" : "...",
      "qualifiedName" : "...",
      "shortDescription" : "...",
      "guid" : "..."
    }
  },
  "termInfo" : {
    "property1" : {
      "abbreviation" : "...",
      "anchor" : {
        "displayText" : "...",
        "glossaryGuid" : "...",
        "relationGuid" : "..."
      },
      "antonyms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "ACTIVE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "assignedEntities" : [ {
        "displayText" : "...",
        "entityStatus" : "PURGED",
        "qualifiedName" : "...",
        "relationshipAttributes" : { },
        "relationshipGuid" : "...",
        "relationshipStatus" : "DELETED",
        "relationshipType" : "...",
        "guid" : "...",
        "typeName" : "...",
        "uniqueAttributes" : {
          "property1" : { },
          "property2" : { }
        }
      }, {
        "displayText" : "...",
        "entityStatus" : "ACTIVE",
        "qualifiedName" : "...",
        "relationshipAttributes" : { },
        "relationshipGuid" : "...",
        "relationshipStatus" : "ACTIVE",
        "relationshipType" : "...",
        "guid" : "...",
        "typeName" : "...",
        "uniqueAttributes" : {
          "property1" : { },
          "property2" : { }
        }
      } ],
      "categories" : [ {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "relationGuid" : "...",
        "status" : "DRAFT"
      }, {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "relationGuid" : "...",
        "status" : "DEPRECATED"
      } ],
      "classifies" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "examples" : [ "...", "..." ],
      "glossaryTermHeader" : {
        "qualifiedName" : "...",
        "termGuid" : "..."
      },
      "isA" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "preferredTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "preferredToTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "replacedBy" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "replacementTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "ACTIVE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "seeAlso" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "synonyms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "translatedTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "translationTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "ACTIVE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "usage" : "...",
      "validValues" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "validValuesFor" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "additionalAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "longDescription" : "...",
      "name" : "...",
      "qualifiedName" : "...",
      "shortDescription" : "...",
      "guid" : "..."
    },
    "property2" : {
      "abbreviation" : "...",
      "anchor" : {
        "displayText" : "...",
        "glossaryGuid" : "...",
        "relationGuid" : "..."
      },
      "antonyms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "assignedEntities" : [ {
        "displayText" : "...",
        "entityStatus" : "ACTIVE",
        "qualifiedName" : "...",
        "relationshipAttributes" : { },
        "relationshipGuid" : "...",
        "relationshipStatus" : "ACTIVE",
        "relationshipType" : "...",
        "guid" : "...",
        "typeName" : "...",
        "uniqueAttributes" : {
          "property1" : { },
          "property2" : { }
        }
      }, {
        "displayText" : "...",
        "entityStatus" : "ACTIVE",
        "qualifiedName" : "...",
        "relationshipAttributes" : { },
        "relationshipGuid" : "...",
        "relationshipStatus" : "ACTIVE",
        "relationshipType" : "...",
        "guid" : "...",
        "typeName" : "...",
        "uniqueAttributes" : {
          "property1" : { },
          "property2" : { }
        }
      } ],
      "categories" : [ {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "relationGuid" : "...",
        "status" : "OBSOLETE"
      }, {
        "categoryGuid" : "...",
        "description" : "...",
        "displayText" : "...",
        "relationGuid" : "...",
        "status" : "DRAFT"
      } ],
      "classifies" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "examples" : [ "...", "..." ],
      "glossaryTermHeader" : {
        "qualifiedName" : "...",
        "termGuid" : "..."
      },
      "isA" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "ACTIVE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "preferredTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "preferredToTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "replacedBy" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "replacementTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "seeAlso" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "synonyms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "translatedTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "ACTIVE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "translationTerms" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "usage" : "...",
      "validValues" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "validValuesFor" : [ {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OTHER",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DRAFT",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "additionalAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "longDescription" : "...",
      "name" : "...",
      "qualifiedName" : "...",
      "shortDescription" : "...",
      "guid" : "..."
    }
  },
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

PUT /v2/glossary/{glossaryGuid}/partial

Partially update the glossary

Request Parameters
name	type	description
glossaryGuid	path	unique identifier for glossary term

Request Body
media type	data type	description
application/json	map of string (JSON)	Map containing keys as attribute names and values as corresponding attribute values
application/json	map of string (JSON)

Response Codes
code	condition
200	If glossary partial update was successful
404	If glossary guid in invalid
400	If partial update parameters are invalid

Response Body
media type	data type	description
application/json	AtlasGlossary (JSON)	Updated glossary
application/json	AtlasGlossary (JSON)	Updated glossary

Example

Request

PUT /v2/glossary/{glossaryGuid}/partial
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

GET /v2/glossary/{glossaryGuid}/terms

Get terms belonging to a specific glossary

Request Parameters
name	type	description	default
glossaryGuid	path	unique identifier for glossary
limit	query	page size - by default there is no paging	-1
offset	query	starting offset for loading terms	0
sort	query	ASC(default) or DESC	ASC

Response Codes
code	condition
200	List of glossary terms for the given glossary or an empty list
404	If glossary guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasGlossaryTerm (JSON)	List of terms associated with the glossary
application/json	array of AtlasGlossaryTerm (JSON)	List of terms associated with the glossary

Example

Request

GET /v2/glossary/{glossaryGuid}/terms
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "DEPRECATED"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
} ]

PUT /v2/glossary/category/{categoryGuid}/partial

Partially update the glossary category

Request Parameters
name	type	description
categoryGuid	path	unique identifier for glossary term

Request Body
media type	data type	description
application/json	map of string (JSON)	Map containing keys as attribute names and values as corresponding attribute values
application/json	map of string (JSON)

Response Codes
code	condition
200	If glossary category partial update was successful
404	If glossary category guid in invalid
400	If category attributes are invalid

Response Body
media type	data type	description
application/json	AtlasGlossaryCategory (JSON)	Updated glossary category
application/json	AtlasGlossaryCategory (JSON)	Updated glossary category

Example

Request

PUT /v2/glossary/category/{categoryGuid}/partial
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

GET /v2/glossary/category/{categoryGuid}/related

Get all related categories (parent and children)

Request Parameters
name	type	description	default
categoryGuid	path	unique identifier for glossary category
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Body
media type	data type	description
application/json	map of array of AtlasRelatedCategoryHeader (JSON)	List of related categories
application/json	map of array of AtlasRelatedCategoryHeader (JSON)	List of related categories

Example

Request

GET /v2/glossary/category/{categoryGuid}/related
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "..." : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }
} ]

GET /v2/glossary/category/{categoryGuid}/terms

Get all terms associated with the specific category

Request Parameters
name	type	description	default
categoryGuid	path	unique identifier for glossary category
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of terms for the given category or an empty list
404	If glossary category guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasRelatedTermHeader (JSON)	List of associated terms
application/json	array of AtlasRelatedTermHeader (JSON)	List of associated terms

Example

Request

GET /v2/glossary/category/{categoryGuid}/terms
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "description" : "...",
  "displayText" : "...",
  "expression" : "...",
  "qualifiedName" : "...",
  "relationGuid" : "...",
  "source" : "...",
  "status" : "OBSOLETE",
  "steward" : "...",
  "termGuid" : "..."
} ]

PUT /v2/glossary/term/{termGuid}/partial

Partially update the glossary term

Request Parameters
name	type	description
termGuid	path	unique identifier for glossary term

Request Body
media type	data type	description
application/json	map of string (JSON)	Map containing keys as attribute names and values as corresponding attribute values
application/json	map of string (JSON)

Response Codes
code	condition
200	If glossary partial update was successful
404	If glossary term guid in invalid
400	If partial attributes are invalid

Response Body
media type	data type	description
application/json	AtlasGlossaryTerm (JSON)	Updated glossary term
application/json	AtlasGlossaryTerm (JSON)	Updated glossary term

Example

Request

PUT /v2/glossary/term/{termGuid}/partial
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "PURGED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "ACTIVE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}

DELETE /v2/glossary/terms/{termGuid}/assignedEntities

Remove the term assignment for the given list of entity headers

Request Parameters
name	type	description
termGuid	path	Glossary term GUID

Request Body
media type	data type	description
application/json	array of AtlasRelatedObjectId (JSON)	List of related entity IDs from which the term has to be dissociated
application/json	array of AtlasRelatedObjectId (JSON)

Response Codes
code	condition
204	If glossary term dissociation was successful
400	If ANY of the entity header is invalid
404	If glossary term guid in invalid

Example

Request

DELETE /v2/glossary/terms/{termGuid}/assignedEntities
Content-Type: application/json

                
[ {
  "displayText" : "...",
  "entityStatus" : "ACTIVE",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
} ]

Response

HTTP/1.1 204 No Content

GET /v2/glossary/terms/{termGuid}/assignedEntities

Get all entity headers assigned with the specified term

Request Parameters
name	type	description	default
termGuid	path	GUID of the term
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of entity headers (if any) for the given glossary or an empty list
404	If glossary term guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasRelatedObjectId (JSON)
application/json	array of AtlasRelatedObjectId (JSON)

Example

Request

GET /v2/glossary/terms/{termGuid}/assignedEntities
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "displayText" : "...",
  "entityStatus" : "ACTIVE",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "ACTIVE",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
} ]

POST /v2/glossary/terms/{termGuid}/assignedEntities

Assign the given term to the provided list of entity headers

Request Parameters
name	type	description
termGuid	path	Glossary term GUID

Request Body
media type	data type	description
application/json	array of AtlasRelatedObjectId (JSON)	Related Entity IDs to which the term has to be associated
application/json	array of AtlasRelatedObjectId (JSON)	Related Entity IDs to which the term has to be associated

Response Codes
code	condition
204	If the term assignment was successful
400	If ANY of the entity header is invalid
404	If glossary guid in invalid

Example

Request

POST /v2/glossary/terms/{termGuid}/assignedEntities
Content-Type: application/json

                
[ {
  "displayText" : "...",
  "entityStatus" : "ACTIVE",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
} ]

Response

HTTP/1.1 204 No Content

PUT /v2/glossary/terms/{termGuid}/assignedEntities

Remove the term assignment for the given list of entity headers

Request Parameters
name	type	description
termGuid	path	Glossary term GUID

Request Body
media type	data type	description
application/json	array of AtlasRelatedObjectId (JSON)	List of related entity IDs from which the term has to be dissociated
application/json	array of AtlasRelatedObjectId (JSON)

Response Codes
code	condition
204	If glossary term dissociation was successful
400	If ANY of the entity header is invalid
404	If glossary term guid in invalid

Example

Request

PUT /v2/glossary/terms/{termGuid}/assignedEntities
Content-Type: application/json

                
[ {
  "displayText" : "...",
  "entityStatus" : "ACTIVE",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
} ]

Response

HTTP/1.1 204 No Content

GET /v2/glossary/terms/{termGuid}/related

Get all related terms for a specific term

Request Parameters
name	type	description	default
termGuid	path	unique identifier for glossary term
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of related glossary terms for the given glossary or an empty list
404	If glossary term guid in invalid

Response Body
media type	data type	description
application/json	map of array of AtlasRelatedTermHeader (JSON)	List of all related terms
application/json	map of array of AtlasRelatedTermHeader (JSON)	List of all related terms

Example

Request

GET /v2/glossary/terms/{termGuid}/related
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "..." : {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }
} ]

GET /v2/glossary/{glossaryGuid}/categories/headers

Get the categories belonging to a specific glossary

Request Parameters
name	type	description	default
glossaryGuid	path	unique identifier for glossary term
limit	query	page size - by default there is no paging	-1
offset	query	offset for pagination purpose	0
sort	query	ASC (default) or DESC	ASC

Response Codes
code	condition
200	List of glossary categories for the given glossary or an empty list
404	If glossary guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasRelatedCategoryHeader (JSON)	List of associated categories
application/json	array of AtlasRelatedCategoryHeader (JSON)	List of associated categories

Example

Request

GET /v2/glossary/{glossaryGuid}/categories/headers
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "categoryGuid" : "...",
  "description" : "...",
  "displayText" : "...",
  "parentCategoryGuid" : "...",
  "relationGuid" : "..."
} ]

GET /v2/glossary/{glossaryGuid}/terms/headers

Get term headers belonging to a specific glossary

Request Parameters
name	type	description	default
glossaryGuid	path	unique identifier for glossary
limit	query	page size - by default there is no paging	-1
offset	query	starting offset for loading terms	0
sort	query	ASC(default) or DESC	ASC

Response Codes
code	condition
200	List of glossary terms for the given glossary or an empty list
404	If glossary guid in invalid

Response Body
media type	data type	description
application/json	array of AtlasRelatedTermHeader (JSON)	List of terms associated with the glossary
application/json	array of AtlasRelatedTermHeader (JSON)	List of terms associated with the glossary

Example

Request

GET /v2/glossary/{glossaryGuid}/terms/headers
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "description" : "...",
  "displayText" : "...",
  "expression" : "...",
  "qualifiedName" : "...",
  "relationGuid" : "...",
  "source" : "...",
  "status" : "DRAFT",
  "steward" : "...",
  "termGuid" : "..."
} ]

GlossaryREST Resource

GET /v2/glossary

Example

Request

Response

POST /v2/glossary

Example

Request

Response

POST /v2/glossary/categories

Example

Request

Response

POST /v2/glossary/category

Example

Request

Response

POST /v2/glossary/import

Example

Request

Response

POST /v2/glossary/term

Example

Request

Response

POST /v2/glossary/terms

Example

Request

Response

DELETE /v2/glossary/{glossaryGuid}

Example

Request

Response

GET /v2/glossary/{glossaryGuid}

Example

Request

Response

PUT /v2/glossary/{glossaryGuid}

Example

Request

Response

DELETE /v2/glossary/category/{categoryGuid}

Example

Request

Response

GET /v2/glossary/category/{categoryGuid}

Example

Request

Response

PUT /v2/glossary/category/{categoryGuid}

Example

Request

Response

GET /v2/glossary/import/template

Example

Request

Response

DELETE /v2/glossary/term/{termGuid}

Example

Request

Response

GET /v2/glossary/term/{termGuid}

Example

Request

Response

PUT /v2/glossary/term/{termGuid}

Example

Request

Response

GET /v2/glossary/{glossaryGuid}/categories

Example

Request

Response

GET /v2/glossary/{glossaryGuid}/detailed

Example

Request

Response

PUT /v2/glossary/{glossaryGuid}/partial

Example

Request