Uploading Team Data (beta)

Teams are groups of contributors that can collaborate and are managed collectively. These APIs allow you to set up and manage your teams on your domain.

Importing Teams Data

Important: Ensure your API token has the manage:team scope when calling Teams APIs.

To ensure the accuracy of data in Logilica, Teams data should adhere to the following:

• Teams should have unique names.

• New members will automatically be added as contributors into your Logilica instance.

• The administrator of the team is assigned to the owner of the API token.

• For parent teams, include the subTeams field and use the GET Teams API to obtain the team's ID.

Upload Example Using cURL

In the following, we provide an example of how to push your Teams data into Logilica for storage and built-in analytics.

Important: Ensure the repository you build from is already onboarded in Logilica.

The cURL POST command is below. Note, that the POST command uses example data, including the API token lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb and the example workspace myworkspace.

curl --location --request POST 'https://logilica.io/api/import/v1/teams/create' \
--header 'X-lgca-token: lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb' \
--header 'x-lgca-domain: myworkspace' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Development Team",
    "members": [{
        "name": "John Doe",
        "email": "[email protected]"
    },
    {
        "name": "Jane Doe,
        "email": "[email protected]"
    }],
    "subTeams": ["1234567"]
}'

API Schema for Importing Team

Create a Team

post

Create a team

Body

application/json

namestringRequired

Name of the team

subTeamsstring[]Optional

The sub teams within the team

Responses

200

Success

application/json

messagestringRequired

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Team not found

application/json

500

Failed to process request

application/json

post

teams/create

HTTPcURLJavaScriptPython

POST /api/import/v1teams/create HTTP/1.1
Host: logilica.io/
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}

{
  "message": "text"
}

Update a Team

post

Update a team

Path parameters

teamIDstringRequired

Body

application/json

namestringRequired

Name of the team

subTeamsstring[]Optional

The sub teams within the team

Responses

200

Success

application/json

messagestringRequired

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Team not found

application/json

500

Failed to process request

application/json

post

teams/update/{teamID}

HTTPcURLJavaScriptPython

POST /api/import/v1teams/update/{teamID} HTTP/1.1
Host: logilica.io/
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}

{
  "message": "text"
}

Delete a Team

post

Delete a team

Path parameters

teamIDstringRequired

Responses

200

Success

application/json

messagestringRequired

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Team not found

application/json

500

Failed to process request

application/json

post

teams/delete/{teamID}

HTTPcURLJavaScriptPython

POST /api/import/v1teams/delete/{teamID} HTTP/1.1
Host: logilica.io/
Accept: */*

{
  "message": "text"
}

List Teams

get

List the teams in a domain

Responses

200

Success in retrieving teams

application/json

namestringRequired

Name of the team

subTeamsstring[]Optional

The sub teams within the team

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Team not found

application/json

get

teams/

HTTPcURLJavaScriptPython

GET /api/import/v1teams/ HTTP/1.1
Host: logilica.io/
Accept: */*

{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}