Skip to content

Metadata Mapping

The following table shows the mapping of AP Media API item metadata fields (JSON) to AP WebFeeds fields (AP ATOM and NITF XML), AP Content API fields (ATOM and NewsML-G2 XML) and AP Breaking News API fields (ATOM XML and hNews HTML). For item metadata field descriptions, see Content Metadata Fields.

Tip

Use CTRL-F on this page to search for a specific field name.

Note

Revision ID, also known as entry ID in AP WebFeeds (entry/id in the AP ATOM feed) is not available in AP Media API. For information about identifying and managing content item revisions, see Managing Revisions and Duplicates.

AP Media API WebFeeds Content API
(Search Results)
Content API
(Item Metadata)
Breaking News
API
uri -
(not available)
entry/id - -
altids.itemid apnm:
ManagementId
altId[@type=
"ap:itemId"]
altId[@type=
"ap:itemId"]
entry/id[starts-
with(.,"urn:uuid:")]
altids.friendlykey apcm:FriendlyKey altId[@type=
"ap:friendlyKey"]
altId[@type=
"ap:friendlyKey"]
N/A
(Not Applicable)
altids.videoid apnm:ForeignKeys/
apnm:Keys[@Field=
"StoryNumber"]/@Id
altId[@type=
"foreignkey:
storyid"]
altId[@type=
"foreignkey:
storyid"]
N/A
(Not Applicable)
altids.transref apcm:Transmission
Reference
altId[@type=
"idtype:
transmitRef"]
altId[@type=
"idtype:
transmitRef"]
-
foreignkeys.
memberentryid
apnm:ForeignKeys/
apnm:Keys[@Field=
"EntryId"]/@Id
N/A N/A N/A
foreignkeys.member
managementid
apnm:ForeignKeys/
apnm:Keys[@Field=
"ManagementId"]/
@Id
N/A N/A N/A
foreignkeys.storyid apnm:ForeignKeys/
apnm:Keys[@Field=
"StoryNumber"]/@Id
altId[@type=
"foreignkey:
storyid"]
altId[@type=
"foreignkey:
storyid"]
N/A
(Not Applicable)
version apnm:Management
SequenceNumber
altId[@type="ap:
recordSequence
Number"]
altId[@type="ap:
recordSequence
Number"]
-
type apcm:MediaType entry/category itemClass -
urgency apcm:Priority/
@Numeric
entry/category
[@scheme=
"urgency"]/@label
urgency -
editorialpriority apcm:Priority/
@Legacy
- - -
profile apcm:
ItemContentType
N/A N/A -
language entry/content/
@xml:lang
- language -
versioncreated entry/updated entry/updated versionCreated entry/updated
firstcreated apcm:FirstCreated - firstCreated -
embargoed apnm:Publishing
ReleaseDateTime
embargoed embargoed -
pubstatus apnm:
PublishingStatus
- pubStatus -
editorialrole apcm:
ContentElement
role role -
fixture apcm:Fixture N/A N/A -
ednote apnm:Publishing
SpecialInstructions
edNote edNote -
editorialtypes apnm:Legacy
ManagementType
- - -
signals apnm:Signal - signal -
title entry/title entry/title headline -
headline apcm:HeadLine headline headline entry/title
headline_extended apcm:
ExtendedHeadLine
N/A N/A -
description_
summary
entry/summary - - -
bylines.by apcm:ByLine N/A N/A entry/author/
name
bylines.title apcm:ByLine/@Title N/A N/A -
photographer apcm:Entity
Classification[apcm:
Property/@Value=
"PHOTOGRAPHER"]
/@Value
creator
[@role="aprol:
photographer"]
creator
[@role="aprol:
photographer"]
N/A
producer apcm:ByLine[@Title
="EditedBy"]
- creator
[@jobtitle="aptitle:
producer"]
N/A
editor apcm:ByLine[@Title
="EDITOR"]
contributor
[@role="aprol:
editor"]
contributor
[@role="aprol:
editor"]
N/A
located apcm:Dateline - - -
datelinelocation apcm:
DateLineLocation
- located content/div/div
/div[@class=
"entry-content"]
/p/abbr
description_
creditline
apcm:Credit creditline creditline -
copyrightnotice entry/rights entry/rights rightsInfo/
copyrightNotice
content/div/div
[@class="hnews hentry item"]/
small
usageterms apcm:RightsLine rightsinfo/
usageTerms
rightsinfo/
usageTerms
-
keywords apcm:Keywords - keyword -
outcue apcm:OutCue N/A N/A N/A
provider entry/author - provider -
infosource apcm:Source entry/author infoSource content/div/div/
div/small/span
[@class="source-
org vcard"]/a
subject apcm:Subject
Classification
[@Authority=
"AP Subject"]
entry/category subject entry/category
subject.rels:
category
apcm:Subject
Classification
[@Authority=
"AP Category
Code"]
entry/category subject entry/category
subject.rels:
suppcategory
apcm:Subject
Classification
[@Authority=
"AP Supplemental
Category Code"]
entry/category subject entry/category
person apcm:Entity
Classification
[@Authority=
"AP Party"]
- subject entry/category
organisation apcm:Entity
Classification
[@Authority=
"AP Organization"
or @Authority=
"AP Company"]
- subject entry/category
organisation.
industries
apcm:Entity
Classification/
apcm:Property
[@Name=
"APIndustry"]/
@Value
- - entry/category
organisation.
symbols.
ticker
apcm:Entity
Classification/
apcm:Property
[@Name=
"Ticker"]/
@Value
- - -
organisation.
symbols.
exchange
apcm:Entity
Classification/
apcm:Property
[@Name=
"Exchange"]/
@Value
- - -
organization.
symbols.
instrument
apcm:Entity
Classification/
apcm:Property
[@Name=
"Instrument"]/
@Value
- - -
place apcm:Entity
Classification
[@Authority=
"AP Geography"]
- - entry/category
event apcm:Entity
Classification
[@Authority=
"AP Event"]
- subject entry/category
audiences apcm:Audience
Classification
- audience -
description_
caption
entry/content/
nitf/body/
body.content/
block[@id=
"Caption"]/p
entry/content
[@type="xhtml"]
description[@role=
"drol:caption"]
N/A
slugline apcm:SlugLine - slugline -
associations entry/content/
nitf/body/
body.content
/media
N/A N/A content/div/div/
div[@class=
"hmedia"]
renditions.name.
title
entry/link/@title entry/link/@title - N/A
renditions.name.
rel
apcm:Characteristics
/@Role
remoteContent/
@rendition
remoteContent/
@rendition
N/A
renditions.name.
format
apcm:
Characteristics
/@Format
remoteContent/
@format
remoteContent/
@format
N/A
renditions.name.
type
apcm:Characteristics
/@MediaType
- - N/A
renditions.name.
digest
apcm:Characteristics
/@Digest
- remoteContent/
hash
N/A
renditions.name.
href
entry/link/@href remoteContent/
@href
remoteContent/
@href
N/A
renditions.name.
orientation
apcm:Characteristics
/@PhotoType
- remoteContent/
@layoutorientation
N/A
renditions.name.
mimetype
apcm:Characteristics
/@MimeType
remoteContent/
@contenttype
remoteContent/
@contenttype
N/A
renditions.name.
fileextension
apcm:Characteristics
/@FileExtension
- - N/A
renditions.name.
sizeinbytes
apcm:Characteristics
/@SizeInBytes
remoteContent/
@size
remoteContent/
@size
N/A
renditions.name.
width
apcm:Characteristics
/@Width
remoteContent/
@width
remoteContent/
@width
N/A
renditions.name.
height
apcm:Characteristics
/@Height
remoteContent/
@height
remoteContent/
@height
N/A
renditions.name.
originalfilename
apcm:Characteristics
/@OriginalFileName
- - N/A
renditions.name.
duration
apcm:Characteristics
/@TotalDuration
remoteContent/
@duration
remoteContent/
@duration
N/A
renditions.name.
videocodec
apcm:Characteristics
/@VideoCoder
- remoteContent/
@videocodec
N/A
renditions.name.
framerate
apcm:Characteristics
/@FrameRate
remoteContent/
@videoframerate
remoteContent/
@videoframerate
N/A
renditions.name.
averagebitrate
apcm:Characteristics
/@AverageBitRate
remoteContent/
@videoavgbitrate
remoteContent/
@videoavgbitrate
N/A
renditions.name.
samplerate
apcm:Characteristics
/@SampleRate
- remoteContent/
@audiosamplerate
N/A
renditions.name.
aspectratio
apcm:Characteristics
/@AspectRatio
remoteContent/
@videoaspectratio
remoteContent/
@videoaspectratio
N/A
renditions.name.
videoscaling
apnm:ForeignKeys/
apnm:Keys
[@Field="Produced
AspectRatio"]/@Id
- remoteContent
/@videoscaling
N/A
renditions.name.
resolution
apcm:Characteristics
/@ResolutionValue
- remoteContent/
@resolution
N/A
renditions.name.
colourspace
apcm:Characteristics
/@ColorSpace
remoteContent/
@colourspace
remoteContent/
@colourspace
N/A
renditions.name.
scene
apcm:Characteristics
/@Scene
- - N/A
renditions.name.
backgroundcolor
- - - N/A
renditions.name.
words
apcm:Characteristics
/@Words
N/A N/A -
shots - - - N/A
textformat apcm:Legacy
TypeSetFormat
N/A N/A -
links.rel:canonical entry/link
[@rel="alternate"]
N/A N/A entry/link
[@rel="alternate"]