API v2 Endpunkte

Die neue Struktur ist viel strenger und erlaubt eine bessere Validierung der übergebenen Parameter und es ist nun möglich, deutlich strukturiertere und einfacher Endpunkte zu erstellen. Die neue Struktur wird einen neuen Service verwenden, d.h. die v2 API wird eine interne (i-doit Kern) v2 API verwenden.

Dies soll sicherstellen, dass die v2 API keine spezielle "eigene" Logik mehr implementiert. Die v2 API dient lediglich als Schnittstelle.

Eine Dokumentation wird von der API selbst bereitgestellt über:

1
2
3
4
5
6
7
8
9
{
"version": "2.0",
"method": "system.endpoints.read.v2",
"params": {
    "apikey": "KEY",
    "language": "en"
},
"id": 1
}
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "cmdb.category.archive.v2": {
            "description": "Will archive a singular category entry from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    },
                    "category": {
                        "type": "string",
                        "description": "Category string constant",
                        "has-validation": true
                    },
                    "entry": {
                        "type": "integer",
                        "description": "Numeric entry ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.category.delete.v2": {
            "description": "Will delete a singular category entry from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    },
                    "category": {
                        "type": "string",
                        "description": "Category string constant",
                        "has-validation": true
                    },
                    "entry": {
                        "type": "integer",
                        "description": "Numeric entry ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.category.purge.v2": {
            "description": "Will purge a singular category entry from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    },
                    "category": {
                        "type": "string",
                        "description": "Category string constant",
                        "has-validation": true
                    },
                    "entry": {
                        "type": "integer",
                        "description": "Numeric entry ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.external.pull.v2": {
            "description": "Get object and category data based on external identifier",
            "parameters": {
                "required": {
                    "extType": {
                        "type": "string",
                        "description": "First part of external identifier used to identify the data source",
                        "has-validation": true
                    }
                },
                "optional": {
                    "extId": {
                        "type": "string",
                        "description": "Second part of external identifier used to identifiy the asset",
                        "has-validation": true,
                        "default-value": null
                    }
                }
            }
        },
        "cmdb.external.push.v2": {
            "description": "Push an object and its category entries at ones based on your external identifier",
            "parameters": {
                "required": {
                    "extType": {
                        "type": "string",
                        "description": "First part of external identifier used to identify the data source",
                        "has-validation": true
                    },
                    "extId": {
                        "type": "string",
                        "description": "Second part of external identifier used to identifiy the asset",
                        "has-validation": true
                    },
                    "title": {
                        "type": "string",
                        "description": "Object title of asset which should be created if not exist",
                        "has-validation": true
                    },
                    "class": {
                        "type": "string",
                        "description": "Object type of asset which should be created if not exist",
                        "has-validation": true
                    },
                    "data": {
                        "type": "array",
                        "description": "Category data for asset",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.object.archive.v2": {
            "description": "Will archive a singular object from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.object.delete.v2": {
            "description": "Will delete a singular object from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.object.purge.v2": {
            "description": "Will purge a singular object from i-doit",
            "parameters": {
                "required": {
                    "object": {
                        "type": "integer",
                        "description": "Numeric object ID",
                        "has-validation": true
                    }
                },
                "optional": []
            }
        },
        "cmdb.report.list.v2": {
            "description": "Lists up all available reports, based on your rights. To execute a report use \"cmdb.report.read.v2\".",
            "parameters": {
                "required": [],
                "optional": []
            }
        },
        "cmdb.report.read.v2": {
            "description": "Reads a report.",
            "parameters": {
                "required": {
                    "id": {
                        "type": "integer",
                        "description": "The report ID",
                        "has-validation": true
                    }
                },
                "optional": {
                    "offset": {
                        "type": "integer",
                        "description": "Set a offset to skip the first n rows, can be used together with \"limit\" to page.",
                        "has-validation": true,
                        "default-value": null
                    },
                    "limit": {
                        "type": "integer",
                        "description": "Limit how many rows should be returned, can be used together with \"offset\" to page.",
                        "has-validation": true,
                        "default-value": null
                    }
                }
            }
        },
        "system.endpoints.read.v2": {
            "description": "Will read all registered endpoints of the new structure",
            "parameters": {
                "required": [],
                "optional": []
            },
            "example-request": {
                "basic example": {
                    "version": "2.0",
                    "method": "system.endpoints.read.v2",
                    "params": {
                        "apikey": "api-key"
                    },
                    "id": 1
                }
            }
        }
    }
}