Category: File Assignment#

The File Assignment category links files and documents to an object. It is a multi-value category -- any number of files can be assigned per object, e.g. a manual, a network diagram, and a configuration backup simultaneously.

Usage#

Typical use cases:

• Manuals and data sheets: Upload the PDF manual of a server or switch as a file object and assign it to the device. This way, every technician has the manual readily available directly in the CMDB object, without having to search through network drives.
• Network diagrams and drawings: Visio files, PNG topologies, or rack layout plans can be assigned to the affected rooms, cabinets, or sites. During a renovation, it is immediately apparent which plan applies.
• Configuration backups: Store the last exported configuration of a switch or router as a text file. In combination with the revision field, a simple version control can be established.
• Contracts and license documents: Attach scans of maintenance contracts or license certificates to the respective object. In combination with the Contract Assignment category, a complete contract documentation is created.
• External documents via link: Instead of uploading a file, an HTTP link to an external document can be set -- for example, to a Confluence wiki, a SharePoint document, or a manufacturer download.

Fields#

File#

The link to a file object. Using the object browser, you select an existing file object or create a new one. The file object itself contains the actual file (upload) as well as metadata such as file name, version, and category.

Revision#

The revision number of the linked file. This field is taken from the file object and shows which version of the file is currently assigned. For an updated configuration file, this might show e.g. 3 for the third revision.

HTTP Link (external)#

An external link as an alternative or supplement to the file upload. Here you can enter the URL to a document in an external system, e.g. https://wiki.example.com/manual-core-switch. This is especially practical when documents are centrally maintained in a DMS and should not be uploaded to i-doit twice.

Description#

Free text for additional information about the file assignment: what the file is for, when it was last updated, who is the contact for the content, or which chapters of the manual are relevant for this specific device.

Technical Reference#

Fields (API Reference)#

API Examples#

Create an entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 1042,
        "category": "C__CATG__FILE",
        "data": {
            "file": 2048,
            "link": "https://wiki.example.com/handbuch-core-switch",
            "description": "Herstellerhandbuch Cisco Catalyst 9300, Version 17.6"
        }
    },
    "id": 1
}

Read entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "object": 1042,
        "category": "C__CATG__FILE"
    },
    "id": 2
}

Update an entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 1042,
        "category": "C__CATG__FILE",
        "entry": 15,
        "data": {
            "link": "https://wiki.example.com/handbuch-core-switch-v2",
            "description": "Aktualisiert auf Firmware-Version 17.9, news Kapitel zu SD-Access"
        }
    },
    "id": 3
}