Retrieve all media items from a media folder.
You can search in the entire library when using -1 as FolderId. This is only allowed when using MediaTypeId or Name as optional parameters.
Name | Description | Type | Additional information |
---|---|---|---|
FolderId
The id of the media folder for which you would like to retrieve the items. Use '0' if you would like to retrieve items from the root folder.
Type
integer
Additional info
Required
|
|||
FolderId |
The id of the media folder for which you would like to retrieve the items. Use '0' if you would like to retrieve items from the root folder. |
integer |
Required |
MediaTypeId |
Filter media items by there type |
integer |
Optional |
Name
Part of the name of the media item you are looking for.
Type
string
Additional info
Optional
|
|||
Name |
Part of the name of the media item you are looking for. |
string |
Optional |
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data |
The actual data returned by the request. |
MediaResult | |
Links |
HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. |
Hateoas |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-09-07T23:42:44.3644446Z", "IsFiltered": true }, "Data": { "SpaceUsed": 1, "MediaFiles": [ { "MediaId": 1, "MediaName": "sample string 2", "MediaType": 3, "FileExtension": "sample string 4", "FileSize": 5, "Width": 6, "Height": 7, "LastModifiedDate": "2024-09-07T23:42:44.3644446Z", "ThumbUrl": "sample string 9", "Url": "sample string 10" }, { "MediaId": 1, "MediaName": "sample string 2", "MediaType": 3, "FileExtension": "sample string 4", "FileSize": 5, "Width": 6, "Height": 7, "LastModifiedDate": "2024-09-07T23:42:44.3644446Z", "ThumbUrl": "sample string 9", "Url": "sample string 10" } ] } }
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Data> <MediaFiles> <MediaFile z:Id="i2"> <FileExtension>sample string 4</FileExtension> <FileSize>5</FileSize> <Height>7</Height> <LastModifiedDate>2024-09-08T00:42:44.3644446+01:00</LastModifiedDate> <MediaId>1</MediaId> <MediaName>sample string 2</MediaName> <MediaType>3</MediaType> <ThumbUrl>sample string 9</ThumbUrl> <Url>sample string 10</Url> <Width>6</Width> </MediaFile> <MediaFile z:Ref="i2" /> </MediaFiles> <SpaceUsed>1</SpaceUsed> </Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-09-08T00:42:44.3644446+01:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>