Element API (v7.0.1+)

This article describes API calls available for managing Elements in the Metric Insights Catalog. The response can be parsed to populate objects with information specific to one or more element IDs:

  • /api/element: Returns all Elements available to a user, including options to include hidden items, Folder associations, Tags, and Glossary Terms.
  • /api/element_info: Provides detailed information for all or selected Elements, with support for filtering by Category, Owner, Tag, or Dimension values.
    • PUT requests to /api/element_info: Allow updates to Element properties such as Name, Description, Certification, Dashboard visibility, Ownership, and Discoverability, as well as adding Elements to Publishing Workflows or requesting access.

NOTES:

Prerequisites:

Table of contents:  

  1. Access Admin > System > API Toolkit
  2. Get Elements Available to User
  3. Get All Elements
  4. Get Elements Available to User And Folder Items
  5. Get Elements Available to User And Folder Items Including Hidden Folders
  6. Get Elements Available to User, Tags, and Glossary Terms
  7. Get Element Info
  8. Update Element Info
    1. Update Element Name
    2. Update Element Description
    3. Update Element Certification
    4. Add Element To Publishing Workflow
    5. Request Access to Element
    6. Set Element's Visibility in Dashboard
    7. Set Element's Ownership
    8. Set Element's Discoverability for Users Without Access

1. Access Admin > System > API Toolkit

2. Get Elements Available to User

The GET request to /api/element returns all elements available to the user.

  1. Item: element
  2. Enter an API Token
  3. [Run request]
  4. The returned object contains an array of objects representing all elements available to the user who executes the API call.
Example Response

This example demonstrates an object which represents a single element.

{
      "user_dashboard_element_instance_id": 787083,
      "user_id": 118,
      "element_id": 152742,
      "segment_value_id": 0,
      "section_type": "Category",
      "favorite_id": 0,
      "category_id": 123,
      "element_type": "metric",
      "in_dashboard_ind_flag": "Y",
      "last_stoplight_value": 0,
      "is_expired": 0,
      "is_tech_editor": "Y",
      "is_owned": 1,
      "topics": null,
      "refresh_frequency_text": "Daily",
      "refresh_frequency_sec": 86400,
      "description_markdown_ind": "N",
      "element_info": "Fruit Sales Italy In Store Metric",
      "metric_unit_of_measure": null,
      "last_measurement_time": "2025-07-18 00:00:00",
      "external_report_download_url_info": null,
      "certified_ind": "N",
      "certification_level_id": null,
      "last_certified_time": null,
      "metric_display_on_tile": "value",
      "metric_moving_average_interval": "30 day",
      "metric_display_on_tile_prefix": "Avg",
      "metric_home_page_compare_value_type": "last value",
      "metric_home_page_compare_line_id": null,
      "metric_home_page_compare_target_id": null,
      "report_single_unit_label": null,
      "report_multiple_units_label": null,
      "report_no_units_label": null,
      "report_on_demand_generation_ind": "Y",
      "external_report_display": null,
      "external_report_url": null,
      "publicly_visible_ind": "N",
      "certification_level_name": null,
      "certification_level_color": null,
      "last_certified_by_name": null,
      "last_certified_by_email": null,
      "business_owner": "Anna Kennedy",
      "business_owner_email": "[email protected]",
      "data_steward": null,
      "data_steward_email": null,
      "technical_owner": "[email protected] ",
      "technical_owner_email": "[email protected]",
      "data_source_name": "Dataset",
      "supports_last_refreshed_check": null,
      "display_order": 1000000,
      "total_view_count": null,
      "in_favorites": null,
      "is_in_favorites": 0,
      "is_in_folders": 0,
      "mi_name": "Daily",
      "mi_sequence": 30,
      "pct_variance_text": "from last day",
      "last_measurement_value_formatted": "1,184",
      "last_measurement_time_formatted": "Friday 07/18/2025",
      "metric_last_moving_average_value_formatted": "1,106",
      "last_updated_time": "2025-07-18 12:11:27",
      "total_forecast_amount_formatted": null,
      "last_activity_time": null,
      "last_annotation_text": null,
      "last_commentary_text": null,
      "element_dashboard_name": "Fruit Sales Italy In Store",
      "element_dashboard_name_with_formatting": "[\"[e]\", \"Fruit Sales Italy In Store\"]",
      "is_empty_instance_ind": "N",
      "metric_tile_display_pct_variance": 22.6943,
      "report_rows": null,
      "last_display_generation_time": "",
      "last_file_updated_time": "",
      "last_modified": "unknown",
      "favorite_content": null,
      "reporting_tool_name": null,
      "remove_preview_link_ind": null,
      "external_content_type_name": null,
      "enable_click_in_mobile_ind": null,
      "content_type": "Metric",
      "global_total_view_count": null,
      "has_access": "Y"
}

