Analyze SharePoint applications using Rencore Code
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
api-analyze-post (api-analyze-postParameterAnalysisRequest analysisRequest) |
Analyze the contents of the specified file |
Check the status of the specified analysis job |
Name |
Summary |
Name |
Summary |
|
Summary: Analyze the contents of the specified file
Description: Analyzes the contents of the specified file. If the analysis request is accepted, returns a 202 Accepted response with a URL to poll to check the analysis status.
Syntax:
RencoreCode.api-analyze-post (api-analyze-postParameterAnalysisRequest analysisRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
analysisRequest |
api-analyze-postParameterAnalysisRequest
|
|
True |
Returns:
Summary: Check the status of the specified analysis job
Description: Checks the status of the specified analysis job. As long as the analysis is in progress, the API will return a **202 Accepted** response. When the analysis is completed, the API will return a **200 OK** response with the contents of the HTML report in the response body. If there was an error during the analysis, the API will return a **500 Internal Server Error** response with the error message.
Syntax:
RencoreCode.api-status-get (string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
jobId |
string
|
ID of the analysis job to check the status of |
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
file |
string(byte)
|
Serialized JSON string with the contents of the file to analyze. The $content property contains base64-encoded contents of the file. |
fileName |
string
|
Name of the file to analyze. The extension should match the contents of the file or the analysis will produce invalid results |
license |
string
|
SPCAF license to use with the analysis. If not specified, summary results will be returned |