APIReference
schema:Thing > schema:CreativeWork > schema:Article > schema:TechArticle > schema:APIReference
Reference documentation for application programming interfaces (APIs).
| Property | Expected Type | Description |
|---|---|---|
| Properties from schema:APIReference | ||
schema:assembly
|
schema:Text | Library file name e.g., mscorlib.dll, system.web.dll. |
schema:assemblyVersion
|
schema:Text | Associated product/technology version. e.g., .NET Framework 4.5. |
schema:programmingModel
|
schema:Text | Indicates whether API is managed or unmanaged. |
schema:targetPlatform
|
schema:Text | Type of app development: phone, Metro style, desktop, XBox, etc. |
| Properties from schema:TechArticle | ||
schema:dependencies
|
schema:Text | Prerequisites needed to fulfill steps in article. |
schema:proficiencyLevel
|
schema:Text | Proficiency needed for this content; expected values: 'Beginner', 'Expert'. |
| Properties from schema:Article | ||
schema:articleBody
|
schema:Text | The actual body of the article. |
schema:articleSection
|
schema:Text | Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc. |
schema:pageEnd
|
schema:Text or schema:Integer | The page on which the work ends; for example "138" or "xvi". |
schema:pageStart
|
schema:Text or schema:Integer | The page on which the work starts; for example "135" or "xiii". |
schema:pagination
|
schema:Text | Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". |
schema:wordCount
|
schema:Integer | The number of words in the text of the Article. |
| Properties from schema:CreativeWork | ||
schema:about
|
schema:Thing | The subject matter of the content. |
schema:accessibilityAPI
|
schema:Text | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). |
schema:accessibilityControl
|
schema:Text | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). |
schema:accessibilityFeature
|
schema:Text | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). |
schema:accessibilityHazard
|
schema:Text | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). |
schema:accountablePerson
|
schema:Person | Specifies the Person that is legally accountable for the CreativeWork. |
schema:aggregateRating
|
schema:AggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. |
schema:alternativeHeadline
|
schema:Text | A secondary title of the CreativeWork. |
schema:associatedMedia
|
schema:MediaObject | A media object that encodes this CreativeWork. This property is a synonym for encoding. |
schema:audience
|
schema:Audience | The intended audience of the item, i.e. the group for whom the item was created. |
schema:audio
|
schema:AudioObject | An embedded audio object. |
schema:author
|
schema:Organization or schema:Person | The author of this content. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
schema:award
|
schema:Text | An award won by this person or for this creative work. Supersedes schema:awards. |
schema:character
|
schema:Person | Fictional person connected with a creative work. |
schema:citation
|
schema:Text or schema:CreativeWork | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
schema:comment
|
schema:UserComments or schema:Comment | Comments, typically from users, on this CreativeWork. |
schema:commentCount
|
schema:Integer | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
schema:contentLocation
|
schema:Place | The location of the content. |
schema:contentRating
|
schema:Text | Official rating of a piece of content—for example,'MPAA PG-13'. |
schema:contributor
|
schema:Organization or schema:Person | A secondary contributor to the CreativeWork. |
schema:copyrightHolder
|
schema:Organization or schema:Person | The party holding the legal copyright to the CreativeWork. |
schema:copyrightYear
|
schema:Number | The year during which the claimed copyright for the CreativeWork was first asserted. |
schema:creator
|
schema:Organization or bgn:Agent or schema:Person | The creator/author of this CreativeWork or UserComments. This is the same as the Author property for CreativeWork. |
schema:dateCreated
|
schema:Date | The date on which the CreativeWork was created. |
schema:dateModified
|
schema:Date | The date on which the CreativeWork was most recently modified. |
schema:datePublished
|
schema:Date | Date of first broadcast/publication. |
schema:discussionUrl
|
schema:URL | A link to the page containing the comments of the CreativeWork. |
schema:editor
|
schema:Person | Specifies the Person who edited the CreativeWork. |
schema:educationalAlignment
|
schema:AlignmentObject | An alignment to an established educational framework. |
schema:educationalUse
|
schema:Text | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
schema:encoding
|
schema:MediaObject | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. Supersedes schema:encodings. |
schema:exampleOfWork
|
schema:CreativeWork | A creative work that this work is an example/instance/realization/derivation of. Inverse property: schema:workExample. |
schema:genre
|
schema:Text | Genre of the creative work or group. |
schema:hasPart
|
schema:CreativeWork | Indicates a CreativeWork that is (in some sense) a part of this CreativeWork. Inverse property: schema:isPartOf. |
schema:headline
|
schema:Text | Headline of the article. |
schema:inLanguage
|
schema:Text | The language of the content. please use one of the language codes from the IETF BCP 47 standard. |
schema:interactionCount
|
schema:Text | A count of a specific user interactions with this item—for example, 20 UserLikes, 5 UserComments, or 300 UserDownloads. The user interaction type should be one of the sub types of UserInteraction. |
schema:interactivityType
|
schema:Text | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
schema:isBasedOnUrl
|
schema:URL | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
schema:isFamilyFriendly
|
schema:Boolean | Indicates whether this content is family friendly. |
schema:isPartOf
|
schema:CreativeWork | Indicates a CreativeWork that this CreativeWork is (in some sense) part of. Inverse property: schema:hasPart. |
schema:keywords
|
schema:Text | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
schema:learningResourceType
|
schema:Text | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
schema:license
|
schema:URL or schema:CreativeWork | A license document that applies to this content, typically indicated by URL. |
schema:mentions
|
schema:Thing | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
schema:offers
|
schema:Offer | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, or give away tickets to an event. |
schema:position
|
schema:Text or schema:Integer | The position of an item in a series or sequence of items. |
schema:producer
|
schema:Person or schema:Organization | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
schema:provider
|
schema:Person or schema:Organization | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes schema:carrier. |
schema:publisher
|
schema:Organization | The publisher of the creative work. |
schema:publishingPrinciples
|
schema:URL | Link to page describing the editorial principles of the organization primarily responsible for the creation of the CreativeWork. |
schema:recordedAt
|
schema:Event | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. Inverse property: schema:recordedIn. |
schema:releasedEvent
|
schema:PublicationEvent | The place and time the release was issued, expressed as a PublicationEvent. |
schema:review
|
schema:Review | A review of the item. Supersedes schema:reviews. |
schema:sourceOrganization
|
schema:Organization | The Organization on whose behalf the creator was working. |
schema:text
|
schema:Text | The textual content of this CreativeWork. |
schema:thumbnailUrl
|
schema:URL | A thumbnail image relevant to the Thing. |
schema:timeRequired
|
schema:Duration | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'P30M', 'P1H25M'. |
bgn:translationOfWork
|
schema:CreativeWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” Inverse property: bgn:workTranslation. |
schema:translator
|
schema:Person or bgn:Agent or schema:Organization | An agent responsible for rendering a translated work from a source work |
schema:typicalAgeRange
|
schema:Text | The typical expected age range, e.g. '7-9', '11-'. |
schema:version
|
schema:Number | The version of the CreativeWork embodied by a specified resource. |
schema:video
|
schema:VideoObject | An embedded video object. |
schema:workExample
|
schema:CreativeWork | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. Inverse property: schema:exampleOfWork. |
bgn:workTranslation
|
schema:CreativeWork | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. Inverse property: bgn:translationOfWork. |
| Properties from schema:Thing | ||
schema:additionalType
|
schema:URL | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
schema:alternateName
|
schema:Text | An alias for the item. |
schema:description
|
schema:Text | A short description of the item. |
schema:image
|
schema:ImageObject or schema:URL | An image of the item. This can be a URL or a fully described ImageObject. |
schema:name
|
schema:Text | The name of the item. |
schema:potentialAction
|
schema:Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
schema:sameAs
|
schema:URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website. |
schema:url
|
schema:URL | URL of the item. |
Prefixes used:
BiblioGraph.net Version 1.1
Schema.org Version 1.93
Code Version 1.1