Fields Description

This description covers only the fields that contain information useful for Portal Page development, the fields that are not covered are for internal use only.

 

Field Name Value Type Description
business_owner string
The name of the Element Business Owner.
business_owner_email string
The email of the Element Business Owner.
category_id integer
The ID of the element's category.
certification_level_color string
The hex value of the certification level color.
certification_level_id string
The ID of the certification level.
certification_level_name string
The name of the certification level.
certified_ind string
Whether or not the element is certified. Takes value “Y” if the element is certified, “N” - if not.
content_type string
The type of the content.
data_source_name string
The name of the data source from which the element is populated.
data_steward string
The name of the element's Data Steward.
data_steward_email string
The email of the element's Data Steward.
description_markdown_ind string
Whether or not markdown is applied to the element's description. Takes value “Y” if markdown is enabled, “N” - if not.
element_dashboard_name string
The name of the element.
element_id integer
The ID of the element.
element_type string
The type of the element.
enable_click_in_mobile_ind string
If the element is an External Report or External Content, defines whether or not the “Enable click-through” option is activated for its content type.
external_content_type_name string
If the element is an External Content, describes its type.
external_report_display string
If the element is an External Report, describes its display options.
external_report_download_url_info object
Information about element download.
favorite_content string
The type of favorite content.
favorite_id integer
The IDs of the element instances in favorites.
folder_id array
An array of folders where the element is present.
global_total_view_count string
The engagement count of the element.
has_access string
Whether or not the user who ran the API request has access to the element.
in_dashboard_ind_flag string
Whether or not the element is displayed on the dashboard.
in_favorites string
The IDs of favorites where the element is present.
is_empty_instance_ind string
Whether or not the last instance of the report is empty.
is_expired string
Whether or not the element is expired.
is_in_favorites string
Whether or not the element is in favorites. Takes value “1” if the element is in favorites, “0” - if not.
is_in_folders string
Whether or not the element is in any folder. Takes value “1” if the element is in any folder, “0” - if not.
is_owned string
Whether or not the element has an owner. Takes value “1” if the element has an owner, “0” - if not.
is_tech_editor string
Whether or not the user who ran the API request can edit the element. Takes value “1” if the user who ran the API request can edit the element, “0” - if not.
last_activity_time string
The date and time of the last element activity.
last_annotation_text string
The text of the last annotation.
last_certified_by_email string
The email of the user who certified the element.
last_certified_by_name string
The name of the user who certified the element.
last_certified_time string
The date and time of the last certification of the element.
last_commentary_text string
The text of the last comment.
last_updated_time string
The date and time of the last element update.
metric_last_moving_average_value_formatted string
The last collected value of a metric.
metric_tile_display_pct_variance float
The percentage ratio between the two latest metric values.
refresh_frequency_sec integer
The frequency of element refresh in seconds.
reporting_tool_name string
If the element is an External Report, displays the name of the BI tool from which the element is populated.
segment_value_id integer
The dimension value of the element.
technical_owner string
The element's Technical Owner.
technical_owner_email string
The email of the element's Technical Owner.
topics array
An array of the element's tags' IDs.
total_view_count string
The engagement count of the element.
user_dashboard_element_instance_id integer
A unique ID of the element record.
user_id integer
The ID of the user

