API create object from template

Kleinrotti

As far as I know it not possible to use the I-doit API to create an object from a template.
If so, would it be possible to add this to the API Addon?

LFischer

Hey @kleinrotti

thats correct - you can not directly use the i-doit template system to "mass create" objects by existing templates, but you CAN create objects and use their defined "default template", if this helps you out.

In order to do so simply pass the option defaultTemplate with any "truthy" value (for example "defaultTemplate": true or "defaultTemplate": 1.

I hope this helps you out

Kleinrotti

@lfischer First of all thanks for your quick response.
This would help a little bit but unfortunately this isn't working for some reason.
If a pass the parameter "defaultTemplate" as descripted I get this response:

The given value is not unique and is already being used in other objects: <ul class="m0 mt10 list-style-none"><li><span>Monitor » MON-TEMP-236</span></li></ul><br />{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "id": 43554,
        "message": "Object was successfully created",
        "success": true
    }
}

The object was created but not with the default template which is selected in the Idoit settings.
But this only seems to happen with Idoit PRO. On my test machine with Idoit OPEN everything works as expected.

I used for both installations Idoit 1.17.1 with API Addon 1.12.1.

LFischer

Hey @kleinrotti

the error message comes from the internal validation, but sadly it does not mention which category or attribute are responsible This might prevent one (or more) categories from being created.
I'll note this down as a bug - the error message should be part of the API response.

Could you check your validation and if the object does (aside from the affected category) match your default profile?

Kleinrotti

@lfischer The only validation we have is, that the object title needs to be unique. I have tried several object types like Printer, Monitor, Client but I get this error with all them. I tried different templates which I set as default but no chance. Every time the object is created, but none of the categories, no matter which template is set as default, are applied.

Here is a screenshot from our validation settings.

LFischer

Hey @kleinrotti

that's interesting - but I believe we should be able to reproduce this issue very easily. Are you using any placeholders in your object title (either the default template and the object you try to create)?

I will adjust the bug I previously created... I'm afraid I have no "work around" up my sleeve, so you might need to wait for a new API version.

I'll also create a feature request regarding "create object from template"

Kleinrotti

@lfischer No I don't use placeholders in titles of the objects/templates.
For testing purposes I disabled the validation/unique setting for the title and it's working this way - no error. But I need this settings for production, so I have to enable it again.
This bug definitely has something to do with the validation setting.
I would really appreciate if that bug could be fixed and if that feature request would be implemented.

Kleinrotti

@LFischer Are there already any news when a bugfix will be released?

LFischer

Hey @kleinrotti

sadly I have no updates yet, currently we are working on the i-doit 1.17.2 version which is going to be released shortly.
I believe after that we will check the API add-on

Best regards

Kleinrotti

Hey @LFischer
are there any new information?

LFischer

Hi @kleinrotti ,

I'm afraid I have no new information for you Right now the team is working on the upcoming i-doit 1.18 version. There will also be a API release around that time, but it will not contain this feature.

Best regards

Kleinrotti

@lfischer
And what about the bugfix for the default template? Even that would help me

LFischer

Hey @kleinrotti

again - sadly no updates regarding this topic

Kleinrotti

It's quite a while now but are there new information to this topic?
Unfortunately our workflow is not that good due to this bug. Every time we want to mass import ordered products from delivery notes with a tool, we have to disable the validation with a user which has the appropriate rights in i-doit. Afterwards we have to enable it again. This causes loss in time or if someone forgets to disable the validation, the products are not imported correctly and it has to be repeated.
Or is there a possibility to provide a pull request for the official API-Addon to provide a bug fix myself?

leobaer

Hi
Did you check
system settings > Tenantsettings > Unique checks > object title
But I don't know if this is only valid for the Extras > import mechanism or for API as well.

Du you really need global unique titles in your daily processes? Maybe "Unique (per Object type)" is sufficient (but not sure if this triggers the bug or not)

Regards
Leo

Kleinrotti

@leobaer Sorry for my late reply. Your idea to change the global unique setting to "Unique per Object type" worked. Using this setting works without the error. Thanks for that

I was also able to implement the feature to use templates in the API Addon by my self. Happily this was just a few lines of code.

FlatErik

@Kleinrotti
Hi Kleinrotti,

We are also looking for a solution to create a new object from a template using the API. Could you explain what exactly you implemented in the API addon to make it work?

Grüße!

Erik

Kleinrotti

@FlatErik I added these lines of code to the file isys_api_model_cmdb_object.class.php at line 262 of the API Addon (Version 1.12.3).

if (isset($p_params['useTemplate']) && $p_params['useTemplate']) {
                    // Get template module.
                    $l_template_module = new isys_module_templates();

                    $l_template_module->create_from_template(
                        [$p_params['useTemplate']],
                        $p_params['type'],
                        $p_params['title'],
                        $l_return['id'],
                        false,
                        1,
                        '',
                        $p_params['category'],
                        $p_params['purpose']
                    );
                }

Sample API Request:

{
    "version": "2.0",
    "id": "1",
    "method": "cmdb.object.create",
    "params": {
        "apikey": "xyz",
        "language": "de",
        "type": "C__OBJTYPE__CLIENT",
        "title": "CLIENT-TEMP-638001685961295254",
        "purpose": null,
        "cmdb_status": 0,
        "description": null,
        "category": null,
        "useTemplate": 583
    }

useTemplate provides the Id of the template.

mamawe

@Kleinrotti I can confirm that this works with API version 1.13 too.

Thanks a lot, this saves some API calls when importing a few hundred switches and makes the scripts easier to write.

Kind regards,
Mathias

FlatErik

Hey @Kleinrotti, Hey @mamawe !

could someone please tell us, where do we find the template id?
We tried the whole thing with the object id of the template.. but i didnt work.

Regrads
Erik