GET v1/Issue/{issueKey}/Media

This will return all media for a single issue matching the IssueKey provided.

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
issueKey		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Media

Name	Description	Type	Additional information
CustomFields	A collection of custom field groupings for this media that have values along with the values currently assigned. The custom fields that are available for use might be different for every article because they depend on the Genre of the article that this media is assigned to. An API method is available to find a list of all custom fields that can be assigned to media attached to an article of a particular genre.	Collection of Collection of MediaCustomFieldValues	None.
MediaKey	A unique identifier for the Media	integer	None.
MediaFile	The filename for this Media in BLOB storage	string	None.
Updated	The last time this media was updated	date	None.
UpdatedBy	The last user who updated the media	string	None.
ElementType	The ElementType that is assigned to the Media	ElementType	None.
MediaReferences	A collection of specific places on specific pages where this media appears	Collection of MediaReference	None.
Credit		string	None.
Caption		string	None.
TextDescription		string	None.
Notes		string	None.
IsReviewed		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomFields": [
      [
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        },
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        }
      ],
      [
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        },
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        }
      ]
    ],
    "MediaKey": 1,
    "MediaFile": "sample string 2",
    "Updated": "2024-10-31T10:08:45.6214185+00:00",
    "UpdatedBy": "sample string 4",
    "ElementType": {
      "ElementTypeId": 1,
      "ElementTypeValue": "sample string 2"
    },
    "MediaReferences": [
      {
        "MediaReferenceKey": 1.0,
        "PageLocation": {
          "PageLocationKey": 1,
          "PageKey": 2,
          "ULX": 3,
          "ULY": 4,
          "LRX": 5,
          "LRY": 6,
          "Width": 7,
          "Height": 8
        },
        "PageRef": "sample string 2",
        "RefId": "sample string 3",
        "RefOrder": 4
      },
      {
        "MediaReferenceKey": 1.0,
        "PageLocation": {
          "PageLocationKey": 1,
          "PageKey": 2,
          "ULX": 3,
          "ULY": 4,
          "LRX": 5,
          "LRY": 6,
          "Width": 7,
          "Height": 8
        },
        "PageRef": "sample string 2",
        "RefId": "sample string 3",
        "RefOrder": 4
      }
    ],
    "Credit": "sample string 5",
    "Caption": "sample string 6",
    "TextDescription": "sample string 7",
    "Notes": "sample string 8",
    "IsReviewed": true
  },
  {
    "CustomFields": [
      [
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        },
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        }
      ],
      [
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        },
        {
          "CustomFieldId": 1,
          "CustomFieldName": "sample string 2",
          "Values": [
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            },
            {
              "CustomFieldLookupID": 1,
              "CustomFieldValue": "sample string 1"
            }
          ]
        }
      ]
    ],
    "MediaKey": 1,
    "MediaFile": "sample string 2",
    "Updated": "2024-10-31T10:08:45.6214185+00:00",
    "UpdatedBy": "sample string 4",
    "ElementType": {
      "ElementTypeId": 1,
      "ElementTypeValue": "sample string 2"
    },
    "MediaReferences": [
      {
        "MediaReferenceKey": 1.0,
        "PageLocation": {
          "PageLocationKey": 1,
          "PageKey": 2,
          "ULX": 3,
          "ULY": 4,
          "LRX": 5,
          "LRY": 6,
          "Width": 7,
          "Height": 8
        },
        "PageRef": "sample string 2",
        "RefId": "sample string 3",
        "RefOrder": 4
      },
      {
        "MediaReferenceKey": 1.0,
        "PageLocation": {
          "PageLocationKey": 1,
          "PageKey": 2,
          "ULX": 3,
          "ULY": 4,
          "LRX": 5,
          "LRY": 6,
          "Width": 7,
          "Height": 8
        },
        "PageRef": "sample string 2",
        "RefId": "sample string 3",
        "RefOrder": 4
      }
    ],
    "Credit": "sample string 5",
    "Caption": "sample string 6",
    "TextDescription": "sample string 7",
    "Notes": "sample string 8",
    "IsReviewed": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <Media>
    <Caption>sample string 6</Caption>
    <Credit>sample string 5</Credit>
    <IsReviewed>true</IsReviewed>
    <Notes>sample string 8</Notes>
    <TextDescription>sample string 7</TextDescription>
    <ElementType>
      <ElementTypeId>1</ElementTypeId>
      <ElementTypeValue>sample string 2</ElementTypeValue>
    </ElementType>
    <MediaFile>sample string 2</MediaFile>
    <MediaKey>1</MediaKey>
    <MediaReferences>
      <MediaReference>
        <MediaReferenceKey>1</MediaReferenceKey>
        <PageLocation>
          <Height>8</Height>
          <LRX>5</LRX>
          <LRY>6</LRY>
          <PageKey>2</PageKey>
          <PageLocationKey>1</PageLocationKey>
          <ULX>3</ULX>
          <ULY>4</ULY>
          <Width>7</Width>
        </PageLocation>
        <PageRef>sample string 2</PageRef>
        <RefId>sample string 3</RefId>
        <RefOrder>4</RefOrder>
      </MediaReference>
      <MediaReference>
        <MediaReferenceKey>1</MediaReferenceKey>
        <PageLocation>
          <Height>8</Height>
          <LRX>5</LRX>
          <LRY>6</LRY>
          <PageKey>2</PageKey>
          <PageLocationKey>1</PageLocationKey>
          <ULX>3</ULX>
          <ULY>4</ULY>
          <Width>7</Width>
        </PageLocation>
        <PageRef>sample string 2</PageRef>
        <RefId>sample string 3</RefId>
        <RefOrder>4</RefOrder>
      </MediaReference>
    </MediaReferences>
    <Updated>2024-10-31T10:08:45.6214185+00:00</Updated>
    <UpdatedBy>sample string 4</UpdatedBy>
    <CustomFields>
      <ArrayOfMediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
      </ArrayOfMediaCustomFieldValues>
      <ArrayOfMediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
      </ArrayOfMediaCustomFieldValues>
    </CustomFields>
  </Media>
  <Media>
    <Caption>sample string 6</Caption>
    <Credit>sample string 5</Credit>
    <IsReviewed>true</IsReviewed>
    <Notes>sample string 8</Notes>
    <TextDescription>sample string 7</TextDescription>
    <ElementType>
      <ElementTypeId>1</ElementTypeId>
      <ElementTypeValue>sample string 2</ElementTypeValue>
    </ElementType>
    <MediaFile>sample string 2</MediaFile>
    <MediaKey>1</MediaKey>
    <MediaReferences>
      <MediaReference>
        <MediaReferenceKey>1</MediaReferenceKey>
        <PageLocation>
          <Height>8</Height>
          <LRX>5</LRX>
          <LRY>6</LRY>
          <PageKey>2</PageKey>
          <PageLocationKey>1</PageLocationKey>
          <ULX>3</ULX>
          <ULY>4</ULY>
          <Width>7</Width>
        </PageLocation>
        <PageRef>sample string 2</PageRef>
        <RefId>sample string 3</RefId>
        <RefOrder>4</RefOrder>
      </MediaReference>
      <MediaReference>
        <MediaReferenceKey>1</MediaReferenceKey>
        <PageLocation>
          <Height>8</Height>
          <LRX>5</LRX>
          <LRY>6</LRY>
          <PageKey>2</PageKey>
          <PageLocationKey>1</PageLocationKey>
          <ULX>3</ULX>
          <ULY>4</ULY>
          <Width>7</Width>
        </PageLocation>
        <PageRef>sample string 2</PageRef>
        <RefId>sample string 3</RefId>
        <RefOrder>4</RefOrder>
      </MediaReference>
    </MediaReferences>
    <Updated>2024-10-31T10:08:45.6214185+00:00</Updated>
    <UpdatedBy>sample string 4</UpdatedBy>
    <CustomFields>
      <ArrayOfMediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
      </ArrayOfMediaCustomFieldValues>
      <ArrayOfMediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
        <MediaCustomFieldValues>
          <CustomFieldId>1</CustomFieldId>
          <CustomFieldName>sample string 2</CustomFieldName>
          <Values>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
            <CustomFieldEntry>
              <CustomFieldLookupID>1</CustomFieldLookupID>
              <CustomFieldValue>sample string 1</CustomFieldValue>
            </CustomFieldEntry>
          </Values>
        </MediaCustomFieldValues>
      </ArrayOfMediaCustomFieldValues>
    </CustomFields>
  </Media>
</ArrayOfMedia>