3. Get All Elements

The GET request to /api/element?show_hidden_from_homepage=Y returns all MI elements: both available to the user and hidden.

  1. Item: element
  2. show_hidden_from_homepage: Y
  3. Enter an API Token
  4. [Run request]
  5. See Example Response  and Fields Description for details on the returned object

4. Get Elements And Folder Items Available to User

The GET request to /api/element?folder_items=Y returns all MI elements  available to the user and folder items.

  1. Item: element
  2. folder_items: Y
  3. Enter an API Token
  4. [Run request]
  5. The returned object contains two arrays of objects:
Example Response 
{
  elements: [
    {
      "user_dashboard_element_instance_id": 787083,
      "user_id": 118,
      "element_id": 152742,
      "segment_value_id": 0,
      "section_type": "Category",
      "favorite_id": 0,
      "category_id": 123,
      "element_type": "metric",
      "in_dashboard_ind_flag": "Y",
      "last_stoplight_value": 0,
      "is_expired": 0,
      "is_tech_editor": "Y",
      "is_owned": 1,
      "topics": null,
      "refresh_frequency_text": "Daily",
      "refresh_frequency_sec": 86400,
      "description_markdown_ind": "N",
      "element_info": "Fruit Sales Italy In Store Metric",
      "metric_unit_of_measure": null,
      "last_measurement_time": "2025-07-18 00:00:00",
      "external_report_download_url_info": null,
      "certified_ind": "N",
      "certification_level_id": null,
      "last_certified_time": null,
      "metric_display_on_tile": "value",
      "metric_moving_average_interval": "30 day",
      "metric_display_on_tile_prefix": "Avg",
      "metric_home_page_compare_value_type": "last value",
      "metric_home_page_compare_line_id": null,
      "metric_home_page_compare_target_id": null,
      "report_single_unit_label": null,
      "report_multiple_units_label": null,
      "report_no_units_label": null,
      "report_on_demand_generation_ind": "Y",
      "external_report_display": null,
      "external_report_url": null,
      "publicly_visible_ind": "N",
      "certification_level_name": null,
      "certification_level_color": null,
      "last_certified_by_name": null,
      "last_certified_by_email": null,
      "business_owner": "Anna Kennedy",
      "business_owner_email": "[email protected]",
      "data_steward": null,
      "data_steward_email": null,
      "technical_owner": "[email protected] ",
      "technical_owner_email": "[email protected]",
      "data_source_name": "Dataset",
      "supports_last_refreshed_check": null,
      "display_order": 1000000,
      "total_view_count": null,
      "in_favorites": null,
      "is_in_favorites": 0,
      "is_in_folders": 0,
      "mi_name": "Daily",
      "mi_sequence": 30,
      "pct_variance_text": "from last day",
      "last_measurement_value_formatted": "1,184",
      "last_measurement_time_formatted": "Friday 07/18/2025",
      "metric_last_moving_average_value_formatted": "1,106",
      "last_updated_time": "2025-07-18 12:11:27",
      "total_forecast_amount_formatted": null,
      "last_activity_time": null,
      "last_annotation_text": null,
      "last_commentary_text": null,
      "element_dashboard_name": "Fruit Sales Italy In Store",
      "element_dashboard_name_with_formatting": "[\"[e]\", \"Fruit Sales Italy In Store\"]",
      "is_empty_instance_ind": "N",
      "metric_tile_display_pct_variance": 22.6943,
      "report_rows": null,
      "last_display_generation_time": "",
      "last_file_updated_time": "",
      "last_modified": "unknown",
      "favorite_content": null,
      "reporting_tool_name": null,
      "remove_preview_link_ind": null,
      "external_content_type_name": null,
      "enable_click_in_mobile_ind": null,
      "content_type": "Metric",
      "global_total_view_count": null,
      "has_access": "Y"
    }
  ],
  folderItems: [
    {
      "folder_item_id": 14761087,
      "folder_id": 279,
      "element_id": 176,
      "segment_value_id": 0,
      "display_order": 14"
    }
  ]
}

