Endpoints

iamc

PATCH /iamc/datapoints/

Query

This endpoint is used to retrieve and optionally filter data.add()

Filter parameters are provided as keyword arguments.

The available filters can be found here: ixmp4.data.db.iamc.datapoint.filter.DataPointFilter.

Examples

Filter data points for a given model, scenario combination, and a number of years:

{
    "model" : {"name": "model 1"},
    "scenario" : {"name": "scenario 1"},
    "year__in" : [2020, 2025]
}

Return all data for a given variable:

{
    "variable": {"name": "Final Energy"}
}

param string platform:
query {‘null’, ‘boolean’} join_parameters:
query boolean join_runs:
query {‘null’, ‘boolean’} table:
query integer limit:
query integer offset:

Example request:

PATCH /iamc/datapoints/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "year": 1,
    "time_series_id": 1,
    "region": {
        "name": "string",
        "hierarchy": "string",
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "unit": {
        "name": "string",
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "variable": {
        "name": "string",
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "model": {
        "name": "string",
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "scenario": {
        "name": "string",
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "run": {
        "id": 1,
        "default_only": true,
        "id__in": [
            1
        ]
    },
    "year__in": [
        1
    ],
    "year__gt": 1,
    "year__lt": 1,
    "year__gte": 1,
    "year__lte": 1,
    "time_series_id__in": [
        1
    ]
}

status 200:

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

status 422:

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

reqheader authorization:

POST /iamc/datapoints/bulk/

Bulk Upsert

ixmp4.server.rest.iamc.datapoint.bulk_upsert()

Parameters:

platform (string)

Example request:

POST /iamc/datapoints/bulk/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "index": [
        {}
    ],
    "columns": [
        "string"
    ],
    "dtypes": [
        "string"
    ],
    "data": [
        {}
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/datapoints/bulk/

Bulk Delete

ixmp4.server.rest.iamc.datapoint.bulk_delete()

Parameters:

platform (string)

Example request:

PATCH /iamc/datapoints/bulk/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "index": [
        {}
    ],
    "columns": [
        "string"
    ],
    "dtypes": [
        "string"
    ],
    "data": [
        {}
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/models/

Query

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /iamc/models/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "region": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "variable": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "unit": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/scenarios/

Query

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /iamc/scenarios/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "region": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "variable": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "unit": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/regions/

Query

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /iamc/regions/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "hierarchy": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "hierarchy__in": [
        "string"
    ],
    "hierarchy__like": "string",
    "hierarchy__ilike": "string",
    "hierarchy__notlike": "string",
    "hierarchy__notilike": "string",
    "variable": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "unit": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/units/

Query

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /iamc/units/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "variable": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "region": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/variables/

Query

ixmp4.server.rest.iamc.variable.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /iamc/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "region": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "unit": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /iamc/variables/

Create

ixmp4.server.rest.iamc.variable.create()

Parameters:

platform (string)

Example request:

POST /iamc/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /iamc/timeseries/

Query

ixmp4.server.rest.iamc.timeseries.query()

Parameters:

platform (string)

Query Parameters:

join_parameters ({'null', 'boolean'})
table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /iamc/timeseries/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "id__in": [
        1
    ],
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    },
    "region": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string"
    },
    "variable": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "unit": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /iamc/timeseries/

Create

Parameters:

platform (string)

Example request:

POST /iamc/timeseries/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run__id": 1,
    "parameters": {}
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "model": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "model__id": 1,
    "scenario": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "scenario__id": 1,
    "version": 1,
    "is_default": true
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /iamc/timeseries/{id}/

Get By Id

Parameters:

id (integer)
platform (string)

Example request:

GET /iamc/timeseries/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "run__id": 1,
    "parameters": {}
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /iamc/timeseries/bulk/

Bulk Upsert

Parameters:

platform (string)

Query Parameters:

create_related ({'null', 'boolean'})

Example request:

POST /iamc/timeseries/bulk/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "index": [
        {}
    ],
    "columns": [
        "string"
    ],
    "dtypes": [
        "string"
    ],
    "data": [
        {}
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

docs

GET /docs/models/

List Models

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/models/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/models/

Set Models

Parameters:

platform (string)

Example request:

POST /docs/models/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/models/{dimension_id}/

Delete Models

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/regions/

List Regions

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/regions/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/regions/

Set Regions

Parameters:

platform (string)

Example request:

POST /docs/regions/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/regions/{dimension_id}/

Delete Regions

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/scenarios/

List Scenarios

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/scenarios/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/scenarios/

Set Scenarios

Parameters:

platform (string)

Example request:

POST /docs/scenarios/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/scenarios/{dimension_id}/

Delete Scenarios

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/units/

List Units

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/units/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/units/

Set Units

Parameters:

platform (string)

Example request:

POST /docs/units/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/units/{dimension_id}/

Delete Units

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/iamc/variables/

List Variables

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/iamc/variables/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/iamc/variables/

Set Variables

Parameters:

platform (string)

Example request:

POST /docs/iamc/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/iamc/variables/{dimension_id}/

Delete Variables

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/indexsets/

List Indexsets

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})
limit (integer)
offset (integer)

Example request:

GET /docs/optimization/indexsets/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/indexsets/

Set Indexsets

Parameters:

platform (string)

Example request:

POST /docs/optimization/indexsets/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/indexsets/{dimension_id}/

Delete Indexsets

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/scalars/

List Scalars

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})

Example request:

GET /docs/optimization/scalars/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 1,
        "description": "string",
        "dimension__id": 1
    }
]

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/scalars/

