AHaha
Custom Layouts

Get a custom layout by ID

Changed on

Custom layouts in Aha! Roadmaps help you define the information that you want your teammates to see at two important times: when they create a record and when they view a record's details. You must be a configuration administrator to view custom layouts on your account through the API.

For more information about custom layouts, consult our support documentation: https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-layouts

get/screen_definitions/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Response

Successful operation

idinteger
screenable_typestring
namestring

Example response

{
  "id": 19837977,
  "screenable_type": "Feature",
  "name": "Screen Definition 6",
  "custom_field_definitions": [
    {
      "required": false,
      "id": 839883647,
      "key": "custom_scorecard_definition",
      "position": 3,
      "name": "Some custom scorecard definition",
      "type": "CustomFieldDefinitions::ScorecardField",
      "api_type": "scorecard",
      "can_be_required_on_form": true
    },
    {
      "required": false,
      "id": 182007396,
      "key": "custom_table",
      "position": 7,
      "name": "Custom Table",
      "type": "CustomFieldDefinitions::LinkMasterDetail",
      "api_type": "array",
      "can_be_required_on_form": true
    },
    {
      "required": false,
      "id": 20549131,
      "key": "customer",
      "position": 2,
      "name": "Customer",
      "type": "CustomFieldDefinitions::SelectEditable",
      "api_type": "string",
      "can_be_required_on_form": true,
      "configuration_display": null,
      "options": [
        {
          "id": 106870231,
          "label": "cust1"
        },
        {
          "id": 525853807,
          "label": "cust2"
        },
        {
          "id": 676386040,
          "label": "cust3"
        }
      ]
    },
    {
      "required": false,
      "id": 141558949,
      "key": "customers_table",
      "position": 1,
      "name": "Customers for custom table",
      "type": "CustomFieldDefinitions::LinkMany",
      "api_type": "array",
      "can_be_required_on_form": true
    },
    {
      "required": false,
      "id": 599758071,
      "key": "equation_custom_field",
      "position": 1,
      "name": "Equation custom field",
      "type": "CustomFieldDefinitions::EquationField",
      "api_type": "equation_sheet",
      "worksheet_rows": [
        {
          "id": "6651670327076753738",
          "name": "Revenue",
          "type": "number",
          "format": "currency",
          "equation": null
        },
        {
          "id": "6651670366942086967",
          "name": "Expenses",
          "type": "number",
          "format": "currency",
          "equation": null
        },
        {
          "id": "6651670393424268679",
          "name": "Profit",
          "type": "number",
          "format": "currency",
          "equation": "field(\"Revenue\") - field(\"Expenses\")"
        }
      ],
      "can_be_required_on_form": true
    },
    {
      "required": false,
      "id": 384804762,
      "key": "product_managers",
      "position": 7,
      "name": "Product Managers",
      "type": "CustomFieldDefinitions::Records::UsersField",
      "api_type": "array",
      "can_be_required_on_form": true
    }
  ]
}

Changes