Fields Description

Fields related to the elements were previously described in the prior Fields Description section. Here you can find the description of the fields related to Folder items.

Field Name Value Type Description
folder_item_id integer The ID of the Folder item unique for each element.
folder_id integer
 The ID of the Folder.
element_id integer
 The ID of the element.
segment_value_id integer
 The dimension value of the element.
display_order integer
 The order in which the element is displayed in the Folder.

5. Get Elements And Folder Items Available to User Including Hidden Folders

The GET request to /api/element?folder_items=Y&all_folders=Y returns all MI elements  available to the user and folder items, including items from hidden folders.

  1. Item: element
  2. folder_items: Y
  3. all_folders: Y
  4. Enter an API Token
  5. [Run request]
  6. The returned object contains an array of objects representing all elements available to the user and all Folder items, including items from the Folders not displayed on the Homepage.

6. Get Elements Available to User, Their Tags, and Glossary Terms

The GET request to /api/element?with_topics=Y returns all elements available to the user, their tags and glossary terms.

  1. Item: element
  2. with_topics: Y
  3. Enter an API Token
  4. [Run request]
  5. See Example Response  and Fields Description for details on the returned data
Example Response 
{
  elements:
  [
    {
      "user_dashboard_element_instance_id": 787083,
      "user_id": 118,
      "element_id": 152742,
      "segment_value_id": 0,
      "section_type": "Category",
      "favorite_id": 0,
      "category_id": 123,
      "element_type": "metric",
      "in_dashboard_ind_flag": "Y",
      "last_stoplight_value": 0,
      "is_expired": 0,
      "is_tech_editor": "Y",
      "is_owned": 1,
      "topics": null,
      "refresh_frequency_text": "Daily",
      "refresh_frequency_sec": 86400,
      "description_markdown_ind": "N",
      "element_info": "Fruit Sales Italy In Store Metric",
      "metric_unit_of_measure": null,
      "last_measurement_time": "2025-07-18 00:00:00",
      "external_report_download_url_info": null,
      "certified_ind": "N",
      "certification_level_id": null,
      "last_certified_time": null,
      "metric_display_on_tile": "value",
      "metric_moving_average_interval": "30 day",
      "metric_display_on_tile_prefix": "Avg",
      "metric_home_page_compare_value_type": "last value",
      "metric_home_page_compare_line_id": null,
      "metric_home_page_compare_target_id": null,
      "report_single_unit_label": null,
      "report_multiple_units_label": null,
      "report_no_units_label": null,
      "report_on_demand_generation_ind": "Y",
      "external_report_display": null,
      "external_report_url": null,
      "publicly_visible_ind": "N",
      "certification_level_name": null,
      "certification_level_color": null,
      "last_certified_by_name": null,
      "last_certified_by_email": null,
      "business_owner": "Anna Kennedy",
      "business_owner_email": "[email protected]",
      "data_steward": null,
      "data_steward_email": null,
      "technical_owner": "[email protected] ",
      "technical_owner_email": "[email protected]",
      "data_source_name": "Dataset",
      "supports_last_refreshed_check": null,
      "display_order": 1000000,
      "total_view_count": null,
      "in_favorites": null,
      "is_in_favorites": 0,
      "is_in_folders": 0,
      "mi_name": "Daily",
      "mi_sequence": 30,
      "pct_variance_text": "from last day",
      "last_measurement_value_formatted": "1,184",
      "last_measurement_time_formatted": "Friday 07/18/2025",
      "metric_last_moving_average_value_formatted": "1,106",
      "last_updated_time": "2025-07-18 12:11:27",
      "total_forecast_amount_formatted": null,
      "last_activity_time": null,
      "last_annotation_text": null,
      "last_commentary_text": null,
      "element_dashboard_name": "Fruit Sales Italy In Store",
      "element_dashboard_name_with_formatting": "[\"[e]\", \"Fruit Sales Italy In Store\"]",
      "is_empty_instance_ind": "N",
      "metric_tile_display_pct_variance": 22.6943,
      "report_rows": null,
      "last_display_generation_time": "",
      "last_file_updated_time": "",
      "last_modified": "unknown",
      "favorite_content": null,
      "reporting_tool_name": null,
      "remove_preview_link_ind": null,
      "external_content_type_name": null,
      "enable_click_in_mobile_ind": null,
      "content_type": "Metric",
      "global_total_view_count": null,
      "has_access": "Y"
    }
  ],
  topics: [
    {
      "topic_id": 223,
      "topic_type_id": 55,
      "name": "Robert New Term for Docs",
      "definition": "Some text...",
      "description": "This is description of my section",
      "business_owner_id": 118,
      "technical_owner_id": 118,
      "data_steward_id": null,
      "created_by": "robert",
      "created_time": "2023-10-18 16:50:40",
      "last_updated_by": "[email protected]",
      "last_updated_time": "2025-07-18 13:13:49",
      "is_parent_topic": "N",
      "parent_topic_id": null,
      "is_governed_ind": "Y",
      "created_by_id": 0,
      "additional_metadata": "sales, food, Italy, in store, recent sales",
      "topic_type_name": "Robert Section",
      "use_icon": "uploaded",
      "icon_type": "image/png",
      "icon": "iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAACXBIWXMAAA7EAAAOxAGVKw4bAAADKUlEQVQoFQEeA+H8Af////8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAKmpqQCGhoYAAAAAAAAAAAAAAAAAAAAAAAAAAACpqakAhoaGAAAAAAAAAAAAAP///////////////4WFhf8AAAD///////////////////////////+FhYX/AAAA////////////Af////8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAri4uABBQUEAmJiYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAgIP8AAAD/AAAA/39/f////////////////////////////7e3t/8gICD/ICAg/5+fn///////AHBwcP8AAAD/AAAA/wAAAP8gICD/n5+f/////////////////xgYGP8AAAD/AAAA/wgICP//////APf39/9ISEj/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/2hoaP//////AP/////39/f/YGBg/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA////////////AP///////////////4eHh/8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/aGho////////////Af////8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAArMTblUXmdZsAAAAASUVORK5CYII=",
      "fa_icon": null,
      "child_topics": "",
      "full_name": "Robert New Term for Docs"
    }
  ]
}

