Metadata

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 ensure the business object name is suffixed with an "s" metadata example here is an example to fetch the metadata for incidents url https //{tenant url}/api/odata/incidents/$metadata \<font color="#ffffff">method\</font> get header name authorization jtw token/session key/rest api key \<font color="#ffffff">status code\</font> 200 \<font color="#ffffff">response payload\</font> click to view response payload \<?xml version="1 0" encoding="utf 8"?> \<edmx\ edmx version="4 0" xmlns\ edmx=" http //docs oasis open org/odata/ns/edmx "> \<edmx\ dataservices> \<schema namespace="metadata" xmlns=" http //docs oasis open org/odata/ns/edm "> \<entitytype name="frs knowledge"> \<key> \<propertyref name="recid" /> \</key> \<property name="frs knowledgetype" type="edm string" maxlength="30" unicode="false" /> \<property name="recid" type="edm string" nullable="false" maxlength="32" unicode="false" /> \<property name="lastmoddatetime" type="edm datetimeoffset" /> \<property name="lastmodby" type="edm string" maxlength="200" /> \<property name="createddatetime" type="edm datetimeoffset" /> \<property name="createdby" type="edm string" maxlength="200" /> \<property name="ownertype" type="edm string" maxlength="30" unicode="false" /> \<property name="owner valid" type="edm string" maxlength="32" unicode="false" /> \</entitytype> \<entitytype name="employee"> \<key> \<propertyref name="recid" /> \</key> \<entitytype name="frs myitem"> \<key> \<propertyref name="recid" /> \</key> \<property name="recid" type="edm string" nullable="false" maxlength="32" unicode="false" /> \<property name="lastmoddatetime" type="edm datetimeoffset" /> \<property name="lastmodby" type="edm string" maxlength="200" /> \<property name="createddatetime" type="edm datetimeoffset" /> \<property name="createdby" type="edm string" maxlength="200" /> \<property name="ownertype" type="edm string" maxlength="30" unicode="false" /> \<property name="owner valid" type="edm string" maxlength="32" unicode="false" /> \<property name="owner" type="edm string" maxlength="200" /> \<property name="ownerteam valid" type="edm string" maxlength="32" unicode="false" /> \</entitytype> \<entitytype name="journal"> \<key> \<function name="my team's active incidents all tasks completed"> \<parameter name="actionid" type="edm string" nullable="false" unicode="false"> \<annotation term="org odata core v1 optionalparameter"> \<record> \<propertyvalue property="defaultvalue" string="c5d882f8 918d 466a 9048 02c3449bc7f0" /> \</record> \</annotation> \</parameter> \<returntype type="edm complextype" /> \</function> \<navigationproperty name="incidentassociatedescalationwatch" type="collection(metadata frs data escalation watch)"> \<ondelete action="cascade" /> \</navigationproperty> \<navigationproperty name="incidentcontainstask" type="collection(metadata task)"> \<ondelete action="cascade" /> \</navigationproperty> \<navigationproperty name="incidentassociatesci" type="collection(metadata ci)"> \<ondelete action="cascade" /> \</navigationproperty> \<navigationproperty name="incidentassociatedsoftwareaction" type="collection(metadata softwareaction)"> \<ondelete action="cascade" /> \</entitytype> \<action name="new document article"> \<parameter name="actionid" type="edm string" nullable="false" unicode="false"> \<annotation term="org odata core v1 optionalparameter"> \<record> \<propertyvalue property="defaultvalue" string="1e16a70f cea5 4e56 bb6c 000eecfa5e42" /> \</record> \</annotation> \</parameter> \<parameter name="actionparams" type="edm complextype"> \<annotation term="org odata core v1 optionalparameter" /> \</parameter> \<parameter name="promptparams" type="edm complextype"> \<annotation term="org odata core v1 optionalparameter" /> \</action> \<action name="create assignment"> \<parameter name="actionid" type="edm string" nullable="false" unicode="false"> \<annotation term="org odata core v1 optionalparameter"> \<record> \<propertyvalue property="defaultvalue" string="0d260a06 d203 4c72 8929 22a09038cefc" /> \</record> \</annotation> \</parameter> \<parameter name="actionparams" type="edm complextype"> \<annotation term="org odata core v1 optionalparameter" /> \</action> \<action name="resolve incident"> \<parameter name="actionid" type="edm string" nullable="false" unicode="false"> \<annotation term="org odata core v1 optionalparameter"> \<record> \<propertyvalue property="defaultvalue" string="43a31840 2689 405f 88cc a63a2539be99" /> \</record> \</annotation> \</parameter> \<parameter name="actionparams" type="edm complextype"> \<annotation term="org odata core v1 optionalparameter" /> \</parameter> \<parameter name="promptparams" type="edm complextype"> \<annotation term="org odata core v1 optionalparameter" /> \</parameter> \<parameter name="shouldsave" type="edm string" unicode="false"> \<annotation term="org odata core v1 optionalparameter" /> \</parameter> \<returntype type="edm complextype" /> \</action>