Introduction

Document model

For more details, see Document model in Operations Management API

Example

{
    "id": 15,
    "confirmable": true,
    "title": "Fire instructions",
    "description": "Describes how to behave in case of fire",
    "created_by": { "entity_type": "token", "entity_id": 491 },
    "deadline_at": "2020-12-15T15:43:32.000Z",
    "created_at": "2020-11-30T17:12:46.435Z",
    "updated_at": "2020-11-30T17:12:50.235Z",
    "confirmed_at": "2020-11-30T17:12:50.235Z",
    "public_access": true
}

Definition

Key	Type	Optional	Description
id	integer	no
confirmable	boolean	no	Is document meant to be confirmed by recipient?
title	string	no
description	string	no
created_by	API entity	no	Author of document
deadline_at	datetime	when not confirmable	Time until document is meant to be confirmed by recipients - only for `confirmable` documents
created_at	datetime	no	Time of creation
updated_at	datetime	no	Time of last update
confirmed_at	datetime	yes	Time of confirmation by current user
public_access	boolean	no	Document with public access

Document model#

Example#

Definition#

Document model

Example

Definition