Bulk index teams - Glean Developer Portal

Indexing API

Client API

Activity
Announcements
Answers
Authentication
Calendar
Chat
Agents
Collections
Displayable Lists
Documents
Images
Insights
Messages
Pins
Search
Entities
Shortcuts
Summarize
Tools
User
Verification

Actions API

Authentication
Setup

curl --request POST \
  --url https://{domain}-be.glean.com/api/index/v1/bulkindexteams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
  "uploadId": "<string>",
  "isFirstPage": true,
  "isLastPage": true,
  "forceRestartUpload": true,
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "businessUnit": "<string>",
      "department": "<string>",
      "photoUrl": "<string>",
      "externalLink": "<string>",
      "emails": [
        {
          "email": "jsmith@example.com",
          "type": "OTHER"
        }
      ],
      "datasourceProfiles": [
        {
          "datasource": "github",
          "handle": "<string>",
          "url": "<string>",
          "nativeAppUrl": "<string>",
          "isUserGenerated": true
        }
      ],
      "members": [
        {
          "email": "jsmith@example.com",
          "relationship": "MEMBER",
          "join_date": "2023-12-25"
        }
      ],
      "additionalFields": [
        {
          "key": "<string>",
          "value": [
            {}
          ]
        }
      ]
    }
  ]
}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json; charset=UTF-8

Describes the request body of the /bulkindexteams API call

uploadId

string

required

Unique id that must be used for this bulk upload instance

teams

object[]

required

Batch of team information

Information about an employee's team

teams.id

string

required

The unique ID of the team

teams.name

string

required

Human-readable team name

teams.members

object[]

required

The members of the team

Information about a team's member

teams.description

string

The description of this team

teams.businessUnit

string

Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.

teams.department

string

An organizational unit where everyone has a similar task, e.g. Engineering.

teams.photoUrl

string

A link to the team's photo

teams.externalLink

string

A link to an external team page. If set, team results will link to it.

teams.emails

object[]

The emails of the team

Information about a team's email

teams.datasourceProfiles

object[]

The datasource profiles of the team, e.g. Slack,Github.

teams.additionalFields

object[]

List of additional fields with more information about the team.

Additional information about the employee or team.

teams.additionalFields.key

string

Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores.

teams.additionalFields.value

object[]

List of type string or HypertextField.

HypertextField is defined as

{
  anchor: string,    // Anchor text for the hypertext field.
  hyperlink: string, // URL for the hypertext field.
}

Example: {"anchor":"Glean","hyperlink":"https://glean.com"}

When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs.

Note: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored. Example: "languages": [{"lang":"English","lang":"Spanish",...}]. In this case, the key "lang" will be ignored and can even be passed in as an empty string.

Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.

isFirstPage

boolean

true if this is the first page of the upload. Defaults to false

isLastPage

boolean

true if this is the last page of the upload. Defaults to false

forceRestartUpload

boolean

Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true

Response

200

Was this page helpful?

Suggest edits Raise issue

Bulk index external shortcutsReplaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the `/uploadshortcuts` endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to [this](https://help.glean.com/en/articles/5628838-how-go-links-work) page.

curl --request POST \
  --url https://{domain}-be.glean.com/api/index/v1/bulkindexteams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
  "uploadId": "<string>",
  "isFirstPage": true,
  "isLastPage": true,
  "forceRestartUpload": true,
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "businessUnit": "<string>",
      "department": "<string>",
      "photoUrl": "<string>",
      "externalLink": "<string>",
      "emails": [
        {
          "email": "jsmith@example.com",
          "type": "OTHER"
        }
      ],
      "datasourceProfiles": [
        {
          "datasource": "github",
          "handle": "<string>",
          "url": "<string>",
          "nativeAppUrl": "<string>",
          "isUserGenerated": true
        }
      ],
      "members": [
        {
          "email": "jsmith@example.com",
          "relationship": "MEMBER",
          "join_date": "2023-12-25"
        }
      ],
      "additionalFields": [
        {
          "key": "<string>",
          "value": [
            {}
          ]
        }
      ]
    }
  ]
}'