Document Operations

Link documents

<small>Requires an API token with the Document Manager role.</small>

POST

/documents/{document}/linked-documents

Link documents

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/{document}/linked-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "other_document_uuid": "848b471e-2f1d-47c3-8c25-ad3f292097aa",
  "relationship_type": "parent_of"
}
'

{
  "data": {
    "controller_document": {
      "archived_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "links": {
        "latest_revision_pdf": "https:...",
        "latest_revision_pdf_download": "https:...",
        "show": "https:..."
      },
      "locale": "de-AT",
      "name": "Kundenvertrag Muster GmbH",
      "origin": "signed_pdf",
      "parties": [
        {
          "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
          "created_at": "2023-11-07T05:31:56Z",
          "entity_name": "Demo Inc.",
          "is_internal_party": true,
          "is_ready_for_signing": true,
          "ready_for_signing_at": "2023-11-07T05:31:56Z",
          "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "reference": "Employer",
          "scope": "internal",
          "updated_at": "2023-11-07T05:31:56Z",
          "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
        }
      ],
      "stage": "draft",
      "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "peripheral_document": {
      "archived_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "links": {
        "latest_revision_pdf": "https:...",
        "latest_revision_pdf_download": "https:...",
        "show": "https:..."
      },
      "locale": "de-AT",
      "name": "Kundenvertrag Muster GmbH",
      "origin": "signed_pdf",
      "parties": [
        {
          "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
          "created_at": "2023-11-07T05:31:56Z",
          "entity_name": "Demo Inc.",
          "is_internal_party": true,
          "is_ready_for_signing": true,
          "ready_for_signing_at": "2023-11-07T05:31:56Z",
          "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "reference": "Employer",
          "scope": "internal",
          "updated_at": "2023-11-07T05:31:56Z",
          "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
        }
      ],
      "stage": "draft",
      "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
    },
    "relationship_type": "parent",
    "uuid": "c9872112-75dd-4d57-93ea-b8a305eabadb"
  }
}

Creates a relationship between the document referred to by the URL and another document. Allows representing relationships such as parent-child, amendment, renewal, etc. between documents.

The values that are sent in the request body will be normalised to create a "document relationship" where one of the documents is the "controller document" and the other is the "peripheral document". The resulting normalised relationship type will be one of the values defined in the DocumentRelationshipType enum. The normalised form of the relationship is what is returned in the response.

The following table shows how the different relationship types will be normalised and which role each of the documents will end up playing in the resulting relationship:

Request `relationship_type`	Normalised type	URL document's role	Other document's role
`parent_of`	`parent`	controller_document	peripheral_document
`child_of`	`parent`	peripheral_document	controller_document
`amendment_to`	`amendment`	controller_document	peripheral_document
`amended_by`	`amendment`	peripheral_document	controller_document
`renewal_of`	`renewal`	controller_document	peripheral_document
`renewed_by`	`renewal`	peripheral_document	controller_document
`addition_to`	`addition`	controller_document	peripheral_document
`added_to_by`	`addition`	peripheral_document	controller_document
`replacement_of`	`replacement`	controller_document	peripheral_document
`replaced_by`	`replacement`	peripheral_document	controller_document
`termination_of`	`termination`	controller_document	peripheral_document
`terminated_by`	`termination`	peripheral_document	controller_document

Autorisierungen

Authorizationstringheadererforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

documentstringerforderlich

The document UUID

Body

other_document_uuidstringerforderlich

UUID of the document to link to

Beispiel: 848b471e-2f1d-47c3-8c25-ad3f292097aa

relationship_typeenum<string>erforderlich

The type of relationship between the documents

Verfügbare Optionen: parent_of, child_of, amendment_to, amended_by, renewal_of, renewed_by, addition_to, added_to_by, replacement_of, replaced_by, termination_of, terminated_by

Beispiel: parent_of

Antwort

DocumentRelationshipResource

dataobjecterforderlich

child attributes anzeigen

Brauchen Sie noch Hilfe? Team fragen