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

json.data.team.teamCsvDocumentation.json Maven / Gradle / Ivy

There is a newer version: 1.5.11
Show newest version
{
  "summary": "Documentation for CSV file used for importing and exporting teams. Note that the order of team creation must ensure, any team referenced in a row (as parent team) must already exist or created in earlier rows in the CSV file.",
  "headers": [
    {
      "name": "name",
      "required": true,
      "description": "The name of the team being created.",
      "examples": [
        "`Marketing Team`",
        "`Data Team`"
      ]
    },
    {
      "name": "displayName",
      "required": false,
      "description": "Display name for the team.",
      "examples": [
        "`Marketing Team`",
        "`Data Team`"
      ]
    },
    {
      "name": "description",
      "required": false,
      "description": "Description for the team in Markdown format.",
      "examples": [
        "`Data Team` is responsible for creating curated data assets."
      ]
    },
    {
      "name": "teamType",
      "required": true,
      "description": "Type of the team.",
      "examples": [
        "One of `Group`, `Department`, `Division`, `BusinessUnit`",
        "When set to empty `\"\"`, the default value is `Group`"
      ]
    },
    {
      "name": "parents",
      "required": true,
      "description": "The parent teams to which this team being created belongs to.",
      "examples": [
        "`Engineering Team` could be parent of `Data Team`"
      ]
    },
    {
      "name": "Owner",
      "required": false,
      "description": "Name of the user that is owner/administrator/manager of this team.",
      "examples": [
        "`jonn`, `adam.smith`, or `\"\"`"
      ]
    },
    {
      "name": "isJoinable",
      "required": false,
      "description": "When true, team is open for any user to join. Default value is `true`.",
      "examples": [
        "`true`, or `false`",
        "When set to empty `\"\"`, the default value is `false`."
      ]
    },
    {
      "name": "defaultRoles",
      "required": false,
      "description": "Roles that are inherited by all the member users of the team. Multiple roles are separated by ';'.",
      "examples": [
        "`Data consumer`",
        "`Data consumer;Data steward`",
        "`\"\" for no default role`"
      ]
    },
    {
      "name": "policies",
      "required": false,
      "description": "List of policies at the team level that applies to all it's members.",
      "examples": [
        "`No owner policy`",
        "`Org policy;No owner policy`",
        "`\"\" for no policies`"
      ]
    }
  ]
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy