All URIs are relative to https://DOMAIN.api.engagement.dimelo.com/1.0
| Method | HTTP request | Description |
|---|---|---|
| CreateTeam | Post /teams | Creating a team |
| DeleteTeam | Delete /teams/{teamId} | Deleting a team |
| GetAllTeams | Get /teams | Getting all teams |
| GetTeam | Get /teams/{teamId} | Getting a team from its id |
| UpdateTeam | Put /teams/{teamId} | Updating a team |
Team CreateTeam(ctx, optional) Creating a team
This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *CreateTeamOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CreateTeamOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| name | optional.String | Team name. | |
| leaderIds | optional.Interface of []string | List of user id as leaders | |
| userIds | optional.Interface of []string | List of user id as team members. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Team DeleteTeam(ctx, teamId, optional) Deleting a team
This method destroys an existing team. It renders the team itself. It renders a 404 if id is invalid.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| teamId | string | ||
| optional | *DeleteTeamOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DeleteTeamOpts struct
| Name | Type | Description | Notes |
|---|
takeOverCategoryId | optional.String| ID of a category to recategorize (optional). |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAllTeamsResponse GetAllTeams(ctx, optional) Getting all teams
This method renders teams ordered by creation date (ascending).
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAllTeamsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAllTeamsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| offset | optional.Int32 | The record index to start. Default value is 0. | |
| limit | optional.Int32 | The max number of records to return. Default value is 30, max value is 150. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Team GetTeam(ctx, teamId) Getting a team from its id
This method renders a team from given id.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| teamId | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Team UpdateTeam(ctx, teamId, optional) Updating a team
This method updates an existing team from given attributes and renders it in case of success.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| teamId | string | ||
| optional | *UpdateTeamOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UpdateTeamOpts struct
| Name | Type | Description | Notes |
|---|
name | optional.String| Team name. | leaderIds | optional.Interface of []string| List of user id as leaders | userIds | optional.Interface of []string| List of user id as team members. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]