Document apiReferenceCitations

citations.sources.update

Update the fields of an existing citation source.

mutates documentdry runidempotent
doc.citations.sources.update(…)

Expected result

Returns a CitationSourceMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"entity"required
entityType"citationSource"required
sourceIdstringrequired
patchobjectrequired
Fields
titlestring
authorsobject[]
yearstring
publisherstring
citystring
journalNamestring
volumestring
issuestring
pagesstring
urlstring
doistring
editionstring
editorobject[]
translatorobject[]
mediumstring
shortTitlestring
standardNumberstring

Result

Output fields
true
successtruerequired
sourceobjectrequired
Fields
kind"entity"required
entityType"citationSource"required
sourceIdstringrequired
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