Simulator [CH - QA]

DCleaR - Risk Simulator API - v1

Creates a new object of in the Simulations collection.

Creates a new object of in the Simulations collection.

post

Body

application/vnd.api+json

SimulationJsonApiType

Object in JSON:API format.

dataobjectrequired

Data structure for all operations.

Show Child Parameters

Response

application/vnd.api+json

Ok

SimulationJsonApiType

Object in JSON:API format.

dataobjectrequired

Data structure for all operations.

Show Child Parameters
post/simulations

Body

{ "data": { "attributes": { "date": "2023-09-15", "name": "Simulation-1", "simulationType": "GUARANTEE", "calculationType": "MODEL", "algorithmType": "IM" }, "type": "simulation" } }
 
application/vnd.api+json

Advanced search for Simulations collection

SEARCH is an experience/resource type API designed to provide support to the search of Simulations collection. This is part of the advanced query search.

The operation uses the next query objects:

  • Filters: every filter applied MUST be present with the provided value set.
  • Restrictions: every object returned in the collection MUST be validated on the restriction.

Every restriction and filter is applied with AND operation. As example:

POST simulations
{
    "filters": [
        {
            "attribute": "attributeId",
            "values": [
                "attributeValue"
            ]
        }

    ], 
    "restrictions": [
        {
          "attribute": "numericAttributeId",
          "type": "decimal",
          "operator": "and",
          "values": [
              {
                "restriction": "lte",
                "value": "2.0"
            },
            {
                "restriction": "gte",
                "value": "1.0"
            }
        ]
      }
    ]
}

This is equivalent to: WHERE attributeId IN (“attributeValue”) AND numericAttributeId > 1.0 AND numericAttributeId < 2.0

Results could be ordered by any field.

post

Query Parameters

page[size]integer

Pagination options for the collection search. It permits the next modifiers:

  • page[size]
  • page[number]

Default values defined are page[number]=1 and page[size]=20

page[number]integer

Pagination options for the collection search. It permits the next modifiers:

  • page[size]
  • page[number]

Default values defined are page[number]=1 and page[size]=20

sortstring

Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:

GET simulations?sort=+attribute

The type of sort:

  • (+) Indicates ascending order. +attribute
  • (-) Indicates descending order. -attribute
  • If no symbol is provided, any default order could be returned

If sort is not provided, the collection is returned in a default order by ID.

The name of the attribute should exists in the object. If the name does not exists, it returns 400 Bad Request.

Body

application/json

QueryType

filtersarray[object]

Filters restricting the search. All of the values in the Array represent AND operation.

Show Child Parameters
restrictionsarray[object]

List of restrictions applied to the collection

Show Child Parameters

Response

application/vnd.api+json

Ok

SimulationsJsonApiType

Collection in JSON:API format. Collection is paginated

linksobjectrequired
Show Child Parameters
dataarray[object]requiredread-only

Data structure for all operations.

Show Child Parameters
metaobjectrequired
Show Child Parameters
post/simulations/search

Body

{ "filters": [ { "attribute": "attributeId", "values": [ "attributeValue" ] } ], "restrictions": [ { "attribute": "numericAttributeId", "type": "decimal", "operator": "and", "values": [ { "restriction": "lte", "value": "2.0" }, { "restriction": "gte", "value": "1.0" } ] } ] }
 
application/vnd.api+json

Retrieves one specific object from Simulations collection

Retrieves one specific object from Simulations collection

get

Path Parameters

simulationIdstringrequired

Resource ID in UUID format

Response

application/vnd.api+json

Ok

SimulationJsonApiType

Object in JSON:API format.

dataobjectrequired

Data structure for all operations.

Show Child Parameters
get/simulations/{simulationId}
 
application/vnd.api+json

Delete an object from Simulations collection

Delete an object from Simulations collection

delete

Path Parameters

simulationIdstringrequired

Resource ID in UUID format

Response

Ok

delete/simulations/{simulationId}
 

Modify the object in Simulations collection

Modify an object present in Simulations collection

patch

Path Parameters

simulationIdstringrequired

Resource ID in UUID format

Body

application/vnd.api+json

Simulation

SimulationJsonApiType

Object in JSON:API format.

dataobjectrequired

Data structure for all operations.

Show Child Parameters

Response

application/vnd.api+json

Ok

SimulationJsonApiType

Object in JSON:API format.

dataobjectrequired

Data structure for all operations.

Show Child Parameters
patch/simulations/{simulationId}

Body

{ "data": { "attributes": { "date": "2023-09-15", "name": "Simulation-1", "simulationType": "GUARANTEE", "calculationType": "MODEL", "algorithmType": "IM" }, "id": "95b1b467-bd69-4436-8181-96c16408c230", "type": "simulation" } }
 
application/vnd.api+json