Solutions API
This API enables you to get detailed data about solutions. These details are tabulated below.
| Name | Description | Type | Indexed |
| SolutionKey | ID of the solution name. | Integer | Y |
| Name | Solution Name | String | Y |
| WebAppID | GUID of SharePoint's Web application from SharePoint. | String | Y |
| WebApplicationName | Name of theSharePoint Web Application - the host URL of SharePoint web application. | String | Y |
| SiteID | GUID of SharePoint’s site collection | String | Y |
| WebId | GUID of SharePoint site's web ID. | String | Y |
| WebName | SharePoint site's web name. | String | Y |
| WebPath | Relative path of SharePoint site's web. | String | Y |
Endpoints and Methods
HTTP Method only GET is implemented.
- Route: /v1/dim/solutions - Get all solution dimension data.
- Route: /v1/dim/solutions/{solutionkey} - Get solution dimension data given Solution Dimension Key
- Route: /v1/dim/solutions - Get solution dimension data as per filtering, sorting, paging, and search
- Route: /v1/dim/solutions/getcount - Get the count of solutions, it can be used with $filter.
URL
The URL is as follows: <<host>>/dwapi/v1/dim/solutions
Query Parameters, Descriptions, and Examples
Select
$select: This query option specifies that only the requested properties are returned. Use commas to specify multiple properties.
Filter
$filter: This query option restricts the data to be returned for the requested resource.
You can use the following to further specify your results:
- Built-in Filter Operations
- Comparison operators – eq Equal, ne Not equal etc.
- Logical operators – and Logical and, or Logical or, not Logical negation.
- Arithmetic operators – add Addition, sub Subtraction etc.
- Grouping operators – () Precedence grouping
- Built-in Query Functions
- String Functions – contains, endswith etc.
- Date Functions – year, month, day etc.
- Match Functions – round, floor etc.
Orderby
$orderby: This query option requests the service to return the result set in the specified order requested.
This parameter can include asc for asending or desc for descending. Default is ascending if not specified.
$top and $skip
$top: This query option limits the items from result set.
$skip: This query option excludes the first n items from the result set.
Using $orderyby with $top and $skip results in more consistent data.
getcount
/getcount: This gets the count of result set or data queried. $filter can be used with getcount to know the count of filters result set.
This is not an Odata standard operation, it is only for the Foundation APIs.