All Downloads are FREE. Search and download functionalities are using the official Maven repository.

json.data.glossary.glossaryCsvDocumentation.json Maven / Gradle / Ivy

There is a newer version: 1.5.11
Show newest version
{
  "summary": "Glossary CSV file is used for importing and exporting glossary terms from and to an **existing** glossary.",
  "headers": [
    {
      "name": "parent",
      "required": false,
      "description": "Fully qualified name of the parent glossary term. If the glossary term being created is at the root of the glossary without any parent term, leave this as empty.",
      "examples": [
        "`\"\"` or empty, if the term is at the root of the glossary.",
        "`Business terms.Customer` as parent to create a term `CustomerId` under it."
      ]
    },
    {
      "name": "name",
      "required": true,
      "description": "The name of the glossary term being created.",
      "examples": [
        "`CustomerId`, `Customer name`"
      ]
    },
    {
      "name": "displayName",
      "required": false,
      "description": "Display name for the term.",
      "examples": [
        "`Customer Identifier`, `Customer name`"
      ]
    },
    {
      "name": "description",
      "required": false,
      "description": "Description for the glossary term in Markdown format.",
      "examples": [
        "`Customer Identifier` as defined by the **Legal Team**."
      ]
    },
    {
      "name": "synonyms",
      "required": false,
      "description": "Synonyms for the glossary term",
      "examples": [
        "`Customer Identifier`, `cid`, `customer_id`"
      ]
    },
    {
      "name": "relatedTerms",
      "required": false,
      "description": "List of related glossary term **fully qualified names** separated by `;`.",
      "examples": [
        "`Business terms.Client Identifier`, `Support.Subscriber Id`"
      ]
    },
    {
      "name": "references",
      "required": false,
      "description": "External glossary references for the glossary term in the format `name;URL endPoint`.",
      "examples": [
        "`customer;http://domain.com/glossaries/customer`",
        "`term1;http://domain.com/glossaries/term1;term2;http://domain.com/glossaries/term2`"
      ]
    },
    {
      "name": "tags",
      "required": false,
      "description": "Fully qualified classification tag names associated with the glossary term separated by ';'.. These tags are automatically applied along with the glossary term, when it is used to label an entity.",
      "examples": [
        "`PII.Sensitive`",
        "`PII.Sensitive;PersonalData.Personal`"
      ]
    },
    {
      "name": "reviewers",
      "required": false,
      "description": "User names separated by ';'.",
      "examples": [
        "`john;adam`"
      ]
    },
    {
      "name": "owner",
      "required": false,
      "description": "Owner names separated by ';'. For team owner, include prefix team. For user owner, include prefix user.",
      "examples": [
        "`team;marketing`",
        "`user;john`"
      ]
    },
    {
      "name": "status",
      "required": false,
      "description": "Status of the glossary term. Allowed values `Draft`, `Approved`, or `Deprecated`",
      "examples": [
        "`Draft`",
        "`Approved`",
        "`Deprecated`"
      ]
    }
  ]
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy