Term Usage Index
This index reports lexical identifier matches only; it does not prove semantic equivalence. Its own vocabulary (term, alpsBacked, usage, reservedField, coverage) is defined by the profile linked above. A term whose spelling also exists in the configured application ALPS profile is marked alpsBacked; the matched application descriptor id is carried on the entry's data-alps attribute.
Summary
- Terms used in API: 73
- Terms with same-name ALPS descriptor: 4
- Lexical ALPS coverage: 5.5%
- Reserved representation fields: 2
Index
- additionalName
- age
- assignee
- bday
- bothSummaryAndDescription
- builtinType
- category
- count
- country-name
- created
- date
- description
- docOnly
- dtend
- dtstart
- duration
- enabled
- extended-address
- familyName
- firstName
- fn
- foo
- fruits
- givenName
- honorificPrefix
- honorificSuffix
- href
- id
- ids
- items
- juice
- juiceLike
- juiceName
- lastName
- locality
- location
- logo
- modified
- name
- nickname
- noCtor
- nonPromoted
- options
- org
- organizationName
- organizationUnit
- photo
- post-office-box
- postal-code
- priority
- rdate
- region
- role
- rrule
- self
- sound
- status
- street-address
- subject
- summary
- tagOnly
- tel
- tickets
- title
- type
- tz
- updated
- url
- value
- vegetables
- veggieLike
- veggieName
- _embedded
- _links
Terms
additionalName- schema property: card.json#/properties/additionalName
age(ALPS-backed)title: Age in years which must be equal to or greater than zero.
- parameter: GET /alps-fallback {age}
- parameter: POST /contact {age}
- parameter: POST /contact-with-descriptions {age}
- parameter: POST /person {age}
- parameter: PATCH /person {age}
- parameter: POST /users/{id} {age}
- parameter: PUT /users/{id} {age}
- schema property: contact.param.json#/properties/age
- schema property: person.json#/properties/age
- schema property: person.param.json#/properties/age
- schema property: user.json#/properties/age
- schema property: user.param.json#/properties/age
assignee- parameter: POST /ticket/{id} {assignee}
- parameter: PUT /ticket/{id} {assignee}
- parameter: PUT /ticket/assign {assignee}
- schema property: ticket.json#/properties/assignee
- schema property: ticket.param.json#/properties/assignee
bday- schema property: card.json#/properties/bday
bothSummaryAndDescription- parameter: POST /docblock-variants {bothSummaryAndDescription}
builtinType- parameter: POST /input-edge-cases {builtinType}
category- schema property: calendar.json#/properties/category
count- parameter: GET /numbers {count}
country-name- schema property: address.json#/properties/country-name
created- schema property: ticket.json#/properties/created
- schema property: user.json#/properties/created
date- parameter: GET /calendar/{year}/{month} {date}
description- parameter: POST /ticket/{id} {description}
- parameter: PUT /ticket/{id} {description}
- schema property: calendar.json#/properties/description
- schema property: ticket.json#/properties/description
- schema property: ticket.param.json#/properties/description
docOnly- schema property: json-schema-input.param.json#/properties/docOnly
dtend- schema property: calendar.json#/properties/dtend
dtstart- schema property: calendar.json#/properties/dtstart
duration- schema property: calendar.json#/properties/duration
email- parameter: POST /contact {email}
- parameter: POST /contact-with-descriptions {email}
- parameter: POST /users/{id} {email}
- parameter: PUT /users/{id} {email}
- schema property: card.json#/properties/email
- schema property: contact.param.json#/properties/email
- schema property: user.json#/properties/email
- schema property: user.param.json#/properties/email
enabled- parameter: PUT /users/{id} {enabled}
- schema property: user.json#/properties/enabled
- schema property: user.param.json#/properties/enabled
extended-address- schema property: address.json#/properties/extended-address
familyName(ALPS-backed)def: https://schema.org/familyName
- parameter: GET /alps-fallback {familyName}
- parameter: POST /person {familyName}
- parameter: PATCH /person {familyName}
- schema property: card.json#/properties/familyName
- schema property: person.json#/properties/familyName
- schema property: person.param.json#/properties/familyName
firstName(ALPS-backed)title: First Name by ALPS
- parameter: GET /alps-fallback {firstName}
- parameter: POST /person {firstName}
- parameter: PATCH /person {firstName}
- schema property: person.json#/properties/firstName
- schema property: person.param.json#/properties/firstName
- schema property: user.json#/properties/firstName
fn- schema property: card.json#/properties/fn
foo- parameter: GET /alps-fallback {foo}
fruits- schema property: array.json#/properties/fruits
givenName- schema property: card.json#/properties/givenName
honorificPrefix- schema property: card.json#/properties/honorificPrefix
honorificSuffix- schema property: card.json#/properties/honorificSuffix
href- schema property: user.json#/properties/_links/properties/self/properties/href
id(ALPS-backed)title: Person identifier
- parameter: GET /address {id}
- parameter: GET /card {id}
- parameter: GET /org {id}
- parameter: GET /person {id}
- parameter: PATCH /person {id}
- parameter: GET /ticket/{id} {id}
- parameter: PUT /ticket/{id} {id}
- parameter: DELETE /ticket/{id} {id}
- parameter: PUT /ticket/assign {id}
- parameter: GET /union-type {id}
- parameter: GET /users/{id} {id}
- parameter: PUT /users/{id} {id}
- parameter: DELETE /users/{id} {id}
- schema property: org.json#/properties/id
- schema property: person.param.json#/properties/id
- schema property: ticket.json#/properties/id
- schema property: ticket.param.json#/properties/id
- schema property: user.json#/properties/id
- schema property: user.param.json#/properties/id
ids- schema property: json-schema-input.param.json#/properties/ids
items- parameter: GET /array-data {items}
juice- schema property: array.json#/properties/juice
juiceLike- schema property: array.json#/definitions/juice/properties/juiceLike
juiceName- schema property: array.json#/definitions/juice/properties/juiceName
lastName- schema property: user.json#/properties/lastName
locality- schema property: address.json#/properties/locality
location- schema property: calendar.json#/properties/location
logo- schema property: card.json#/properties/logo
modified- schema property: user.json#/properties/modified
name- parameter: POST /contact {name}
- parameter: POST /contact-with-descriptions {name}
- parameter: POST /users/{id} {name}
- parameter: PUT /users/{id} {name}
- schema property: contact.param.json#/properties/name
- schema property: org.json#/properties/name
- schema property: user.param.json#/properties/name
nickname- schema property: card.json#/properties/nickname
noCtor- parameter: PUT /input-edge-cases {noCtor}
nonPromoted- parameter: POST /docblock-variants {nonPromoted}
options- parameter: GET /users/{id} {options}
- schema property: user.param.json#/properties/options
org- schema property: card.json#/properties/org
organizationName- schema property: card.json#/properties/org/properties/organizationName
organizationUnit- schema property: card.json#/properties/org/properties/organizationUnit
photo- schema property: card.json#/properties/photo
post-office-box- schema property: address.json#/properties/post-office-box
postal-code- schema property: address.json#/properties/postal-code
priority- schema property: ticket.json#/properties/priority
rdate- schema property: calendar.json#/properties/rdate
region- schema property: address.json#/properties/region
role- schema property: card.json#/properties/role
rrule- schema property: calendar.json#/properties/rrule
self- schema property: user.json#/properties/_links/properties/self
sound- schema property: card.json#/properties/sound
status- parameter: PUT /ticket/{id} {status}
- schema property: json-schema-input.param.json#/properties/status
- schema property: ticket.json#/properties/status
- schema property: ticket.param.json#/properties/status
street-address- schema property: address.json#/properties/street-address
subject- parameter: POST /contact {subject}
- parameter: POST /contact-with-descriptions {subject}
- schema property: contact.param.json#/properties/subject
summary- schema property: calendar.json#/properties/summary
tagOnly- parameter: POST /docblock-variants {tagOnly}
tel- schema property: card.json#/properties/tel
tickets- schema property: user.json#/properties/_embedded/properties/tickets
title- parameter: POST /ticket/{id} {title}
- parameter: PUT /ticket/{id} {title}
- schema property: card.json#/properties/title
- schema property: ticket.json#/properties/title
- schema property: ticket.param.json#/properties/title
type- schema property: card.json#/properties/email/properties/type
- schema property: card.json#/properties/tel/properties/type
tz- schema property: card.json#/properties/tz
updated- schema property: ticket.json#/properties/updated
url- schema property: calendar.json#/properties/url
- schema property: card.json#/properties/url
value- schema property: card.json#/properties/email/properties/value
- schema property: card.json#/properties/tel/properties/value
vegetables- schema property: array.json#/properties/vegetables
veggieLike- schema property: array.json#/definitions/veggie/properties/veggieLike
veggieName- schema property: array.json#/definitions/veggie/properties/veggieName
Reserved Representation Fields
Leading-underscore fields are listed separately because they usually belong to the representation format rather than the API domain vocabulary.
_embedded- schema property: user.json#/properties/_embedded
_links- schema property: user.json#/properties/_links