Seitenvergleich

Verwaltung von Datei-Versionen.

Seitenverzeichnis:

Inhalt

maxLevel	2
indent	10px
style	square

...

shd.file_version.read

Beschreibung

Gibt alle Dateidie aktuelle Datei-Version eines Datei Objektes oder optional aller Datei Objekte zurück.

Beispielaufruf

Lesen einer speziellen Datei-Version:

Codeblock

language	bash
theme	RDark

{
	"method":"

...

shd.file_version.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Beispielantwort

Eigenschaften einer Datei-Version:

Codeblock

language	bash
theme	RDark

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "2",
            "obj_id": "4",
            "obj_title": "guest ",
            "version_id": "4",
            "version_title": "MyFile",
            "version_description": "",
            "version_revision": "3",
            "physical_file_id": "4",
            "physical_file_name": "my_file.txt",
            "physical_file_filename": "4__1560014584__my_file.txt",
            "category_id": null,
            "category_title": null,
            "category_description": null,
            "url": "?moduleID=2&file_manager=get&f_id=7",
        }
    ]
}

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datei Objektes

ab Version 1.0

include_file

boolean

Optional: Gibt die jeweilige Datei als base64-kodierte Zeichenkette zurück.

Zulässige Werte:

1: Gibt die Datei zurück
0: Gibt keine Datei zurück

ab Version 1.0

Rückgabewert

Eigenschaften einer Datei-Version.

DatenbankeintragescountAnzahl der Spalten

Wert	Typ	Beschreibung	Version
id	int	ID der Datei	ab Version 1.0
obj_id	int	ID des	zugewiesenen Objektes	ab Version 1.0
obj_title	string	Name des zugewiesenen Objektes	ab Version 1.0
version_id	int	ID der Version	ab Version 1.0
version_title	string	Titel der Vorlageder Version	ab Version 1.0
version_description	string	Beschreibung der Version	ab Version 1.0column
version_	revision	int	Jeweilige Revision des Datensatzes	ab Version 1.0
rowphysical_file_countid	int	Anzahl ID der Zeilenphysischen Datei	ab Version 1.0
versionphysical_file_name	string	Originaler Dateiname	ab Version der Rahmen-Vorlage1.0
physical_file_filename	string	Name der Datei im System	ab Version 1.0
iscategory_templateid	int	Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann.	ab Version 1.0

...

ID der Kategorie der Datei (siehe Hinweis am Ende dieses Abschnittes)	ab Version 1.0
category_title	string	Name der Kategorie der Datei	ab Version 1.0
category_description	string	Beschreibung der Kategorie der Datei	ab Version 1.0
url	string	URL zum Abruf der Datei in der i-doit Weboberfläche	ab Version 1.0
file	string	Datei als base64-kodierte Zeichenkette (wenn die Option "include_file" gesetzt wurde)	ab Version 1.0

Hinweis: Die verfügbaren Kategorien können über folgende Abfrage ermittelt werden:

Codeblock

language	bash
theme	RDark

{
	"method":"cmdb.dialog.read",
	"params":{
		"apikey":"24174j3tqj",
		"category":"C__CATS__FILE",
		"property":"file_category"
	},
	"version":"2.0",
    "id": 1
}

...

shd.file_version.versions

Beschreibung

Legt eine neue Datei inklusive ihrer Datei-Version anGibt alle Versionen einer Datei aus.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"patchshd.file_version.versions",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Typ

Beschreibung

Version

id

int

ID des Objektes

ab Version 1.0

include_file

boolean

Optional: Gibt die jeweilige Datei als base64-kodierte Zeichenkette zurück.

Zulässige Werte:

1: Gibt die Datei zurück
0: Gibt keine Datei zurück

ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
id	int	ID der Version	ab Version 1.0
title	string	Titel der Version	ab Version 1.0
description	string	Beschreibung der Version	ab Version 1.0
revision	int	Jeweilige Revision des Datensatzes	ab Version 1.0
physical_file_id	int	ID der physischen Datei	ab Version 1.0
physical_file_name	string	Originaler Dateiname	ab Version 1.0
physical_file_filename	string	Name der Datei im System	ab Version 1.0
url	string	URL zum Abruf der Datei in der i-doit Weboberfläche	ab Version 1.0
file	string	Datei als base64-kodierte Zeichenkette (wenn die Option "include_file" gesetzt wurde)	ab Version 1.0

...

shd.file_version.create

Beschreibung

Legt eine neue Datei inklusive ihrer Datei-Version an.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"

...

shd.file_version.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"

...

obj_id":

...

4,

...

"title": "MyFile",
            "file": "xyz...",
            "

...

filename":

...

"my_file.txt"
		}
	},
	"version":"2.0",
    "id": 1
}

Beispielantwort

Codeblock

language	bash
theme	RDark

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "message": "file_version.create.success",
        "id": "2",
        "current_date": "2019-06-08"
    }
}

Parameter

Parameter	Typ	Beschreibung	Version
titleobj_id	string	Titel der Vorlageint	ID des zugewiesenen Objektes	ab Version 1.0
column_counttitle	intstring	Anzahl Name der SpaltenDatei	ab Version 1.0
row_countfile	intstring	Anzahl Inhalt der ZeilenDatei base64 kodiert	ab Version 1.0
versionfilename	string	Optional: Version der Rahmen-VorlageDateiname der Datei	ab Version 1.0
iscategory_templateid	int	Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. Zulässige Werte: 0: keine Vorlage für weitere Rahmen 1: Vorlage für weitere Rahmen ID der Kategorie (siehe Hinweis am Ende des ersten Abschnittes)	ab Version 1.0
description	string	Optional: Beschreibung der Datei	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

...

shd.file_version.update

Beschreibung

Aktualisiert eine bestehende Datei-Version.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"patchshd.file_version.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"title":"Panel 2",
			"column_count": 8
NewFile"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintragesder Version	ab Version 1.0
title	string	Titel Name der VorlageDatei	ab Version 1.0
column_count	int	Anzahl der Spalten	ab Version 1.0
row_count	int	Anzahl der Zeilen	ab Version 1.0
version	string	Version der Rahmen-Vorlage	ab Version 1.0
is_template	int	Optional: Flag, ob dieses Element als Vorlage für mehrere Rahmen dienen kann. Zulässige Werte: 0: keine Vorlage für weitere Rahmen 1: Vorlage für weitere Rahmen	description	string	Beschreibung der Datei	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

...

shd.file_version.delete

Beschreibung

Löscht eine bestehende Datei inklusive ihrer Datei-Version.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"patchshd.file_version.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
version_id	int	ID der zu löschenden Datei-Version	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

...

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

Seitenverzeichnis:

shd.file_version.read

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

Rückgabewert

shd.file_version.versions

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

shd.file_version.create

Beschreibung

Beispielaufruf

Beispielantwort

Parameter

Rückgabewert

shd.file_version.update

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

shd.file_version.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert