Skip to content

Update Meisterplan Connector Task Replace Endpoint Dynamic Schema #4054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update Meisterplan Connector Task Replace Endpoint Dynamic Schema #4054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 99 additions & 58 deletions certified-connectors/Meisterplan/apiDefinition.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"Task Management"
],
"summary": "Get a List of Tasks",
"description": "This endpoint is paginated. It returns a list of tasks up to the specified pageSize",
"description": "This endpoint is paginated. It returns a list of tasks up to the specified PAGESIZE",
"operationId": "GetAllTasks",
"produces": [
"application/json"
Expand Down Expand Up @@ -185,7 +185,7 @@
"Task Management"
],
"summary": "Replace Tasks",
"description": "This endpoint is used to replace all existing tasks of a specific project with a new list of tasks provided in the request. How it works: You send a list of tasks for a specific project. The system will synchronize the project’s tasks with this list using the task key as identifier. This means:\n\n- Tasks currently in the system but not in your list will be deleted. - Tasks in your list that do not exist in the system will be created. - Tasks that exist both in the system and in your list will be updated, if there are changes.",
"description": "This endpoint is used to replace all existing tasks of a specific project with a new list of tasks provided in the request. How it works: You send a list of tasks for a specific project. The system will synchronize the project’s tasks with this list using the task key as identifier. This means:\n\n- Tasks currently in the system but not in your list will be deleted. - Tasks in your list that do not exist in the system will be created. - Tasks that exist both in the system and in your list will be updated, if there are changes.",
"operationId": "ReplaceTask",
"consumes": [
"application/json"
Expand Down Expand Up @@ -1264,7 +1264,7 @@
"Webhooks"
],
"summary": "Get a List of Webhooks",
"description": "This endpoint is paginated. It returns a list of webhooks up to the specified pageSize",
"description": "This endpoint is paginated. It returns a list of webhooks up to the specified PAGESIZE",
"operationId": "GetAllWebhooks",
"produces": [
"application/json"
Expand Down Expand Up @@ -1389,7 +1389,7 @@
"Teams"
],
"summary": "Get a List of Teams",
"description": "This endpoint is paginated. It returns a list of teams up to the specified pageSize",
"description": "This endpoint is paginated. It returns a list of teams up to the specified PAGESIZE",
"operationId": "GetAllTeams",
"produces": [
"application/json"
Expand Down Expand Up @@ -1637,7 +1637,7 @@
"Projects"
],
"summary": "Get a List of Projects",
"description": "This endpoint is paginated. It returns a list of projects up to the specified pageSize",
"description": "This endpoint is paginated. It returns a list of projects up to the specified PAGESIZE",
"operationId": "GetAllProjects",
"produces": [
"application/json"
Expand Down Expand Up @@ -2196,6 +2196,14 @@
"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. Programs are searchable by programKey and name. Note: take care to URL encode your parameter. { \"programKey\": string, \"name\": string }",
"type": "string",
"x-ms-summary": "Filter",
"x-example": "{\"programKey\": \"MPPRG-1\"}"
},
{
"in": "path",
"name": "scenarioId",
Expand Down Expand Up @@ -2591,7 +2599,7 @@
"Resources"
],
"summary": "Get a List of Resources",
"description": "This endpoint is paginated. It returns a list of resources up to the specified pageSize",
"description": "This endpoint is paginated. It returns a list of resources up to the specified PAGESIZE",
"operationId": "GetAllResources",
"produces": [
"application/json"
Expand Down Expand Up @@ -2773,7 +2781,7 @@
"Resources"
],
"summary": "Update Deviations from the Calendar",
"description": "Use this request to replace all calendar deviations of a resource for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar deviations with the deviations property. Note that all deviations in the specified period will be overwritten by the deviations listed in the deviations property.\n\n- If null is used for the start period and end period, all calendar deviations of the resource are overwritten - If only the start date of the period is defined, all deviations starting from this time will be overwritten - If only the end date of the period is defined, all deviations up to that point will be overwritten - If null is used for the start and/or end date of a calendar deviation, the deviation is assumed to last from or until the root start or finish date specified above.\n\nAll deviations are flattened into a sequential structure. Cases of overlapping deviations will be resolved by giving precedence to deviations occurring later in the array.",
"description": "Use this request to replace all calendar deviations of a resource for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar deviations with the deviations property. Note that all deviations in the specified period will be overwritten by the deviations listed in the deviations property.\n\n- If null is used for the start period and end period, all calendar deviations of the resource are overwritten - If only the start date of the period is defined, all deviations starting from this time will be overwritten - If only the end date of the period is defined, all deviations up to that point will be overwritten - If null is used for the start and/or end date of a calendar deviation, the deviation is assumed to last from or until the root start or finish date specified above.\n\nAll deviations are flattened into a sequential structure. Cases of overlapping deviations will be resolved by giving precedence to deviations occurring later in the array.",
"operationId": "UpdateCalendarDeviations",
"consumes": [
"application/json"
Expand Down Expand Up @@ -2837,7 +2845,7 @@
"OBS"
],
"summary": "Get all OBS Types",
"description": "This endpoint is for OBS types only. To get OBS units, use\n\n/obsTypes/<obs-type-id>/obsUnits",
"description": "This endpoint is for OBS types only. To get OBS units, use /obsTypes/<obs-type-id>/obsUnits",
"operationId": "GetAllObsTypes",
"produces": [
"application/json"
Expand Down Expand Up @@ -3185,7 +3193,7 @@
"Calendars"
],
"summary": "Update Calendar Exceptions",
"description": "Use this request to replace all calendar exceptions for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar exceptions with the exceptions property. Note that all exceptions in the specified period will be overwritten by the exceptions listed in the exceptions property.\n\n- If null is used for the start period and end period, all exceptions of the calendar are overwritten - If only the start date of the period is defined, all exceptions starting from this time will be overwritten - If only the end date of the period is defined, all exceptions up to that point will be overwritten - If an exception is removed and a parent calendar has an exception at that date, this calendar inherits the exception from the parent calendar.",
"description": "Use this request to replace all calendar exceptions for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar exceptions with the exceptions property. Note that all exceptions in the specified period will be overwritten by the exceptions listed in the exceptions property.\n\n- If null is used for the start period and end period, all exceptions of the calendar are overwritten - If only the start date of the period is defined, all exceptions starting from this time will be overwritten - If only the end date of the period is defined, all exceptions up to that point will be overwritten - If an exception is removed and a parent calendar has an exception at that date, this calendar inherits the exception from the parent calendar.",
"operationId": "CreateCalendarExceptions",
"consumes": [
"application/json"
Expand Down Expand Up @@ -5338,7 +5346,7 @@
"OBS"
],
"summary": "Get an OBS Type by ID",
"description": "This endpoint is for OBS types only. To get OBS units, use\n\n/obsTypes/<obs-type-id>/obsUnits",
"description": "This endpoint is for OBS types only. To get OBS units, use /obsTypes/<obs-type-id>/obsUnits",
"operationId": "GetObsTypeById",
"produces": [
"application/json"
Expand Down Expand Up @@ -6025,7 +6033,7 @@
"Scenarios"
],
"summary": "Get Scenarios by ID",
"description": "Returns the individual scenario specified by the given ID. Hint: You can use \"planOfRecord\" as the ID for the plan of record scenario.",
"description": "Returns the individual scenario specified by the given ID. HINT: You can use \"planOfRecord\" as the ID for the plan of record scenario.",
"operationId": "GetScenarioById",
"produces": [
"application/json"
Expand Down Expand Up @@ -7352,6 +7360,13 @@
},
"x-ms-summary": "Items"
}
},
"x-ms-dynamic-schema": {
"operationId": "GetTasksDynamicSchema",
"parameters": {
"mode": "REPLACE_INPUT"
},
"value-path": "schema"
}
},
"TaskReplaceRequestItem": {
Expand Down Expand Up @@ -7428,13 +7443,7 @@
"x-ms-summary": "Type"
}
},
"x-ms-dynamic-schema": {
"operationId": "GetTasksDynamicSchema",
"parameters": {
"mode": "REPLACE_INPUT"
},
"value-path": "schema"
}
"x-ms-summary": "Items"
},
"Milestone": {
"required": [
Expand Down Expand Up @@ -9048,6 +9057,18 @@
"type": "string",
"example": "https://www.asana.com/PROJECT-1234",
"x-ms-summary": "External View URL"
},
"projectIdOrKeyInTool": {
"description": "In tool linked projectId or toolKey",
"type": "string",
"example": "KNUTH-12334",
"x-ms-summary": "Project Id or Key in Tool"
},
"linkType": {
"description": "Type of link in the tool (e.g., EPIC or JQL)",
"type": "string",
"example": "EPIC | JQL",
"x-ms-summary": "Link Type"
}
},
"x-ms-dynamic-schema": {
Expand Down Expand Up @@ -9678,7 +9699,7 @@
"x-ms-summary": "Resource Key"
}
},
"x-ms-summary": "Program Manager"
"x-ms-summary": "Manager"
},
"ProgramCreateRequest": {
"required": [
Expand All @@ -9696,6 +9717,7 @@
"x-ms-summary": "Name"
},
"programKey": {
"description": "Must be unique. If empty, value will be generated.",
"type": "string",
"example": "MPPRG-1",
"x-ms-summary": "Program Key"
Expand All @@ -9706,6 +9728,13 @@
"status": {
"$ref": "#/definitions/SingleValueFieldRequest"
},
"customFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CustomFieldRequest"
},
"x-ms-summary": "Custom Fields"
},
"obsUnits": {
"type": "object",
"additionalProperties": {
Expand All @@ -9717,13 +9746,6 @@
}
},
"x-ms-summary": "Obs Units"
},
"customFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CustomFieldRequest"
},
"x-ms-summary": "Custom Fields"
}
},
"x-ms-dynamic-schema": {
Expand All @@ -9748,6 +9770,10 @@
"x-ms-summary": "Status"
},
"ProgramResponse": {
"required": [
"name",
"programKey"
],
"type": "object",
"properties": {
"id": {
Expand All @@ -9757,20 +9783,28 @@
},
"finish": {
"format": "date",
"description": "format: YYYY-MM-DD",
"description": "Program finish date: the latest finish date of any of this program's projects.",
"pattern": "format: YYYY-MM-DD",
"type": "string",
"example": "2019-01-31",
"example": "2019-12-31",
"x-ms-summary": "Finish"
},
"goal": {
"$ref": "#/definitions/BusinessGoalResponse"
},
"lastChanged": {
"format": "date-time",
"type": "string",
"example": "2022-12-22T16:50:10.0000000+00:00",
"x-ms-summary": "Last Changed"
},
"name": {
"type": "string",
"example": "Release road map",
"x-ms-summary": "Name"
},
"programKey": {
"description": "Must be unique. If empty, value will be generated.",
"type": "string",
"example": "MPPRG-1",
"x-ms-summary": "Program Key"
Expand All @@ -9783,35 +9817,15 @@
},
"start": {
"format": "date",
"description": "format: YYYY-MM-DD",
"description": "Program start date: the earliest start date of any of this program's projects.",
"pattern": "format: YYYY-MM-DD",
"type": "string",
"example": "2019-01-31",
"x-ms-summary": "Start"
},
"status": {
"$ref": "#/definitions/SingleValueStringResponse"
},
"obsUnits": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ObsUnitReferenceResponse"
},
"example": {
"Department": {
"id": "UUID",
"path": "Services/Consulting/IT",
"displayName": "Services > Consulting > IT"
}
},
"x-ms-dynamic-schema": {
"operationId": "GetObsDynamicSchema",
"parameters": {
"mode": "OUTPUT"
},
"value-path": "schema"
},
"x-ms-summary": "Obs Units"
},
"customFields": {
"type": "object",
"additionalProperties": {
Expand Down Expand Up @@ -9842,10 +9856,31 @@
},
"x-ms-summary": "Custom Fields"
},
"obsUnits": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ObsUnitReferenceResponse"
},
"example": {
"Department": {
"id": "UUID",
"path": "Services/Consulting/IT",
"displayName": "Services > Consulting > IT"
}
},
"x-ms-dynamic-schema": {
"operationId": "GetObsDynamicSchema",
"parameters": {
"mode": "OUTPUT"
},
"value-path": "schema"
},
"x-ms-summary": "Obs Units"
},
"viewUrl": {
"description": "A URL to view this entity in Meisterplan.",
"type": "string",
"example": "https://eu.meisterplan.com/sampleSystem/programs/06ac2271-9143-5518-93dd-4f2e105e9778",
"example": "https://eu.meisterplan.com/sampleSystem/details/06ac2271-9143-5518-93dd-4f2e105e9778",
"x-ms-summary": "View URL"
}
},
Expand Down Expand Up @@ -11335,6 +11370,7 @@
"x-ms-summary": "Name"
},
"programKey": {
"description": "Must be unique. If empty, value will be generated.",
"type": "string",
"example": "MPPRG-1",
"x-ms-summary": "Program Key"
Expand All @@ -11345,6 +11381,13 @@
"status": {
"$ref": "#/definitions/SingleValueFieldRequest"
},
"customFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CustomFieldRequest"
},
"x-ms-summary": "Custom Fields"
},
"obsUnits": {
"type": "object",
"additionalProperties": {
Expand All @@ -11356,13 +11399,6 @@
}
},
"x-ms-summary": "Obs Units"
},
"customFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CustomFieldRequest"
},
"x-ms-summary": "Custom Fields"
}
},
"x-ms-dynamic-schema": {
Expand Down Expand Up @@ -12535,6 +12571,10 @@
"x-ms-summary": "Paginated"
},
"ProgramGetAllResponse": {
"required": [
"name",
"programKey"
],
"type": "object",
"properties": {
"id": {
Expand All @@ -12548,6 +12588,7 @@
"x-ms-summary": "Name"
},
"programKey": {
"description": "Must be unique. If empty, value will be generated.",
"type": "string",
"example": "MPPRG-1",
"x-ms-summary": "Program Key"
Expand Down
2 changes: 1 addition & 1 deletion certified-connectors/Meisterplan/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The connector supports reading and/or updating the following Meisterplan entitie
- Scenarios (read only)
- Sprint (read only)
- Task Management
- Teams (read only)
- Teams
- Users (read only)

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