Fields Description

See Example Response for the description of Element-related fields. The table provided here is describing fields related to Tags and Glossary Terms.

 

Field Name Value Type Description
additional_metadata string A string with the tag’s additional metadata.
business_owner_id integer
The ID of the business owner.
created_by string
The Username of the user who created the tag or glossary term.
created_by_id string
The ID of the user who created the tag or glossary term.
created_time string
Date and time of tag's or glossary term's creation.
data_steward_id integer
The ID of the data steward.
definition string
Definition of the glossary term.
description string
Description of the glossary term.
fa_icon string
The description of the favicon.
full_name string
The name of the tag or glossary term.
icon string
The base64 representation of the uploaded icon.
icon_type string
The type of icon of the glossary term.
is_governed_ind string
Whether or not the element is a Glossary Term.
last_updated_by string
The Username of the last user who updated the tag or glossary term.
last_updated_time string
Date and time of the last update.
name string
The name of the tag or glossary term.
technical_owner_id integer
The ID of the technical owner.
topic_id integer
The ID of the tag or glossary term.
topic_type_id integer
The ID of the glossary section. If the element is tag, takes value 0.
topic_type_name string
The name of the glossary section.
use_icon string
Whether the glossary term has a favicon, an uploaded icon, or no icon at all.

7. Get Element Info

  • The GET request to /api/element_info returns all elements' data
  • The GET request to /api/element_info?element=<Element ID> returns the selected element's data
  1. Item: element_info
  2. Methods: GET
  3. Optionally, filter the results by:
    • element (integer): The ID of the Element
    • dimension_value (string): The dimension value of the Element
    • category (integer): The ID of the Category
    • category_name (string): The name of the Category
    • business_owner (integer): The ID of the Business Owner
    • business_owner_username (string): The username of the Business Owner
    • business_owner_email (string): The email of the Business Owner
    • tag (integer): The ID of the Tag or Glossary Term
    • tag_name (string): The name of the Tag or Glossary Term
  4. Additional filters available:
    • jwt (string): Whether to include a JWT token in the response ('Y' or 'N')
    • access_request_info (string): Whether to include element's access request information
  5. Enter an API Token
  6. [Run request]
  7. The returned object contains an array of objects representing elements
Example Response 
{
    "info": [
         {
      "id": 152666,
      "dimension_value": 0,
      "name": "Microsoft Power BI Demo External Report for Documentation",
      "description": "Demo External Report for Documentation",
      "last_updated_time": "2025-04-05 23:46:58",
      "content_type": "Microsoft Power BI",
      "element_type": "external report",
      "category": 123,
      "in_dashboard_ind_flag": "Y",
      "business_owner_enabled": "Y",
      "business_owner_label": "Business Owner",
      "business_owner_name": "Anna Kennedy",
      "business_owner_email": "[email protected]",
      "technical_owner_enabled": "Y",
      "technical_owner_label": "Technical Owner",
      "technical_owner_name": "Anna Kennedy",
      "technical_owner_email": "[email protected]",
      "data_steward_enabled": "Y",
      "data_steward_label": "Data Steward",
      "data_steward_name": null,
      "data_steward_email": null,
      "plugin_connection_profile_id": 174,
      "plugin_internal_name": "powerbi",
      "external_report_url": "https://app.powerbi.com/groups/c5e9d464-329d-4bd8-846f-6c21e484cafc/reports/54ef4905-c8da-4808-a9c6-4145c612fe3b/a68012212f46bb908e7e",
      "certified_ind": "N",
      "certified_by": null,
      "certification_level": null,
      "certification_color": null,
      "certification_description": null,
      "last_certified_time": "0000-00-00 00:00:00",
      "last_measurement_time": null,
      "external_report_display": "external",
      "publicly_visible_ind": "Y",
      "tags": {
        "220": "docs"
      }
    }
  ]
}

Fields Description

 

Field Name Value Type Description
id integer
The ID of the element.
dimension_value integer
The dimension value for filtering.
name string
The name of the element.
description string
The description of the element.
last_updated_time string
The last time the element was updated.
content_type string
The type of content associated with the element.
element_type string
The type of the element.
category integer
The unique identifier of the category.
in_dashboard_ind_flag string
Whether the element is displayed on the dashboard. ('Y' or 'N')
business_owner_enabled string
Whether the business owner is enabled. ('Y' or 'N')
business_owner_label string
The label for the business owner.
business_owner_name string
The name of the business owner.
business_owner_email string
The email of the business owner.
technical_owner_enabled string
Whether the technical owner is enabled. ('Y' or 'N')
technical_owner_label string
The label for the technical owner.
technical_owner_name string
The name of the technical owner.
technical_owner_email string
The email of the technical owner.
data_steward_enabled string
Whether the data steward is enabled. ('Y' or 'N')
data_steward_label string
The label for the data steward.
data_steward_name string
The name of the data steward.
data_steward_email string
The email of the data steward.
plugin_connection_profile_id integer
The ID of the plugin connection profile.
plugin_internal_name string
The internal name of the plugin.
external_report_url string
The URL of the external report.
certified_ind string
Whether the element is certified. ('Y' or 'N')
certified_by string
The name of the person who certified the element.
certification_level string
The certification level of the element.
certification_color string
The color associated with the certification level.
certification_description string
The description of the certification.
last_certified_time string
The last time the element was certified.
last_measurement_time string
The last time the element was measured.
external_report_display string
Indicates how the external report is displayed.
publicly_visible_ind string
Whether the element is publicly visible. ('Y' or 'N')
tags array
The tags associated with the element. Each tag has the following structure: {tagId}: {tagName}

8. Update Element Info

8.1. Update Element Name

