NPDS/ScribeRestLib/Help

Index | Help | Examples

Querystring key-value pairs valid for all NPDS web service URLs include:

• Logical switches
  • "ef": echo format with ef={1|0} or ef={true|false} turns on/off response that includes a copy of the request URL
  • "qf": query format with qf={1|0} or qf={true|false} turns on/off case-sensitive find intended for unique exact match instead of case-insensitive search for multiple partial matches
  • "tf": test format with tf={1|0} or tf={true|false} turns on/off response with schema validation
  • "vf": verbose format with ef={1|0} or ef={true|false} turns on/off response with more detailed information
• Integer values
  • "lc": list count with lc={value} sets maximum number of records returned in the response
• String switches
  • "rf": resrep format with rf={nexus|portal|doors|core} sets the resource representation format for the records returned in the response if supported by the server accessed; see pages 180-181 of the Metadata about Metadata article in Future Internet.

Querystring keys valid for NPDS query URLs include:

• "enam": enam={value} filters records on the EntityName field
• "enat": enat={value} filters records on the EntityNature field
• "etag": etag={value} filters records on the EntityPrincipalTag field
• "etyp": etyp={value} filters records on the EntityType field
• "tagany": tagany={value} filters records on the EntityTag fields (either the EntityPrincipalTag or EntityAliasTags)
• "tagsup": tagsup={value} filters records on the EntitySupportingTag fields
• "labany": labany={value} filters records on the EntityLabel fields (either the EntityCanonicalLabel or EntityAliasLabels)
• "labsup": labsup={value} filters records on the EntitySupportingLabel fields
• "labcan": labcan={value} filters records on the EntityCanonicalLabel field
• "labals": labals={value} filters records on the EntityAliasLabel fields

A future version of this web service will enable additional filters on other fields.