Documentation forAccess Rights Manager

Analyze APIs

Get Scenario Form Of Result (GET)

Returns the filled form of calculated result

Route

URI

/api/v1/analyze

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

scenarioId

string

No

 

requestId

Guid

No

 

Example

GET http://localhost/api/v1/analyze

Get Analyze Config (GET)

Get configuration in form of IFormTemplate for Analyze.

Route

URI

/api/v1/analyze/Configuration

Method

GET

Result

JSON – IFormTemplate

Parameters

None

Example

GET http://localhost/api/v1/analyze/Configuration

Set Analyze Config (POST)

Save Configuration in form of IFormTemplate for Analyze.

Route

URI

/api/v1/analyze/Configuration

Method

POST

Result

JSON – IActionResult

Parameters

None

Example

POST http://localhost/api/v1/analyze/Configuration

Get Dashboard Configurations (GET)

Get Dashboard Configurations.

Route

URI

/api/v1/analyze/Dashboard

Method

GET

Result

JSON – ScenarioConfiguration[]

Parameters

None

Response Structure Returns ScenarioConfiguration[] object containing:

  • DisplayName: The name of this customized scenario.

  • ScenarioId: Gets the ID of the scenario.

  • InputParameters: IFormTemplate value

  • GridConfiguration: ScenarioGridConfiguration value

Example

GET http://localhost/api/v1/analyze/Dashboard

Example Response

{     
"DisplayName": "sample",     
"ScenarioId": "123e4567-e89b-12d3-a456-426614174000",     
"InputParameters": {},     
"GridConfiguration": {} 
}

Request New Scenario Data (POST)

Returns the guid for a new analyze scenario request. The request is calculated in the background and signaled if done.

Route

URI

/api/v1/analyze/scenario/{id}

Method

POST

Result

JSON – Guid inside ResponseId of ChangeResult

Parameters

Name

Type

Mandatory

Description

id

Guid

Yes

 

Response Structure Returns ChangeResult object containing:

  • Success: bool value

  • Data: object value

  • ResponseId: Guid? value

  • ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/analyze/scenario/{id}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Scenario Form Template (GET)

Returns an input template for the given scenario <paramref name="id"/>.

Route

URI

/api/v1/analyze/Scenario/{id}/Form

Method

GET

Result

JSON – IFormTemplate

Parameters

Name

Type

Mandatory

Description

id

Guid

Yes

 

Example

GET http://localhost/api/v1/analyze/Scenario/{id}/Form

Refresh (POST)

See <see cref="IOpenScenarioService.RefreshScenario"/>.

Route

URI

/api/v1/analyze/Scenario/{id}/Refresh

Method

POST

Result

JSON – ChangeResult

Parameters

Name

Type

Mandatory

Description

id

Guid

Yes

 

Response Structure Returns ChangeResult object containing:

  • Success: bool value

  • Data: object value

  • ResponseId: Guid? value

  • ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/analyze/Scenario/{id}/Refresh

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Scenario Summary (POST)

Get Scenario Summary.

Route

URI

/api/v1/analyze/Scenario/{id}/Summary

Method

POST

Result

JSON – ScenarioResultSummary

Parameters

Name

Type

Mandatory

Description

id

Guid

Yes

 

Response Structure Returns ScenarioResultSummary object containing:

  • Title: string value

  • ScenarioId: The ID of the scenario.

  • Text: string value

  • SystemStatus: Specifies further display options (e.g. to be visualized by icons or colors).

  • Diagram: ScenarioDiagramElement[] value

Example

POST http://localhost/api/v1/analyze/Scenario/{id}/Summary

Example Response

{     
"Title": "sample",     
"ScenarioId": "123e4567-e89b-12d3-a456-426614174000",     
"Text": "sample",     
"SystemStatus": {},     
"Diagram": {} 
}

Get Supported Actions (POST)

Get Supported Actions.

Route

URI

/api/v1/analyze/Scenario/{id}/SupportedActions

Method

POST

Result

JSON – Dictionary<Guid, object>

Parameters

Name

Type

Mandatory

Description

id

Guid

Yes

 

Example

POST http://localhost/api/v1/analyze/Scenario/{id}/SupportedActions

Get Fill Scenario Form (GET)

Get Fill Scenario Form.

Route

URI

/api/v1/analyze/Scenario/{scenarioId}

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

scenarioId

Guid

Yes

 

Example

GET http://localhost/api/v1/analyze/Scenario/{scenarioId}

Report Scenario Data (POST)

Report Scenario Data.

Route

URI

/api/v1/analyze/Scenario/Report

Method

POST

Result

JSON – ChangeResult

Request Payload

ScenarioReportRequest object:

Property

Type

Mandatory

Description

GridDataJson

string

Yes

 

ReportConfiguration

ScenarioReportConfiguration

Yes

 

GridConfiguration

ScenarioGridConfiguration

Yes

 

Response Structure Returns ChangeResult object containing:

  • Success: bool value

  • Data: object value

  • ResponseId: Guid? value

  • ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/analyze/Scenario/Report Content-Type: application/json  
{     
"GridDataJson": "sample",     
"ReportConfiguration": {},     
"GridConfiguration": {} 
}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Scenarios (GET)

Returns a list off all <see cref="ScenarioInfo"/>'s for the current user.

Route

URI

/api/v1/analyze/Scenarios

Method

GET

Result

JSON – List<dynamic>

Parameters

None

Example

GET http://localhost/api/v1/analyze/Scenarios