Set Scalars

Parameters:

platform (string)

Example request:

POST /docs/optimization/scalars/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/scalars/{dimension_id}/

Delete Scalars

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/tables/

List Tables

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})

Example request:

GET /docs/optimization/tables/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 1,
        "description": "string",
        "dimension__id": 1
    }
]

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/tables/

Set Tables

Parameters:

platform (string)

Example request:

POST /docs/optimization/tables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/tables/{dimension_id}/

Delete Tables

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/parameters/

List Parameters

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})

Example request:

GET /docs/optimization/parameters/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 1,
        "description": "string",
        "dimension__id": 1
    }
]

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/parameters/

Set Parameters

Parameters:

platform (string)

Example request:

POST /docs/optimization/parameters/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/parameters/{dimension_id}/

Delete Parameters

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/variables/

List Optimization Variables

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})

Example request:

GET /docs/optimization/variables/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 1,
        "description": "string",
        "dimension__id": 1
    }
]

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/variables/

Set Optimization Variables

Parameters:

platform (string)

Example request:

POST /docs/optimization/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/variables/{dimension_id}/

Delete Optimization Variables

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /docs/optimization/equations/

List Equations

Parameters:

platform (string)

Query Parameters:

dimension_id ({'null', 'integer'})

Example request:

GET /docs/optimization/equations/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 1,
        "description": "string",
        "dimension__id": 1
    }
]

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /docs/optimization/equations/

Set Equations

Parameters:

platform (string)

Example request:

POST /docs/optimization/equations/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dimension_id": 1,
    "description": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "description": "string",
    "dimension__id": 1
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /docs/optimization/equations/{dimension_id}/

Delete Equations

Parameters:

dimension_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

meta

PATCH /meta/

Query

Parameters:

platform (string)

Query Parameters:

