Frameworks

Get framework tree

Changed on

Returns the framework metadata (id, key, framework_type, display_name, entity_types, hierarchy_type) and the full structure tree with the project's implementation rows. Generic endpoint for the bundled frameworks declared in Servers/structures.

get/frameworks/{frameworkId}/tree/{projectId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/frameworks/{frameworkId}/tree/{projectId}
  • Auth
    HTTP bearer

Path parameters

frameworkIdinteger required

Framework id (the bundled frameworks use ids 5-25)

projectIdinteger required

Project (use case) id, or the organizational project id

Response

Framework tree

Changes

  • 31b735271fdaRevision changes
    • breaking

      added the new path request parameter frameworkId

    • breaking

      added the new path request parameter projectId

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 15960a278de3Revision changes
    • info

      endpoint added