GET v1/Genre/{genreId}/Media/CustomFields
Finds the custom fields available for media related to articles with a specified genre. This returns information about the fields that a media related to an article of a specified genre is allowed to use - it does not return the values that are set for the article's custom fields.
Roles Allowed
admin, editor
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
genreId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
HTTP 200 with Custom fields, HTTP 404 if Genre not found
Collection of CustomFieldName | Description | Type | Additional information |
---|---|---|---|
CustomFieldID |
Unique identifier for the Custom Field |
integer |
None. |
FieldName |
The name of the custom field |
string |
None. |
Description |
The description of the field |
string |
None. |
IsMultiselect |
Can multiple values be specfied for this field |
boolean |
None. |
LimitToLookups |
If LimitToLookups is true, users may only set a value that is present in the lookups list. |
boolean |
None. |
CanAddLookup |
If CanAddLookup is true, users may add new values to the lookup list. New items must be added to the list before they can be used on an article / media. |
boolean |
None. |
CanRequestLookup |
If CanRequestLookup is true, a user can suggest that a value be added to the lookup list, but it will not be available for assignement to an article / media until it has been approved an administrator. |
boolean |
None. |
Response Formats
application/json, text/json
[ { "CustomFieldID": 1, "FieldName": "sample string 2", "Description": "sample string 3", "IsMultiselect": true, "LimitToLookups": true, "CanAddLookup": true, "CanRequestLookup": true }, { "CustomFieldID": 1, "FieldName": "sample string 2", "Description": "sample string 3", "IsMultiselect": true, "LimitToLookups": true, "CanAddLookup": true, "CanRequestLookup": true } ]
application/xml, text/xml
<ArrayOfCustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto"> <CustomField> <CanAddLookup>true</CanAddLookup> <CanRequestLookup>true</CanRequestLookup> <CustomFieldID>1</CustomFieldID> <Description>sample string 3</Description> <FieldName>sample string 2</FieldName> <IsMultiselect>true</IsMultiselect> <LimitToLookups>true</LimitToLookups> </CustomField> <CustomField> <CanAddLookup>true</CanAddLookup> <CanRequestLookup>true</CanRequestLookup> <CustomFieldID>1</CustomFieldID> <Description>sample string 3</Description> <FieldName>sample string 2</FieldName> <IsMultiselect>true</IsMultiselect> <LimitToLookups>true</LimitToLookups> </CustomField> </ArrayOfCustomField>