PIpismo
Simulation

Get Simulation configuration details

Retrieve simulation configs based on the filters

get/v1/simulation/configs

Request

  • Base URL
    https://sandbox.pismolabs.io/rates
  • URL
    https://sandbox.pismolabs.io/rates/v1/simulation/configs
  • Auth
    HTTP bearer

Query parameters

descriptionstring

Filter by any description including simulation config id

simulation_config_idstring

Filter by Simulation configuration ID

programIdinteger

Deprecated - use program_ids instead. Filters by a single Pismo program ID. Mutually exclusive with program_ids: sending both returns 400.

program_idsinteger[]

Filters by one or more Pismo program IDs. Recommended over the deprecated programId parameter.

  • Format: comma-separated list, e.g. program_ids=1,2,3. Repeating the parameter (program_ids=1&program_ids=2) is also accepted.
  • Values: each ID must be a positive integer; a value <= 0 returns 400 RCAPI-INVALID-QUERY-PARAM.
  • Duplicates: IDs should be distinct; any repeated IDs are tolerated, de-duplicated server-side, and do not count toward the maximum.
  • Maximum: up to 20 distinct program IDs per request. Sending more than 20 returns 400 RCAPI-INVALID-QUERY-PARAM.
  • Mutual exclusivity: cannot be combined with programId; sending both returns 400 RCAPI-INVALID-QUERY-PARAM.
[
  1,
  2,
  3
]
has_attachmentsboolean

Filter by attachment presence

exclude_tenant_attachedboolean

When set to true, excludes simulation configs that are attached at the TENANT level. This is useful to avoid data duplication on screen, since the tenant-attached config is typically displayed separately as the default configuration.

pageinteger required

Page Number(starts from 1)

per_pageinteger required

Number of items per page

Response

OK

pagesinteger
per_pageinteger
total_itemsinteger

Example response

{
  "items": [
    {
      "description": "This is my simulation configurations"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.