Replace a tenant configuration

put

/admin/tenantConfigurations/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Show Source
Nested Schema : TenantConfiguration
Type: object
Show Source
Nested Schema : settings
Type: array
Show Source
Nested Schema : TenantConfigurationSetting
Type: object
Show Source
Nested Schema : configurations
Type: array
Show Source
Nested Schema : TenantConfigurationSettingConfig
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : TenantConfiguration
Type: object
Show Source
Nested Schema : settings
Type: array
Show Source
Nested Schema : TenantConfigurationSetting
Type: object
Show Source
Nested Schema : configurations
Type: array
Show Source
Nested Schema : TenantConfigurationSettingConfig
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
Back to Top

Examples

The following example shows how to replace a tenant configuration by submitting a PUT request on the REST resource using cURL.

curl -H 'Authorization: Bearer <Token>' -X PUT https://{FABRIC_HOST}/admin/tenantConfigurations -H "Content-Type: application/json" -D @replace_tenantconfig.json | json_pp

Example of Request Body

The following shows an example of the request body.

[
    {
        "name": "unspecifiedDashboardTiles",
        "scope": "UI",
        "settings": [
            {
                "name": "assets",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "billUnitBalances",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "serviceRequests",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "count",
                        "value": "6"
                    }
                ]
            }
        ]
    },
    {
        "name": "billingDashboardTiles",
        "scope": "UI",
        "settings": [
            {
                "name": "billHistory",
                "configurations": [
                    {
                        "name": "limit",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "paymentHistory",
                "configurations": [
                    {
                        "name": "limit",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "bills",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "serviceRequests",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "count",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "accountReceivables",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "adjustmentsCount",
                        "value": "6"
                    }
                ]
            }
        ]
    },
    {
        "name": "targetUrls",
        "scope": "UI",
        "settings": [
            {
                "name": "serviceRequestListPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST"
                    }
                ]
            },
            {
                "name": "contactDetailPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/crmUI/faces/FuseOverview?fndGlobalItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM_CARD&fndTaskItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM&fnd=;subTabName=Overview%253BContactPartyId={{contactId}};;;;false;256;;"
                    }
                ]
            },
            {
                "name": "serviceRequestEditPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST&objKey=srNumber={{srNumber}}&action=EDIT_IN_TAB"
                    }
                ]
            }
        ]
    },
    {
        "name": "adjustmentThresholds",
        "scope": "Functional",
        "settings": [
            {
                "name": "currencyThreshold",
                "configurations": [
                    {
                        "name": "positiveThreshold",
                        "value": "1"
                    },
                    {
                        "name": "negativeThreshold",
                        "value": "-1"
                    }
                ]
            }
        ]
    },
    {
        "name": "brmConfigurations",
        "scope": "Functional",
        "settings": [
            {
                "name": "adjustmentReasons",
                "configurations": [
                    {
                        "name": "ORA_ATC_NOT_SATISFIED_SERVICE",
                        "value": "1"
                    },
                    {
                        "name": "ORA_ATC_CHARGE_UNAWARE",
                        "value": "2"
                    },
                    {
                        "name": "ORA_ATC_DEBIT_MISTAKE",
                        "value": "3"
                    },
                    {
                        "name": "ORA_ATC_SUPPORT_CHARGES",
                        "value": "4"
                    },
                    {
                        "name": "ORA_ATC_SERVICE_CHARGES",
                        "value": "5"
                    }
                ]
            }
        ]
    },
    {
        "name": "generalSettings",
        "scope": "UI",
        "settings": [
            {
                "name": "billingPeriod",
                "configurations": [
                    {
                        "name": "numberOfYears",
                        "value": "4"
                    }
                ]
            },
            {
                "name": "useFusionAppsUserPreference",
                "configurations": [
                    {
                        "name": "dateTimeFormat",
                        "value": "false"
                    },
                    {
                        "name": "numberFormat",
                        "value": "false"
                    }
                ]
            },
            {
                "name": "currencySymbol",
                "configurations": [
                    {
                        "name": "placement",
                        "value": "before"
                    }
                ]
            }
        ]
    }
]

Example of Response Body

The following example shows the contents of the response body in JSON format, including <additoinal information>:

[
    {
        "name": "unspecifiedDashboardTiles",
        "scope": "UI",
        "settings": [
            {
                "name": "assets",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "billUnitBalances",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "serviceRequests",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "count",
                        "value": "6"
                    }
                ]
            }
        ]
    },
    {
        "name": "billingDashboardTiles",
        "scope": "UI",
        "settings": [
            {
                "name": "billHistory",
                "configurations": [
                    {
                        "name": "limit",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "paymentHistory",
                "configurations": [
                    {
                        "name": "limit",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "bills",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    }
                ]
            },
            {
                "name": "serviceRequests",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "count",
                        "value": "6"
                    }
                ]
            },
            {
                "name": "accountReceivables",
                "configurations": [
                    {
                        "name": "visible",
                        "value": "true"
                    },
                    {
                        "name": "adjustmentsCount",
                        "value": "6"
                    }
                ]
            }
        ]
    },
    {
        "name": "targetUrls",
        "scope": "UI",
        "settings": [
            {
                "name": "serviceRequestListPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST"
                    }
                ]
            },
            {
                "name": "contactDetailPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/crmUI/faces/FuseOverview?fndGlobalItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM_CARD&fndTasjItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM&fnd=;subTabName=Overview%253BContactPartyId={{contactId}};;;;false;256;;"
                    }
                ]
            },
            {
                "name": "serviceRequestEditPage",
                "configurations": [
                    {
                        "name": "target",
                        "value": "https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST&objKey=srNumber={{srNumber}}&action=EDIT_IN_TAB"
                    }
                ]
            }
        ]
    },
    {
        "name": "adjustmentThresholds",
        "scope": "Functional",
        "settings": [
            {
                "name": "currencyThreshold",
                "configurations": [
                    {
                        "name": "positiveThreshold",
                        "value": "1"
                    },
                    {
                        "name": "negativeThreshold",
                        "value": "-1"
                    }
                ]
            }
        ]
    },
    {
        "name": "brmConfigurations",
        "scope": "Functional",
        "settings": [
            {
                "name": "adjustmentReasons",
                "configurations": [
                    {
                        "name": "ORA_ATC_NOT_SATISFIED_SERVICE",
                        "value": "1"
                    },
                    {
                        "name": "ORA_ATC_CHARGE_UNAWARE",
                        "value": "2"
                    },
                    {
                        "name": "ORA_ATC_DEBIT_MISTAKE",
                        "value": "3"
                    },
                    {
                        "name": "ORA_ATC_SUPPORT_CHARGES",
                        "value": "4"
                    },
                    {
                        "name": "ORA_ATC_SERVICE_CHARGES",
                        "value": "5"
                    }
                ]
            }
        ]
    },
    {
        "name": "generalSettings",
        "scope": "UI",
        "settings": [
            {
                "name": "billingPeriod",
                "configurations": [
                    {
                        "name": "numberOfYears",
                        "value": "4"
                    }
                ]
            },
            {
                "name": "useFusionAppsUserPreference",
                "configurations": [
                    {
                        "name": "dateTimeFormat",
                        "value": "false"
                    },
                    {
                        "name": "numberFormat",
                        "value": "false"
                    }
                ]
            },
            {
                "name": "currencySymbol",
                "configurations": [
                    {
                        "name": "placement",
                        "value": "before"
                    }
                ]
            }
        ]
    }
]
Back to Top