microsoftgraph / microsoftgraph/msgraph-sdk-java
Workbooks: Update range of a worksheet not implemented in sdk
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 444
- Forks
- 154
- Avg merge
- 18h 28m
- Merged PRs (30d)
- 4
Description
Is your feature request related to a problem? Please describe the problem.
I want to update a range within a worksheet and noticed that the update range endoint (PATCH /drive/items/{id}/workbook/worksheets/{sheet-id}/range(address='A1:B2')) cannot be called via the msgraph-sdk for java.
API Docs:
https://learn.microsoft.com/en-us/graph/api/range-update?view=graph-rest-1.0&tabs=http
SDK-Version: 6.18.0
Describe the solution you'd like.
I would be glad if you could extend the sdk to support this functionality.
E.g. something like this:
myGraphServiceClient
.drives()
.byDriveId(driveId)
.items()
.byDriveItemId(documentId)
.workbook()
.worksheets()
.byWorkbookWorksheetId(worksheet)
.rangeWithAddress(address)
.patch(patchRequest);
Additional context?
My current workaround is
final var updateRangeRequest = new UntypedObject(Map.of(
"values", new UntypedArray(Arrays.asList(
new UntypedArray(Arrays.asList(
new UntypedString(value)
))
))
));
final var requestInfo = graphServiceClient
.drives()
.byDriveId(this.driveId)
.items()
.byDriveItemId(documentId)
.workbook()
.worksheets()
.byWorkbookWorksheetId(worksheet)
.rangeWithAddress(address)
.toGetRequestInformation();
// Convert the get-request to the desired patch
requestInfo.headers.tryAdd("workbook-session-id", sessionId);
requestInfo.httpMethod = HttpMethod.PATCH;
requestInfo.setContentFromParsable(graphServiceClient.getRequestAdapter(), "application/json", updateRangeRequest);
// Copied from sdk
HashMap<String, ParsableFactory<? extends Parsable>> errorMapping = new HashMap();
errorMapping.put("XXX", ODataError::createFromDiscriminatorValue);
final var updatedRange = (WorkbookRange) graphServiceClient.getRequestAdapter()
.send(requestInfo, errorMapping, WorkbookRange::createFromDiscriminatorValue);
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Java SDK entry point ending in worksheets().byWorkbookWorksheetId(worksheet).rangeWithAddress(address), and compare it with the range-update API documentation. Verify how the existing request information is built and how the supplied PATCH payload is sent; done means callers can update a worksheet range through the normal SDK path rather than the workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100