Document apiReferenceAuthorities

authorities.entries.update

Update the properties of an existing TA authority entry.

mutates documentdry runidempotent
doc.authorities.entries.update(…)

Expected result

Returns an AuthorityEntryMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"authorityEntry"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
patchobjectrequired
Fields
longCitationstring
shortCitationstring
categorystring | integer
Variant 1

No fields.

Variant 2

No fields.

boldboolean
italicboolean

Result

Output fields
true
successtruerequired
entryobjectrequired
Fields
kind"inline"required
nodeType"authorityEntry"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas