---
title: Metadata
slug: neurons-for-itsm/admin-user-help/enu/latest/metadata
createdAt: 2026-07-14T19:16:52.988Z
---

Fetches details such as the list of fields, relationships, fields of related business objects, saved search names, template names and quick action names for a business object.

## Reading the Metadata

In the response returned after executing the Metadata API, details are grouped under different OData elements, such as the **NavigationProperty** element contains the Relationship details, **Actions** element contains either template or quick action details.

The following table lists the OData elements mapped to ISM elements.

| OData Standard Element | ISM Specific Element        |
| ---------------------- | --------------------------- |
| NavigationProperty     | Relationships               |
| Actions                | Templates and Quick Actions |
| Property Name          | Fields                      |
| Function               | Saved Search                |

**Base URL:**

https\://\{tenant url}/api/odata/\{business object name}/$metadata

:::hint{type="info"}
Ensure the business object name is suffixed with an "s".
:::

:::ExpandableHeading
## Metadata - Example

Here is an example to fetch the metadata for incidents.

| URL                                           | https\://\{tenant url}/api/odata/incidents/$metadata                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <font color="#0C121D">Method</font>           | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Header Name                                   | Authorization: JTW Token/Session Key/REST API Key                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| <font color="#0C121D">Status Code</font>      | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| <font color="#0C121D">Response Payload</font> | `<?xml version="1.0" encoding="utf-8"?>`<br />`<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">`<br />`<edmx:DataServices>`<br />`<Schema Namespace="MetaData" xmlns="http://docs.oasis-open.org/odata/ns/edm">`<br />`<EntityType Name="frs_knowledge">`<br />`<Key>`<br />`<PropertyRef Name="RecId" />`<br />`</Key>`<br />`<Property Name="FRS_KnowledgeType" Type="Edm.String" MaxLength="30" Unicode="false" />`<br />`<Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32" Unicode="false" />`<br />`<Property Name="LastModDateTime" Type="Edm.DateTimeOffset" />`<br />`<Property Name="LastModBy" Type="Edm.String" MaxLength="200" />`<br />`<Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" />`<br />`<Property Name="CreatedBy" Type="Edm.String" MaxLength="200" />`<br />`<Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" />`<br />`<Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" />`<br />`</EntityType>`<br />`<EntityType Name="employee">`<br />`<Key>`<br />`<PropertyRef Name="RecId" />`<br />`</Key>`<br />`<EntityType Name="frs_myitem">`<br />`<Key>`<br />`<PropertyRef Name="RecId" />`<br />`</Key>`<br />`<Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32"`<br />`Unicode="false" />`<br />`<Property Name="LastModDateTime" Type="Edm.DateTimeOffset" />`<br />`<Property Name="LastModBy" Type="Edm.String" MaxLength="200" />`<br />`<Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" />`<br />`<Property Name="CreatedBy" Type="Edm.String" MaxLength="200" />`<br />`<Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" />`<br />`<Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" />`<br />`<Property Name="Owner" Type="Edm.String" MaxLength="200" />`<br />`<Property Name="OwnerTeam_Valid" Type="Edm.String" MaxLength="32"`<br />`Unicode="false" />`<br />`</EntityType>`<br />`<EntityType Name="journal">`<br />`<Key>`<br />`<Function Name="My_Team's_Active_Incidents_All_Tasks_Completed">`<br />`<Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter">`<br />`<Record>`<br />`<PropertyValue Property="DefaultValue" String="c5d882f8-918d-466a-9048-02c3449bc7f0" />`<br />`</Record>`<br />`</Annotation>`<br />`</Parameter>`<br />`<ReturnType Type="Edm.ComplexType" />`<br />`</Function>`<br />`<NavigationProperty Name="IncidentAssociatedEscalationWatch"`<br />`Type="Collection(MetaData.frs_data_escalation_watch)">`<br />`<OnDelete Action="Cascade" />`<br />`</NavigationProperty>`<br />`<NavigationProperty Name="IncidentContainsTask" Type="Collection(MetaData.task)">`<br />`<OnDelete Action="Cascade" />`<br />`</NavigationProperty>`<br />`<NavigationProperty Name="IncidentAssociatesCI" Type="Collection(MetaData.ci)">`<br />`<OnDelete Action="Cascade" />`<br />`</NavigationProperty>`<br />`<NavigationProperty Name="IncidentAssociatedSoftwareAction"`<br />`Type="Collection(MetaData.softwareaction)">`<br />`<OnDelete Action="Cascade" />`<br />`</EntityType>`<br />`<Action Name="New_Document_Article">`<br />`<Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter">`<br />`<Record>`<br />`<PropertyValue Property="DefaultValue" String="1e16a70f-cea5-4e56-bb6c-000eecfa5e42" />`<br />`</Record>`<br />`</Annotation>`<br />`</Parameter>`<br />`<Parameter Name="ActionParams" Type="Edm.ComplexType">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Parameter>`<br />`<Parameter Name="PromptParams" Type="Edm.ComplexType">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Action>`<br />`<Action Name="Create_Assignment">`<br />`<Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter">`<br />`<Record>`<br />`<PropertyValue Property="DefaultValue" String="0d260a06-d203-4c72-8929-22a09038cefc" />`<br />`</Record>`<br />`</Annotation>`<br />`</Parameter>`<br />`<Parameter Name="ActionParams" Type="Edm.ComplexType">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Action>`<br />`<Action Name="Resolve_Incident">`<br />`<Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter">`<br />`<Record>`<br />`<PropertyValue Property="DefaultValue" String="43a31840-2689-405f-88cc-a63a2539be99" />`<br />`</Record>`<br />`</Annotation>`<br />`</Parameter>`<br />`<Parameter Name="ActionParams" Type="Edm.ComplexType">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Parameter>`<br />`<Parameter Name="PromptParams" Type="Edm.ComplexType">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Parameter>`<br />`<Parameter Name="ShouldSave" Type="Edm.String" Unicode="false">`<br />`<Annotation Term="Org.OData.Core.V1.OptionalParameter" />`<br />`</Parameter>`<br />`<ReturnType Type="Edm.ComplexType" />`<br />`</Action>` |
:::