join_run_index ({'null', 'boolean'})
table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /meta/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "type": "string",
    "run_id": 1,
    "key": "string",
    "value_int": 1,
    "value_str": "string",
    "value_float": 1,
    "value_bool": true,
    "id__in": [
        1
    ],
    "type__in": [
        "string"
    ],
    "type__like": "string",
    "type__ilike": "string",
    "type__notlike": "string",
    "type__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1,
    "key__in": [
        "string"
    ],
    "key__like": "string",
    "key__ilike": "string",
    "key__notlike": "string",
    "key__notilike": "string",
    "value_int__in": [
        1
    ],
    "value_int__gt": 1,
    "value_int__lt": 1,
    "value_int__gte": 1,
    "value_int__lte": 1,
    "value_str__in": [
        "string"
    ],
    "value_str__like": "string",
    "value_str__ilike": "string",
    "value_str__notlike": "string",
    "value_str__notilike": "string",
    "value_float__in": [
        1
    ],
    "value_float__gt": 1,
    "value_float__lt": 1,
    "value_float__gte": 1,
    "value_float__lte": 1,
    "run": {
        "id": 1,
        "version": 1,
        "default_only": true,
        "is_default": true,
        "model": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "scenario": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "id__in": [
            1
        ],
        "version__in": [
            1
        ],
        "version__gt": 1,
        "version__lt": 1,
        "version__gte": 1,
        "version__lte": 1
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /meta/

Create

Parameters:

platform (string)

Example request:

POST /meta/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run__id": 1,
    "key": "string",
    "value": true
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "run__id": 1,
    "key": "string",
    "type": "string",
    "value": true
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /meta/{id}/

Delete

Parameters:

id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /meta/bulk/

Bulk Upsert

Parameters:

platform (string)

Example request:

POST /meta/bulk/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "index": [
        {}
    ],
    "columns": [
        "string"
    ],
    "dtypes": [
        "string"
    ],
    "data": [
        {}
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /meta/bulk/

Bulk Delete

Parameters:

platform (string)

Example request:

PATCH /meta/bulk/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "index": [
        {}
    ],
    "columns": [
        "string"
    ],
    "dtypes": [
        "string"
    ],
    "data": [
        {}
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

models

PATCH /models/

Query

ixmp4.server.rest.model.query()

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /models/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "iamc": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "region": {
            "id": 1,
            "name": "string",
            "hierarchy": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string",
            "hierarchy__in": [
                "string"
            ],
            "hierarchy__like": "string",
            "hierarchy__ilike": "string",
            "hierarchy__notlike": "string",
            "hierarchy__notilike": "string"
        },
        "variable": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "unit": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "run": {
            "id": 1,
            "version": 1,
            "default_only": true,
            "is_default": true,
            "model": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "scenario": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "id__in": [
                1
            ],
            "version__in": [
                1
            ],
            "version__gt": 1,
            "version__lt": 1,
            "version__gte": 1,
            "version__lte": 1
        }
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /models/

Create

ixmp4.server.rest.model.create()

Parameters:

platform (string)

Example request:

POST /models/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

optimization

GET /optimization/equations/{id}/

Get By Id

ixmp4.server.rest.optimization.equation.get_by_id()

Parameters:

id (integer)
platform (string)

Example request:

GET /optimization/equations/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/equations/

Query

ixmp4.server.rest.optimization.equation.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/equations/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/equations/

Create

ixmp4.server.rest.optimization.equation.create()

Parameters:

platform (string)

Example request:

POST /optimization/equations/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run_id": 1,
    "name": "string",
    "constrained_to_indexsets": [
        "string"
    ],
    "column_names": [
        "string"
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/equations/{equation_id}/data/

Add Data

ixmp4.server.rest.optimization.equation.add_data()

Parameters:

equation_id (integer)
platform (string)

Example request:

PATCH /optimization/equations/{equation_id}/data/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": {}
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /optimization/equations/{equation_id}/data/

Remove Data

ixmp4.server.rest.optimization.equation.remove_data()

Parameters:

equation_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/indexsets/

Query

ixmp4.server.rest.optimization.indexset.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/indexsets/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/indexsets/

Create

ixmp4.server.rest.optimization.indexset.create()

Parameters:

platform (string)

Example request:

POST /optimization/indexsets/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run_id": 1,
    "name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "elements": 1.0,
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/indexsets/{indexset_id}/

Add Elements

ixmp4.server.rest.optimization.indexset.add_elements()

Parameters:

indexset_id (integer)
platform (string)

Example request:

PATCH /optimization/indexsets/{indexset_id}/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "elements": 1.0
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /optimization/parameters/{id}/

Get By Id

ixmp4.server.rest.optimization.parameter.get_by_id()

Parameters:

id (integer)
platform (string)

Example request:

GET /optimization/parameters/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/parameters/

Query

ixmp4.server.rest.optimization.parameter.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/parameters/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/parameters/

Create

ixmp4.server.rest.optimization.parameter.create()

Parameters:

platform (string)

Example request:

POST /optimization/parameters/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run_id": 1,
    "name": "string",
    "constrained_to_indexsets": [
        "string"
    ],
    "column_names": [
        "string"
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/parameters/{parameter_id}/data/

Add Data

ixmp4.server.rest.optimization.parameter.add_data()

Parameters:

parameter_id (integer)
platform (string)

Example request:

PATCH /optimization/parameters/{parameter_id}/data/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": {}
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /optimization/scalars/{id}/

Get By Id

ixmp4.server.rest.optimization.scalar.get_by_id()

Parameters:

id (integer)
platform (string)

Example request:

GET /optimization/scalars/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "value": 1.0,
    "unit": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "unit__id": 1,
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/scalars/{id}/

Update

ixmp4.server.rest.optimization.scalar.update()

Parameters:

id (integer)
platform (string)

Example request:

PATCH /optimization/scalars/{id}/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "value": 1.0,
    "unit_id": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "value": 1.0,
    "unit": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "unit__id": 1,
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/scalars/

Query

ixmp4.server.rest.optimization.scalar.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/scalars/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "unit_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1,
    "unit_id__in": [
        1
    ],
    "unit_id__gt": 1,
    "unit_id__lt": 1,
    "unit_id__gte": 1,
    "unit_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/scalars/

Create

ixmp4.server.rest.optimization.scalar.create()

Parameters:

platform (string)

Example request:

POST /optimization/scalars/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "value": 1.0,
    "unit_name": "string",
    "run_id": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "value": 1.0,
    "unit": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "unit__id": 1,
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /optimization/tables/{id}/

Get By Id

ixmp4.server.rest.optimization.table.get_by_id()

Parameters:

id (integer)
platform (string)

Example request:

GET /optimization/tables/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/tables/

Query

ixmp4.server.rest.optimization.table.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/tables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/tables/

Create

ixmp4.server.rest.optimization.table.create()

Parameters:

platform (string)

Example request:

POST /optimization/tables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run_id": 1,
    "name": "string",
    "constrained_to_indexsets": [
        "string"
    ],
    "column_names": [
        "string"
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/tables/{table_id}/data/

Add Data

ixmp4.server.rest.optimization.table.add_data()

Parameters:

table_id (integer)
platform (string)

Example request:

PATCH /optimization/tables/{table_id}/data/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": {}
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

GET /optimization/variables/{id}/

Get By Id

ixmp4.server.rest.optimization.variable.get_by_id()

Parameters:

id (integer)
platform (string)

Example request:

GET /optimization/variables/{id}/ HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/variables/

Query

ixmp4.server.rest.optimization.variable.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /optimization/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "run_id": 1,
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "run_id__in": [
        1
    ],
    "run_id__gt": 1,
    "run_id__lt": 1,
    "run_id__gte": 1,
    "run_id__lte": 1
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /optimization/variables/

Create

ixmp4.server.rest.optimization.variable.create()

Parameters:

platform (string)

Example request:

POST /optimization/variables/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "run_id": 1,
    "name": "string",
    "constrained_to_indexsets": "string",
    "column_names": [
        "string"
    ]
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "data": {},
    "columns": [
        {
            "id": 1,
            "name": "string",
            "dtype": "string",
            "equation__id": 1,
            "parameter__id": 1,
            "table__id": 1,
            "variable__id": 1,
            "indexset": {
                "id": 1,
                "name": "string",
                "elements": 1.0,
                "run__id": 1,
                "created_at": "2024-10-03T09:17:47.160705",
                "created_by": "string"
            },
            "constrained_to_indexset": 1,
            "unique": true
        }
    ],
    "run__id": 1,
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

PATCH /optimization/variables/{variable_id}/data/

Add Data

ixmp4.server.rest.optimization.variable.add_data()

Parameters:

variable_id (integer)
platform (string)

Example request:

PATCH /optimization/variables/{variable_id}/data/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": {}
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /optimization/variables/{variable_id}/data/

Remove Data

ixmp4.server.rest.optimization.variable.remove_data()

Parameters:

variable_id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

regions

PATCH /regions/

Query

ixmp4.server.rest.region.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /regions/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "hierarchy": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "hierarchy__in": [
        "string"
    ],
    "hierarchy__like": "string",
    "hierarchy__ilike": "string",
    "hierarchy__notlike": "string",
    "hierarchy__notilike": "string",
    "iamc": {
        "id": 1,
        "name": "string",
        "hierarchy": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "hierarchy__in": [
            "string"
        ],
        "hierarchy__like": "string",
        "hierarchy__ilike": "string",
        "hierarchy__notlike": "string",
        "hierarchy__notilike": "string",
        "variable": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "unit": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "run": {
            "id": 1,
            "version": 1,
            "default_only": true,
            "is_default": true,
            "model": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "scenario": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "id__in": [
                1
            ],
            "version__in": [
                1
            ],
            "version__gt": 1,
            "version__lt": 1,
            "version__gte": 1,
            "version__lte": 1
        }
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /regions/

Create

ixmp4.server.rest.region.create()

Parameters:

platform (string)

Example request:

POST /regions/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "hierarchy": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "hierarchy": "string",
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /regions/{id}/

Delete

Parameters:

id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

runs

PATCH /runs/

Query

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /runs/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "version": 1,
    "default_only": true,
    "is_default": true,
    "model": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "scenario": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string"
    },
    "id__in": [
        1
    ],
    "version__in": [
        1
    ],
    "version__gt": 1,
    "version__lt": 1,
    "version__gte": 1,
    "version__lte": 1,
    "iamc": {
        "region": {
            "id": 1,
            "name": "string",
            "hierarchy": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string",
            "hierarchy__in": [
                "string"
            ],
            "hierarchy__like": "string",
            "hierarchy__ilike": "string",
            "hierarchy__notlike": "string",
            "hierarchy__notilike": "string"
        },
        "variable": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "unit": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        }
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /runs/

Create

Parameters:

platform (string)

Example request:

POST /runs/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "model_name": "string",
    "scenario_name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "model": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "model__id": 1,
    "scenario": {
        "id": 1,
        "name": "string",
        "created_at": "2024-10-03T09:17:47.160705",
        "created_by": "string"
    },
    "scenario__id": 1,
    "version": 1,
    "is_default": true
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /runs/{id}/set-as-default-version/

Set As Default Version

Parameters:

id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /runs/{id}/unset-as-default-version/

Unset As Default Version

Parameters:

id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

scenarios

PATCH /scenarios/

Query

ixmp4.server.rest.scenario.query()

Parameters:

platform (string)

Query Parameters:

table ({'null', 'boolean'})
limit (integer)
offset (integer)

Example request:

PATCH /scenarios/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "iamc": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "region": {
            "id": 1,
            "name": "string",
            "hierarchy": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string",
            "hierarchy__in": [
                "string"
            ],
            "hierarchy__like": "string",
            "hierarchy__ilike": "string",
            "hierarchy__notlike": "string",
            "hierarchy__notilike": "string"
        },
        "variable": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "unit": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "run": {
            "id": 1,
            "version": 1,
            "default_only": true,
            "is_default": true,
            "model": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "scenario": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "id__in": [
                1
            ],
            "version__in": [
                1
            ],
            "version__gt": 1,
            "version__lt": 1,
            "version__gte": 1,
            "version__lte": 1
        }
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /scenarios/

Create

ixmp4.server.rest.scenario.create()

Parameters:

platform (string)

Example request:

POST /scenarios/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

units

PATCH /units/

Query

ixmp4.server.rest.unit.query()

Parameters:

platform (string)

Query Parameters:

table (boolean)
limit (integer)
offset (integer)

Example request:

PATCH /units/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "id__in": [
        1
    ],
    "name__in": [
        "string"
    ],
    "name__like": "string",
    "name__ilike": "string",
    "name__notlike": "string",
    "name__notilike": "string",
    "iamc": {
        "id": 1,
        "name": "string",
        "id__in": [
            1
        ],
        "name__in": [
            "string"
        ],
        "name__like": "string",
        "name__ilike": "string",
        "name__notlike": "string",
        "name__notilike": "string",
        "variable": {
            "id": 1,
            "name": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string"
        },
        "region": {
            "id": 1,
            "name": "string",
            "hierarchy": "string",
            "id__in": [
                1
            ],
            "name__in": [
                "string"
            ],
            "name__like": "string",
            "name__ilike": "string",
            "name__notlike": "string",
            "name__notilike": "string",
            "hierarchy__in": [
                "string"
            ],
            "hierarchy__like": "string",
            "hierarchy__ilike": "string",
            "hierarchy__notlike": "string",
            "hierarchy__notilike": "string"
        },
        "run": {
            "id": 1,
            "version": 1,
            "default_only": true,
            "is_default": true,
            "model": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "scenario": {
                "id": 1,
                "name": "string",
                "id__in": [
                    1
                ],
                "name__in": [
                    "string"
                ],
                "name__like": "string",
                "name__ilike": "string",
                "name__notlike": "string",
                "name__notilike": "string"
            },
            "id__in": [
                1
            ],
            "version__in": [
                1
            ],
            "version__gt": 1,
            "version__lt": 1,
            "version__gte": 1,
            "version__lte": 1
        }
    }
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pagination": {
        "limit": 1,
        "offset": 1
    },
    "total": 1,
    "results": {
        "index": [
            {}
        ],
        "columns": [
            "string"
        ],
        "dtypes": [
            "string"
        ],
        "data": [
            {}
        ]
    }
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

POST /units/

Create

Parameters:

platform (string)

Example request:

POST /units/ HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "string",
    "created_at": "2024-10-03T09:17:47.160705",
    "created_by": "string"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

DELETE /units/{id}/

Delete

Parameters:

id (integer)
platform (string)

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Request Headers:

authorization

default

GET /

Root

Parameters:

platform (string)

Example request:

GET / HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful Response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "string",
    "version": "string",
    "is_managed": true,
    "manager_url": "string",
    "utcnow": "2024-10-03T09:17:47.160705"
}

422 Unprocessable Entity –

Validation Error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
    "detail": [
        {
            "loc": [
                "string",
                1
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}