Get Content Type Details using the API

Question

0

Get Content Type Details using the API

Bryan Donovan posted 8 Years Ago

How do you get the 'Item Attributes' list on the Content Type Detail Page from the API? If I ask for expanded attributes, I only see the possible 'Channel Attributes'. Is there a way to ask for the possible/configured Item Attributes using the ContentChannels or ContentChannelTypes endpoints? I'm not looking for the specific attribute values that would be associated with the Content Channel Item. Just the meta information of the possible attributes that are configured.

Nick Airdo · Answer 1 · 2016-12-13T18:03-07:00

0

Nick Airdo replied 7 Years Ago

Using Mike's REST & OData video along with some interrogation of the Attributes table, I was able to figure this out. Attributes for a ContentChannelType's ContentChannelItem's (entitytype id = 208 in my environment) are stored in the Attributes table with these references:

EntityTypeId = 208 (aka Rock.Model.ContentChannelItem in my environment)
EntityTypeQualifierColumn = 'ContentChannelTypeId'
EntityTypeQualifierValue = <the Id of the channel type you're looking for>

So, if I'm programmatically looking for the content channel item attributes for my "Blogs" channel type (Id = 3) my API/OData query would look be:

http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'

If I really only want the attribute "Keys" back I can $select only them:

http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'&$select=Key

Depending on your situation, you may have to set up a REST Key (Admin Tools > Security > REST Keys) and tie it as a user under a controller's REST Security (Admin Tools > Security > REST Controllers) but it does work. I used the Postman browser extension and was able to get this to work:

[
   {     "Key": "Summary"   },
   {     "Key": "Image"   }
]

I hope this helps (sorry...better late than never?).

Edit Answer

Using Mike's <a href="http://www.rockrms.com/page/513?Item=80">REST &amp; OData video</a>&nbsp;along with some interrogation of the Attributes table, I was able to figure this out. &nbsp;Attributes for a ContentChannelType's ContentChannelItem's (entitytype id = 208 in my environment) are stored in the Attributes table with these references:<blockquote>EntityTypeId = 208 &nbsp;(aka Rock.Model.ContentChannelItem in my environment) EntityTypeQualifierColumn = 'ContentChannelTypeId' EntityTypeQualifierValue = &lt;the Id of the channel type you're looking for&gt;</blockquote>So, if I'm programmatically looking for the content channel item attributes for my "Blogs" channel type (Id = 3) my API/OData query would look be: <pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
 and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'</pre>If I really only want the attribute "Keys" back I can $select only them:<pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
 and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'&amp;$select=Key</pre>Depending on your situation, you may have to set up a REST Key (Admin Tools &gt; Security &gt; REST Keys)&nbsp;and tie it as a user under a controller's REST Security (Admin Tools &gt; Security &gt; REST Controllers) but it does work. &nbsp;I used the <a href="https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en" style="background-color: rgb(255, 255, 255);">Postman browser extension</a>&nbsp;and was able to get this to work: <img src="/Content/RockExternal/Users/nairdo/Question1217-PostmanScreenshot.png" style="width: 100%;" alt="Question1217-PostmanScreenshot.png"> <pre>[
 { "Key": "Summary" },
 { "Key": "Image" }
]</pre>I hope this helps (sorry...better late than never?).

<p>Using Mike's <a href="http://www.rockrms.com/page/513?Item=80">REST &amp; OData video</a>&nbsp;along with some interrogation of the Attributes table, I was able to figure this out. &nbsp;Attributes for a ContentChannelType's ContentChannelItem's (entitytype id = 208<i> in my environment</i>) are stored in the Attributes table with these references:</p><blockquote><b>EntityTypeId </b>= <b>208 &nbsp;</b>(aka Rock.Model.ContentChannelItem <i>in my environment</i>)<br><b>EntityTypeQualifierColumn </b>= '<b>ContentChannelTypeId</b>'<br><b>EntityTypeQualifierValue </b>= &lt;<i>the Id of the channel type you're looking for</i>&gt;</blockquote><p>So, if I'm programmatically looking for the content channel item attributes for my "Blogs" channel type (Id = 3) my API/OData query would look be:<br></p><pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'</pre><p>If I really only want the attribute "Keys" back I can $select only them:</p><pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'&amp;$select=Key</pre><p>Depending on your situation, you may have to set up a REST Key (<i>Admin Tools &gt; Security &gt; REST Keys</i>)&nbsp;and tie it as a user under a controller's REST Security (<i>Admin Tools &gt; Security &gt; REST Controllers</i>) but it does work. &nbsp;I used the <a href="https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en" style="background-color: rgb(255, 255, 255);">Postman browser extension</a>&nbsp;and was able to get this to work:<br></p><p><img src="/Content/RockExternal/Users/nairdo/Question1217-PostmanScreenshot.png" style="width: 100%;" alt="Question1217-PostmanScreenshot.png"><br></p><pre>[
   {     "Key": "Summary"   },
   {     "Key": "Image"   }
]</pre><p></p><p>I hope this helps (sorry...better late than never?).</p>

<p>Using Mike's <a href="http://www.rockrms.com/page/513?Item=80">REST &amp; OData video</a>&nbsp;along with some interrogation of the Attributes table, I was able to figure this out. &nbsp;Attributes for a ContentChannelType's ContentChannelItem's (entitytype id = 208<i> in my environment</i>) are stored in the Attributes table with these references:</p><blockquote><b>EntityTypeId </b>= <b>208 &nbsp;</b>(aka Rock.Model.ContentChannelItem <i>in my environment</i>)<br><b>EntityTypeQualifierColumn </b>= '<b>ContentChannelTypeId</b>'<br><b>EntityTypeQualifierValue </b>= &lt;<i>the Id of the channel type you're looking for</i>&gt;</blockquote><p>So, if I'm programmatically looking for the content channel item attributes for my "Blogs" channel type (Id = 3) my API/OData query would look be:<br></p><pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'</pre><p>If I really only want the attribute "Keys" back I can $select only them:</p><pre>http://MYROCKSERVER/api/Attributes/?$filter=EntityTypeId eq 208 
   and EntityTypeQualifierColumn eq 'ContentChannelTypeId' and EntityTypeQualifierValue eq '3'&amp;$select=Key</pre><p>Depending on your situation, you may have to set up a REST Key (<i>Admin Tools &gt; Security &gt; REST Keys</i>)&nbsp;and tie it as a user under a controller's REST Security (<i>Admin Tools &gt; Security &gt; REST Controllers</i>) but it does work. &nbsp;I used the <a href="https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en" style="background-color: rgb(255, 255, 255);">Postman browser extension</a>&nbsp;and was able to get this to work:<br></p><p><img src="/Content/RockExternal/Users/nairdo/Question1217-PostmanScreenshot.png" style="width: 100%;" alt="Question1217-PostmanScreenshot.png"><br></p><pre>[
   {     "Key": "Summary"   },
   {     "Key": "Image"   }
]</pre><p></p><p>I hope this helps (sorry...better late than never?).</p>

Save Cancel