External workflow API documentation

External API Documentation

External API documentation.

CENARYX Query scenario PnL result rows

GET /api/external/v1/results/scenario-pnl-results

Query scenario PnL result rows

Returns paged scenario PnL result rows from the lake. Paging is mandatory: callers must provide page and pageSize. pageSize is capped at 1000. Optional filters are exact-match filters.

Path and Query Parameters

Name	Location	Type	Required
`Page`	query	integer (int32)	no
`PageSize`	query	integer (int32)	no
`SimulationId`	query	string (guid)	no
`ReferenceDate`	query	string (date)	no
`Currency`	query	string	no
`Model`	query	string	no
`SimulationPass`	query	string	no
`DimensionKey`	query	string	no
`DimensionValue`	query	string	no
`Group`	query	string	no
`Book`	query	string	no
`Desk`	query	string	no
`Portfolio`	query	string	no
`Instrument`	query	string	no

CENARYX Query scenario PnL result rows - Responses

GET /api/external/v1/results/scenario-pnl-results

Responses

200 -

Name	Type	Required
`page`	integer (int32)	no
`pageSize`	integer (int32)	no
`totalCount`	integer (int32)	no
`results`	array of ScenarioPnlResultRow	no

400 -

429 -

Name	Type	Required
`type`	string	no
`title`	string	no
`status`	integer (int32)	no
`detail`	string	no
`instance`	string	no
`extensions`	object	no

CENARYX Query sensitivity result rows

GET /api/external/v1/results/sensitivity-results

Query sensitivity result rows

Returns paged sensitivity result rows from the lake. Paging is mandatory: callers must provide page and pageSize. pageSize is capped at 1000. Optional filters are exact-match filters.

Path and Query Parameters

Name	Location	Type	Required
`Page`	query	integer (int32)	no
`PageSize`	query	integer (int32)	no
`SimulationId`	query	string (guid)	no
`ReferenceDate`	query	string (date)	no
`Currency`	query	string	no
`Group`	query	string	no
`Book`	query	string	no
`Desk`	query	string	no
`Portfolio`	query	string	no
`Instrument`	query	string	no
`ValGroup`	query	string	no

CENARYX Query sensitivity result rows - Responses

GET /api/external/v1/results/sensitivity-results

Responses

200 -

Name	Type	Required
`page`	integer (int32)	no
`pageSize`	integer (int32)	no
`totalCount`	integer (int32)	no
`results`	array of SensitivityResultRow	no

400 -

429 -

Name	Type	Required
`type`	string	no
`title`	string	no
`status`	integer (int32)	no
`detail`	string	no
`instance`	string	no
`extensions`	object	no

CENARYX Submit a workflow batch

POST /api/external/v1/workflow-batches

Submit a workflow batch

Accepts an ordered workflow batch for asynchronous processing. The batch is published to the internal PushNotifier message queue as StartWorkflowBatchCommand. HTTP 202 means the batch was accepted for orchestration; it does not mean the workflows have completed.

Request Body

Name	Type	Required
`clientRequestId`	string	no
`referenceDate`	string (date)	no
`currency`	string	no
`workflows`	array of CreateWorkflowBatchItemRequest	no

CENARYX Submit a workflow batch - Responses

POST /api/external/v1/workflow-batches

Responses

202 -

Name	Type	Required
`batchId`	string (guid)	no
`status`	string	no
`submittedAt`	string (date-time)	no
`workflowCount`	integer (int32)	no
`links`	WorkflowBatchLinks	no

400 -

500 -

CENARYX Get workflow batch status

GET /api/external/v1/workflow-batches/{batchId}

Get workflow batch status

Returns the current status summary for a previously submitted external workflow batch. The endpoint currently returns the accepted placeholder state until PushNotifier workflow-batch state lookup is exposed to the external API.

Path and Query Parameters

Name	Location	Type	Required	Description
`batchId`	path	string (guid)	yes

CENARYX Get workflow batch status - Responses

GET /api/external/v1/workflow-batches/{batchId}

Responses

200 -

Name	Type	Required
`batchId`	string (guid)	no
`status`	string	no
`updatedAt`	string (date-time)	no
`completedAt`	string (date-time)	no
`workflows`	array of WorkflowBatchItemStatus	no

404 -

Name	Type	Required
`type`	string	no
`title`	string	no
`status`	integer (int32)	no
`detail`	string	no
`instance`	string	no
`extensions`	object	no

CENARYX Get persisted aggregation result rows

GET /api/external/v1/workflow-batches/{batchId}/results/aggregations

Get persisted aggregation result rows

Returns typed aggregation result rows persisted in the lake for the supplied batch id. The endpoint is read-only and supports paging plus optional filters for reference date, currency, model, aggregation set and dimension. HTTP 200 with an empty result set means no lake rows currently match the request.

Path and Query Parameters

Name	Location	Type	Required
`batchId`	path	string (guid)	yes
`Page`	query	integer (int32)	no
`PageSize`	query	integer (int32)	no
`ReferenceDate`	query	string (date)	no
`Currency`	query	string	no
`Model`	query	string	no
`AggregationSet`	query	string	no
`DimensionKey`	query	string	no
`DimensionValue`	query	string	no

CENARYX Get persisted aggregation result rows - Responses

GET /api/external/v1/workflow-batches/{batchId}/results/aggregations

Responses

200 -

Name	Type	Required
`batchId`	string (guid)	no
`page`	integer (int32)	no
`pageSize`	integer (int32)	no
`totalCount`	integer (int32)	no
`results`	array of WorkflowBatchAggregationResultRow	no