Changes between Version 18 and Version 19 of UniformClearinghouseAPIV2
- Timestamp:
- 11/13/13 10:32:57 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
UniformClearinghouseAPIV2
v18 v19 254 254 # type: type of object to be updated 255 255 # urn: URN of object to update 256 # options: Contains ‘fields’ key referring dictionary of name/value pairs to update 256 # options: Contains ‘fields’ key referring dictionary of 257 # name/value pairs to update 257 258 # 258 259 # Return: None … … 265 266 # Deletes an object instance specified by URN 266 267 # Only a single object can be deleted from a single update call. 267 # Note: not all objects can be deleted. In general, it is a matter of authority policy. 268 # Note: not all objects can be deleted. In general, it is a matter 269 # of authority policy. 268 270 # 269 271 # Arguments: … … 280 282 # Lookup requested details for objects matching ‘match’ options. 281 283 # This call takes a set of ‘match’ criteria provided in the ‘options’ field, 282 # and returns a dictionary of dictionaries of object attributes keyed by object URN matching these criteria. 283 # If a ‘filter’ option is provided, only those attributes listed in the ‘filter’ options are returned. 284 # The requirements on match criteria supported by a given service are service-specific; 285 # however it is recommended that policies restrict lookup calls to requests that are bounded 284 # and returns a dictionary of dictionaries of object attributes 285 # keyed by object URN matching these criteria. 286 # If a ‘filter’ option is provided, only those attributes listed in the ‘filter’ 287 # options are returned. 288 # The requirements on match criteria supported by a given service 289 # are service-specific; however it is recommended that policies 290 # restrict lookup calls to requests that are bounded 286 291 # to particular sets of explicitly listed objects (and not open-ended queries). 287 292 # … … 302 307 Some additional details on the lookup call: 303 308 304 The options argument to the lookup _*call is a dictionary. It contains an entry with key ‘match’ that contains a dictionary of name/value pairs. The names are of fields listed in the get_version for that object. The values are values for those fields to be matched. The semantics of the match is to be an “AND” (all fields must match).309 The options argument to the lookup call is a dictionary. It contains an entry with key ‘match’ that contains a dictionary of name/value pairs. The names are of fields listed in the get_version for that object. The values are values for those fields to be matched. The semantics of the match is to be an “AND” (all fields must match). 305 310 306 311 The value in the dictionary of a ‘match’ option can be a list of scalars, indicating an “OR”. For example, a list of URNs provided to the SLICE_URN key would match any slice with any of the listed URNs.