How can we help?

Searching:

0 results found
backBack

tenantTemplates/Patch or tenantTemplates/Put

PATCH /odata/tenantTemplates/Patch/[tenantTemplateId]

– OR –

PUT /odata/tenantTemplates/Put/[tenantTemplateId]

Description

To update an existing Axonize Tenant Manifest (template).

See the following for request and response details ‒

See Also

Request ‒ tenantTemplates/Patch or Put

In the request, specify the ID of the Tenant Manifest (template) whose definition to change and the name of the property(s) to change. These properties are described in tenantTemplates/Post.

For the Patch endpoint, all unspecified fields remain unchanged.

For the Put endpoint, all unspecified fields are assigned default values.

Property Type Description Mandatory
appId String A unique identifier that is automatically generated by Axonize for this Application.

This property is used to link between other entities (such as Users and Devices) and this Application.

 Y
id String A unique identifier for this Tenant Manifest (template) that is automatically generated. Please note that this ID is only intended for internal use by Axonize. Y

 

Example JSON tenantTemplates/Patch Request

curl -X PATCH \

  https://api.dev.axonize.com/odata/tenantTemplates/5cc073c2e3b0cb26c4db5a0f \

  -H ‘Accept: application/json, text/plain, */*’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \

  -H ‘cache-control: no-cache’ \

  -d ‘{

                “name”: “tenantTemplate1”

}’

Example JSON tenantTemplates/Put Request

curl -X PUT \

  https://api.dev.axonize.com/odata/tenantTemplates/5cc073c2e3b0cb26c4db5a0f \

  -H ‘Accept: application/json, text/plain, */*’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \

  -H ‘cache-control: no-cache’ \

  -d ‘{

                “name”: “tenantTemplate1”,

                “appId” : “1aaf017c-b987-4f53-94d6-ad9afb8e4767”,

        “settings”:

                {

        “tenantLogo” : “Logo”,

        “tenantDarkLogo” : null,

        “color” : null,

        “cultureInfo” : null,

        “passwordPolicy” : null,

        “reportPrefix” : null,

        “reportColor” : null,

        “timezone” : null,

        “security” : null,

        “colorDark” : null,

        “favicon” : null,

        “loginLogo” : null,

       “title” : null,

        “cssExternalFile” : null,

        “hideLegacyDashboard” : null,

        “azureADConnect” : null,

        “inviteEmail” : null,

        “resetPasswordEmail” : null,

        “forgotPasswordEmail” : null,

        “reportEmail” : null

                }

}’

Response ‒ tenantTemplates/Patch or Put

Example JSON tenantTemplates/Patch/Put Response

Status 204 – No Content