REST API for Oracle Digital Experience for Communications Industry Fabric

Replace a tenant configuration

put

/admin/tenantConfigurations/{id}

Request

Path Parameters

id(required): string

The id of the tenant configuration

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object TenantConfiguration

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfiguration"
    }
}

Nested Schema : TenantConfiguration

Type: object

Show Source

name: string

Pattern: ^[a-zA-Z0-9_]+$
scope: string

Allowed Values: [ "Functional", "UI" ]
settings: array settings

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "scope":{
            "type":"string",
            "enum":[
                "Functional",
                "UI"
            ]
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TenantConfigurationSetting"
            }
        }
    }
}

Nested Schema : settings

Type: array

Show Source

Array of: object TenantConfigurationSetting

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfigurationSetting"
    }
}

Nested Schema : TenantConfigurationSetting

Type: object

Show Source

configurations: array configurations
name: string

Pattern: ^[a-zA-Z0-9_]+$

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "configurations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TenantConfigurationSettingConfig"
            }
        }
    }
}

Nested Schema : configurations

Type: array

Show Source

Array of: object TenantConfigurationSettingConfig

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfigurationSettingConfig"
    }
}

Nested Schema : TenantConfigurationSettingConfig

Type: object

Show Source

name: string

Pattern: ^[a-zA-Z0-9_]+$
value: string

Pattern: ^[a-zA-Z0-9.\_\/\-\:\{\}\;\=\?\,\&\%]+$

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "value":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9.\\_\\/\\-\\:\\{\\}\\;\\=\\?\\,\\&\\%]+$"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: object TenantConfiguration

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfiguration"
    }
}

Nested Schema : TenantConfiguration

Type: object

Show Source

name: string

Pattern: ^[a-zA-Z0-9_]+$
scope: string

Allowed Values: [ "Functional", "UI" ]
settings: array settings

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "scope":{
            "type":"string",
            "enum":[
                "Functional",
                "UI"
            ]
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TenantConfigurationSetting"
            }
        }
    }
}

Nested Schema : settings

Type: array

Show Source

Array of: object TenantConfigurationSetting

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfigurationSetting"
    }
}

Nested Schema : TenantConfigurationSetting

Type: object

Show Source

configurations: array configurations
name: string

Pattern: ^[a-zA-Z0-9_]+$

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "configurations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TenantConfigurationSettingConfig"
            }
        }
    }
}

Nested Schema : configurations

Type: array

Show Source

Array of: object TenantConfigurationSettingConfig

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TenantConfigurationSettingConfig"
    }
}

Nested Schema : TenantConfigurationSettingConfig

Type: object

Show Source

name: string

Pattern: ^[a-zA-Z0-9_]+$
value: string

Pattern: ^[a-zA-Z0-9.\_\/\-\:\{\}\;\=\?\,\&\%]+$

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9_]+$"
        },
        "value":{
            "type":"string",
            "pattern":"^[a-zA-Z0-9.\\_\\/\\-\\:\\{\\}\\;\\=\\?\\,\\&\\%]+$"
        }
    }
}

400 Response

Bad Request

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

409 Response

Conflict

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

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"
                    }
                ]
            }
        ]
    }
]