Skip to content

Commit

Permalink
Add "teams" endpoint to api definition (#3727)
Browse files Browse the repository at this point in the history 
- add support:for allocations and actuals on teams
- removed "(Beta)" from taskmanagement endpoints
  • Loading branch information
@itd-sk
itd-sk authored Dec 5, 2024
1 parent 6540509 commit 73bd0dd
Show file tree
Hide file tree
Showing 2 changed files with 188 additions and 18 deletions.
204 changes: 187 additions & 17 deletions certified-connectors/Meisterplan/apiDefinition.swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,7 @@
"/v1/scenarios/{scenarioId}/projects/{projectId}/taskManagementLink": {
"get": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Get Task Management Link",
"description": "Returns a task management link of a project",
Expand Down Expand Up @@ -1476,7 +1476,7 @@
},
"delete": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Delete Task Management Link",
"description": "Deletes a task management link of a project",
Expand Down Expand Up @@ -1529,10 +1529,10 @@
},
"post": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Create or Update Task Management Link",
"description": "This endpoint lets you add a task management link to a project or update it's externalViewUrl. When this link is set, tasks can be added, updated and deleted using /tasks endpoint.Please note that task management data itself is independent from its scenario.",
"description": "This endpoint lets you add a task management link to a project or update the externalViewUrl",
"operationId": "CreateOrUpdateTaskManagementLink",
"consumes": [
"application/json"
Expand Down Expand Up @@ -1603,7 +1603,7 @@
"/v1/scenarios/{scenarioId}/projects/{projectId}/taskManagementLink/tasks": {
"get": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Get a List of Tasks",
"description": "This endpoint is paginated. It returns a list of tasks up to the specified PAGESIZE",
Expand Down Expand Up @@ -1686,10 +1686,10 @@
},
"post": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Create or Update Task",
"description": "Creates or update a task with the given fields",
"description": "Creates or updates a task with the given fields.",
"operationId": "CreateOrUpdateTask",
"consumes": [
"application/json"
Expand Down Expand Up @@ -1811,7 +1811,7 @@
"description": "Stringified JSON object with a subset of properties of the expected object.",
"type": "string",
"x-ms-summary": "Filter",
"x-example": "{ \"id\": \"UUID\", \"type\": \"RESOURCE\" }"
"x-example": "{ \"id\": \"UUID\" }"
}
],
"responses": {
Expand Down Expand Up @@ -5476,6 +5476,119 @@
}
}
},
"/v1/teams": {
"get": {
"tags": [
"Teams"
],
"summary": "Get a List of Teams",
"description": "This endpoint is paginated. It returns a list of teams up to the specified PAGESIZE",
"operationId": "GetAllTeams",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "pageSize",
"description": "Page Size",
"type": "integer",
"default": 100,
"maximum": 500,
"minimum": 1,
"x-ms-summary": "Page Size",
"x-example": "100"
},
{
"in": "query",
"name": "pageAfter",
"description": "The cursor after which to retrieve results. The cursor can be taken from a preceding request.",
"type": "string",
"x-ms-summary": "Page After",
"x-example": "opaque cursor"
},
{
"in": "query",
"name": "filter",
"description": "Stringified JSON object with a subset of properties of the expected object. Selects all objects that exactly match the specified properties. Note: take care to URL encode your parameter. { \"resourceKey\": string, \"name\": string }",
"type": "string",
"x-ms-summary": "Filter",
"x-example": "{ \"name\": \"Team Integration\" }"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PaginatedResponseTeamResponse"
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too Many Requests"
}
}
}
},
"/v1/teams/{teamId}": {
"get": {
"tags": [
"Teams"
],
"summary": "Get Team by ID",
"description": "Returns the individual team specified by the given ID.",
"operationId": "GetTeamById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "teamId",
"description": "Internal Meisterplan identifier",
"required": true,
"type": "string",
"x-ms-summary": "Team Id",
"x-ms-url-encoding": "single",
"x-example": "UUID"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TeamResponse"
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too Many Requests"
}
}
}
},
"/v1/scenarios": {
"get": {
"tags": [
Expand Down Expand Up @@ -5611,7 +5724,7 @@
"/v1/scenarios/{scenarioId}/projects/{projectId}/taskManagementLink/tasks/{taskId}": {
"get": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Get Task by ID",
"description": "Returns the individual task specified by the given ID.",
Expand Down Expand Up @@ -5677,7 +5790,7 @@
},
"delete": {
"tags": [
"Task Management (Beta)"
"Task Management"
],
"summary": "Delete Task",
"description": "Deletes a task in a given project.",
Expand Down Expand Up @@ -6649,6 +6762,7 @@
"enum": [
"ROLE",
"RESOURCE",
"TEAM",
"RESOLVE_BY_KEY_OR_NAME"
],
"type": "string",
Expand Down Expand Up @@ -7600,12 +7714,13 @@
"type": "object",
"properties": {
"toolKey": {
"description": "Unique key representing the external tool you connect with Meisterplan. Maximum length is 100 characters. Connected tools can be found on the Integrations page > Task Connector in your Meisterplan system.",
"type": "string",
"example": "ASANA",
"x-ms-summary": "Tool Key"
},
"externalViewUrl": {
"description": "Link to the project within the task management tool",
"description": "Should represent the link to the project in your external tool. Can be opened from the Information Panel of the linked project inside Meisterplan.",
"type": "string",
"example": "https://www.asana.com/PROJECT-1234",
"x-ms-summary": "External View URL"
Expand Down Expand Up @@ -7719,7 +7834,7 @@
"x-ms-summary": "Key"
},
"name": {
"description": "The name of the task. If the task needs to be created, this must be set.",
"description": "The name of the task, displayed in the info panel. If the task needs to be created, this must be set.",
"type": "string",
"example": "Implement new feature",
"x-ms-summary": "Name"
Expand Down Expand Up @@ -7996,6 +8111,7 @@
"enum": [
"ROLE",
"RESOURCE",
"TEAM",
"RESOLVE_BY_KEY_OR_NAME"
],
"type": "string",
Expand Down Expand Up @@ -8104,7 +8220,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the entity to which this actual time worked entry is linked. Set type to RESOLVE_BY_KEY_OR_NAME to resolve resource keys or role names automatically instead.",
"description": "The id of the entity to which this actual time worked entry is linked. Set type to RESOLVE_BY_KEY_OR_NAME to resolve resource and team keys or role names automatically instead.",
"type": "string",
"example": "UUID",
"x-ms-summary": "ID"
Expand All @@ -8118,6 +8234,12 @@
"type": "string",
"example": "RESOURCE",
"x-ms-summary": "Type"
},
"teamId": {
"description": "The team id of the entity to which this actual time worked entry is linked",
"type": "string",
"example": "UUID",
"x-ms-summary": " Team ID"
}
}
},
Expand Down Expand Up @@ -8242,6 +8364,12 @@
"type": "string",
"example": "RESOURCE",
"x-ms-summary": "Type"
},
"teamId": {
"description": "The team id of the entity to which this actual time worked entry is linked",
"type": "string",
"example": "UUID",
"x-ms-summary": " Team ID"
}
},
"x-ms-summary": "Actuals Entity Link"
Expand Down Expand Up @@ -9959,6 +10087,43 @@
},
"x-ms-summary": "User"
},
"PaginatedResponseTeamResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamResponse"
},
"x-ms-summary": "Items"
},
"_pagination": {
"$ref": "#/definitions/Pagination"
}
},
"x-ms-summary": "Paginated"
},
"TeamResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "UUID",
"x-ms-summary": "ID"
},
"resourceKey": {
"type": "string",
"example": "KMY",
"x-ms-summary": "Resource Key"
},
"name": {
"type": "string",
"example": "Team Integration",
"x-ms-summary": "Name"
}
},
"x-ms-summary": "Items"
},
"ListResponseScenarioResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -10432,6 +10597,7 @@
"enum": [
"ROLE",
"RESOURCE",
"TEAM",
"RESOLVE_BY_KEY_OR_NAME"
],
"type": "string",
Expand Down Expand Up @@ -10851,6 +11017,10 @@
"parameters": {},
"responses": {},
"tags": [
{
"name": "Teams",
"description": "Operations on Teams"
},
{
"name": "Business Goals",
"description": "Operations on Business Goals"
Expand All @@ -10867,10 +11037,6 @@
"name": "Users (Premium)",
"description": "Operations on users. A Premium Edition is required to use these operations. The administrative right to manage users and user groups is required. If you would like to implement automatic user provisioning, please refer to the SCIM 2.0 endpoints."
},
{
"name": "Task Management (Beta)",
"description": "Operations on Task Management Links and Tasks. Note that this endpoint is currently in beta and its functionality may change before its final release."
},
{
"name": "Financial Actuals",
"description": "Operations on Financial Actuals"
Expand Down Expand Up @@ -10931,6 +11097,10 @@
"name": "SCIM 2.0 (Premium)",
"description": "Operations on users and user groups. A Premium Edition is required to use these operations. The administrative right to manage users and user groups is required. You can use these operations to implement automatic user provisioning."
},
{
"name": "Task Management",
"description": "Operations on Task Management"
},
{
"name": "Roles",
"description": "Operations on Roles"
Expand Down
2 changes: 1 addition & 1 deletion certified-connectors/Meisterplan/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ The connector supports reading and/or updating the following Meisterplan entitie
- Roles
- Scenarios (read only)
- Task Management
- Teams (read only)
- Users (read only)


The connector supports triggers for project created, project updated and project deleted events.

You can find the complete REST API documentation [here](https://api.us.meisterplan.com/).
Expand Down

0 comments on commit 73bd0dd

Please sign in to comment.