Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Register a new citation source in the document store.
  • Operation ID: citations.sources.insert
  • API member path: editor.doc.citations.sources.insert(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a CitationSourceMutationResult indicating success with the source address or a failure.

​
Input fields

FieldTypeRequiredDescription
fieldsobjectyes
fields.authorsobject[]no
fields.citystringno
fields.doistringno
fields.editionstringno
fields.editorobject[]no
fields.issuestringno
fields.journalNamestringno
fields.mediumstringno
fields.pagesstringno
fields.publisherstringno
fields.shortTitlestringno
fields.standardNumberstringno
fields.titlestringno
fields.translatorobject[]no
fields.urlstringno
fields.volumestringno
fields.yearstringno
typeenumyes"book", "journalArticle", "conferenceProceedings", "report", "website", "patent", "case", "statute", "thesis", "film", "interview", "misc"

​
Example request

{
  "fields": {
    "authors": [
      {
        "first": "example",
        "last": "example",
        "middle": "example"
      }
    ],
    "title": "example"
  },
  "type": "book"
}

​
Output fields

​
Variant 1 (source.kind=“entity”)

FieldTypeRequiredDescription
sourceobject(kind=“entity”)yes
source.entityType"citationSource"yesConstant: "citationSource"
source.kind"entity"yesConstant: "entity"
source.sourceIdstringyes
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "source": {
    "entityType": "citationSource",
    "kind": "entity",
    "sourceId": "example"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "fields": {
      "additionalProperties": false,
      "properties": {
        "authors": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "first": {
                "type": "string"
              },
              "last": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              }
            },
            "required": [
              "last"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "city": {
          "type": "string"
        },
        "doi": {
          "type": "string"
        },
        "edition": {
          "type": "string"
        },
        "editor": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "first": {
                "type": "string"
              },
              "last": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              }
            },
            "required": [
              "last"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "issue": {
          "type": "string"
        },
        "journalName": {
          "type": "string"
        },
        "medium": {
          "type": "string"
        },
        "pages": {
          "type": "string"
        },
        "publisher": {
          "type": "string"
        },
        "shortTitle": {
          "type": "string"
        },
        "standardNumber": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "translator": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "first": {
                "type": "string"
              },
              "last": {
                "type": "string"
              },
              "middle": {
                "type": "string"
              }
            },
            "required": [
              "last"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "url": {
          "type": "string"
        },
        "volume": {
          "type": "string"
        },
        "year": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": {
      "enum": [
        "book",
        "journalArticle",
        "conferenceProceedings",
        "report",
        "website",
        "patent",
        "case",
        "statute",
        "thesis",
        "film",
        "interview",
        "misc"
      ]
    }
  },
  "required": [
    "type",
    "fields"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "source": {
          "additionalProperties": false,
          "properties": {
            "entityType": {
              "const": "citationSource"
            },
            "kind": {
              "const": "entity"
            },
            "sourceId": {
              "type": "string"
            }
          },
          "required": [
            "kind",
            "entityType",
            "sourceId"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "source"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "source": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "citationSource"
        },
        "kind": {
          "const": "entity"
        },
        "sourceId": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "entityType",
        "sourceId"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "source"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}