Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The GET, POST, and PUT columns indicate if the attribute is required ("yes"), optional ("opt"), or must not have ("no")k.

Attribute

GET

POST

PUT

Notes

namespace

yes

yes

yes

codeValue

yes

yes

yes

Value preferred to be one or more words rather than a numeric code or random string.

shortDescription

yes

yes

yes

description

yes if a value was provided in POST / PUT

opt

opt

Longer description that may contain additional normative usage guidance.

effectiveBeginDate

yes if a value was provided in POST / PUT

opt

opt

Date for display only, not validation

effectiveEndDate

yes if a value was provided in POST / PUT

opt

opt

Date for display only, not validation

id

yes

no

yes

_etag

opt

no

no

Required when the host implements etags.

xyzDescriptorId

opt

no

no

Retained only for backward-compliance with existing ODS/API implementations.

priorDescriptorId

opt

no

no

Retained only for backward-compliance with existing ODS/API implementations.

lastModifiedDateTime

opt

no

no

Date for display only, not validation

...