The PUT request to /api/element_info with body {"call": "name", "name": "<New Element Name>"} updates the element's name.

  1. Item: element_info
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Name
  5. Select JSON request and replace request with the following JSON providing the needed values:
{
    "call": "name",
    "name": "<New Element Name>"
}
  1. Enter an API Token
  2. [Run request]

8.2. Update Element Description

The PUT request to /api/element_info/id/<Element ID> with body {"call": "description", "description": "<New Element Description>"} updates the element's description.

  1. Item: element_info
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Description
  5. Select JSON request and replace request with the following JSON providing the needed values.
    • Optionally, use the description_markdown_ind parameter to specify whether to apply Markdown to the element's description:
{
    "call": "description",
    "description": "<New Element Description>",
    "description_markdown_ind": "<Y/N>" // Optional parameter
}
  1. Enter an API Token
  2. [Run request]

8.3. Update Element Certification

The PUT request to /api/element_info/id/<Element ID> with body {"call": "certify", "certified": "<Y/N>"} updates the element's description.

  1. Item: element_info
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Certify
  5. Select JSON request and replace request with the following JSON providing the needed values.
    • For MI v7.1.1+: Optionally, use the certification_level_ind parameter to specify the element's certification level:
{
    "call": "certify",
    "certified": "<Y/N>", // "Y" - the element is certified, "N" - the element is not certified
    "certification_level_ind": <Certification Level Name> // Optional parameter
}
  1. Enter an API Token
  2. [Run request]

8.4. Add Element To Publishing Workflow

The PUT request to /api/element_info/id/<Element ID> with body {"call": "content_workflow", "content_workflow_id": "<Y/N>"} updates the element's description.

  1. Item: element_info
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Publishing Workflow
  5. Select JSON request and replace request with the following JSON providing the needed values:
{
    "call": "content_workflow",
    "content_workflow_id": "<Publishing Workflow ID>"
}
  1. Enter an API Token
  2. [Run request]

8.5. Request Access to Element

The PUT request to /api/element_info/id/<Element ID> with body {"call": "request_access"} requests access to an element for the user executing the API call.

  1. Item: element_info    
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Request Access
  5. Select JSON request and replace request with the following JSON providing the needed values:
{
    "call": "request_access"
}
  1. Enter an API Token
  2. [Run request]

8.6. Set Element's Visibility in Dashboard

The PUT request to /api/element_info/id/<Element ID> with body {"call": "in_dashboard", "in_dashboard": "<Y/N>"} sets element's visibility in dashboard.

  1. Item: element_info    
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Display on Homepage
  5. Select JSON request and replace request with the following JSON providing the needed values.
{
    "call": "in_dashboard",
    "in_dashboard": "<Y/N>" // "Y" - the element is displayed on homepage, "N" - the element is not displayed on homepage
}
  1. Enter an API Token
  2. [Run request]

8.7. Set Element's Ownership

The PUT request to /api/element_info/id/<Element ID> with body {"call": "owner"} sets element's visibility in dashboard.

  1. Item: element_info    
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Owner
  5. Select JSON request and replace request with the following JSON providing the needed values.
    • Optional parameters: business_owner_id, technical_owner_id, data_steward_id:
{
    "call": "owner",
    "business_owner_id": <Business Owner ID>,
    "technical_owner_id": <Technical Owner ID>,
    "data_steward_id": <Data Steward ID>
}
  1. Enter an API Token
  2. [Run request]

8.8. Set Element's Discoverability for Users Without Access

The PUT request to /api/element_info/id/<Element ID> with body {"call": "publicly_visible", "publicly_visible": "<Y/N>"} sets element's discoverability for users without access.

  1. Item: element_info    
  2. Methods: PUT
  3. Enter ID of the Element
  4. Actions: Discoverable
  5. Select JSON request and replace request with the following JSON providing the needed values:
{
    "call": "publicly_visible",
    "publicly_visible": "<Y/N>" // Whether to make the element discoverable to Users without access
}
  1. Enter an API Token
  2. [Run request]