Get Problem

Get the model of a specific problem.

Args: request (ProblemGetRequest): the request containing the problem's id problem_id. user (Annotated[User, Depends): the current user. session (Annotated[Session, Depends): the database session.

Raises: HTTPException: could not find a problem with the given id.

Returns: ProblemInfo: detailed information on the requested problem.

post/problem/get

Request body

problem_idinteger required

Response

Successful Response

namestring required
descriptionstring required
is_convexboolean nullable required
is_linearboolean nullable required
is_twice_differentiableboolean nullable required
scenario_keysstring[] nullable required
variable_domain'continuous' | 'binary' | 'integer' | 'mixed' required

An enumerator for the possible variable type domains of a problem.

idinteger required
user_idinteger required
objectivesObjectiveDB[] required— unresolved $ref
constraintsConstraintDB[] nullable required— unresolved $ref
extra_funcsExtraFunctionDB[] nullable required— unresolved $ref
simulatorsSimulatorDB[] nullable required— unresolved $ref

Changes

Changed in 2 of the 2 revisions of this API.3124

  • c24fa4e23380212See the full diff
    • the response property simulators/anyOf[subschema #1]/items/file became optional for the status 200

      response-property-became-optional

    • response property simulators/anyOf[subschema #1]/items/file list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • the endpoint scheme security APIKeyCookie was added to the API

      api-security-added

    • added the optional property simulators/anyOf[subschema #1]/items/url to the response with the 200 status

      response-optional-property-added

    • added Tensor to the tensor_variables/anyOf[subschema #1]/items/initial_values response property anyOf list for the response status 200

      response-property-any-of-added

    • added Tensor to the tensor_variables/anyOf[subschema #1]/items/lowerbounds response property anyOf list for the response status 200

      response-property-any-of-added

    • added Tensor to the tensor_variables/anyOf[subschema #1]/items/upperbounds response property anyOf list for the response status 200

      response-property-any-of-added

    • added Url to the constraints/anyOf[subschema #1]/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-added

    • added Url to the extra_funcs/anyOf[subschema #1]/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-added

    • added Url to the objectives/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-added

    • removed Tensor-Output from the tensor_variables/anyOf[subschema #1]/items/initial_values response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Tensor-Output from the tensor_variables/anyOf[subschema #1]/items/lowerbounds response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Tensor-Output from the tensor_variables/anyOf[subschema #1]/items/upperbounds response property anyOf list for the response status 200

      response-property-any-of-removed

    • added the required property problem_metadata to the response with the 200 status

      response-required-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bbcc40488a721112See the full diff
    • removed the required property problem_metadata from the response with the 200 status

      response-required-property-removed

    • removed the optional property simulators/anyOf[subschema #1]/items/url from the response with the 200 status

      response-optional-property-removed

    • the endpoint scheme security APIKeyCookie was removed from the API

      api-security-removed

    • added Tensor-Output to the tensor_variables/anyOf[subschema #1]/items/initial_values response property anyOf list for the response status 200

      response-property-any-of-added

    • added Tensor-Output to the tensor_variables/anyOf[subschema #1]/items/lowerbounds response property anyOf list for the response status 200

      response-property-any-of-added

    • added Tensor-Output to the tensor_variables/anyOf[subschema #1]/items/upperbounds response property anyOf list for the response status 200

      response-property-any-of-added

    • removed Tensor from the tensor_variables/anyOf[subschema #1]/items/initial_values response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Tensor from the tensor_variables/anyOf[subschema #1]/items/lowerbounds response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Tensor from the tensor_variables/anyOf[subschema #1]/items/upperbounds response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Url from the constraints/anyOf[subschema #1]/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Url from the extra_funcs/anyOf[subschema #1]/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-removed

    • removed Url from the objectives/items/simulator_path response property anyOf list for the response status 200

      response-property-any-of-removed

    • the response property simulators/anyOf[subschema #1]/items/file became required for the status 200

      response-property-became-required

    • response property simulators/anyOf[subschema #1]/items/file list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    This revision also has 103 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog