example of request with expand?

[pixelpaulaus]

Hello,
I am trying to do a request on an account, and expand some of the account records.
when i communicate with the API via another method/wrapper i have been using, i can do so by adding in:

expand: [{ property: 'property name', select: ['*'] }]

But i am not sure how to add in the expand code for the request:

$retrievedContact = $client->Retrieve( 'account', 'IDHERE', new \AlexaCRM\Xrm\ColumnSet( true ));

could you please provide an example, i want to expand multiple account properties to be retrieved in one request.

[georged]

@pixelpaulaus

I don't know what another method/wrapper you've been using so I can't comment on that. Can you provide a reference?

We do not provide expand on the Client class level. If you want, you can use OData client (available via $odataClient = $client->getClient() ). OData client includes getRecord method with queryOptions as a parameter; you can assign your expand expression to $queryOptions['Expand'].

dynamics-webapi-toolkit/src/WebAPI/OData/Client.php

Line 396 in 6618df0

public function getRecord( string $entityCollection, string $entityId, array $queryOptions = null ): object {

But then you're on your own to deal with what's coming back.

Having said that, it's not a bad idea. It'd be easy to add that option to the method itself but I think deserialization would need some work.

[sawtell]

I have done some work to extend the package to support more advanced filtering and expands (among some other bits).
You can see the changes here: https://github.com/sawtell/dynamics-webapi-toolkit/tree/feature/filters-and-expands

The changes allow for the following:

$query = new QueryByAttribute('logical_name');
$query->ColumnSet = new ColumnSet(['name', 'email', ...etc]);
$query->ColumnSet->AddExpand('field_name', new ColumnSet(['attributes', 'here']));

Also for more advanced filtering:

// Filter where created at date is between two dates
$query->AddFilter(new Filter('created_at', ['2024-10-01', '2024-12-04'], 'Between'));

It would be good to contribute these changes back to the project.

[georged]

@sawtell can you create a PR so that we can review and merge the changes properly?