Replace an utility configuration
put
/admin/utilityConfigurations/{id}
Request
Path Parameters
-
id(required): string
The id of the UtilityConfigurations to be updated
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
OK
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed 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
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed 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
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed 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
404 Response
Not Found
Root Schema : Error
Type:
objectUsed 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
409 Response
Conflict
Root Schema : Error
Type:
objectUsed 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
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed 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
Examples
The following example shows how to replace an utility configuration by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X PUT
https://{FABRIC_HOST}/admin/utilityConfigurations -H
"Content-Type: application/json" -D @replace_utilconfig.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
{
"app": "CX4U",
"ConfigurableTypes": [
{
"name": "IdentifierType",
"description": "Holds the lookup values for Additional Identifier types",
"configurations": [
{
"ccsValue": "SSN",
"faValue": "SEN",
"isPrimary": true
},
{
"ccsValue": "DriverLicense",
"faValue": "DRIVER_LICENSE"
}
]
},
{
"name": "CommunicationType",
"description": "Holds the lookup values for COMMUNICATION_TYPE",
"configurations": [
{
"ccsValue": "CSS",
"faValue": "WEB"
},
{
"ccsValue": "FAX",
"faValue": "TLX"
}
]
},
{
"name": "ContactPurpose",
"description": "Holds the lookup values for CONTACT_PURPOSE type",
"configurations": [
{
"ccsValue": "PERSONAL",
"faValue": "PERSONAL"
}
]
}
],
"KMConfigurations": [
{
"name": "Data",
"description": "Holds the data needed for KM Configuration",
"configurations": [
{
"locationId": "locId1",
"locationName": "locName1",
"kmId": "articleId1",
"kmTitle": "article1"
},
{
"locationId": "locId1",
"locationName": "locName2",
"kmId": "articleId2",
"kmTitle": "article2"
}
]
}
],
"ExtendedFields": [
{
"name": "Fields",
"description": "Holds the Extended fields mapping",
"configurations": [
{
"ccsValue": "Field1",
"faValue": "Feild1_EXT"
},
{
"ccsValue": "Field2",
"faValue": "Feild2_EXT"
}
]
}
],
"Settings": [
{
"name": "assets",
"description": "Placeholder for general settings",
"configurations": [
{
"name": "visible",
"value": "true"
},
{
"name": "inActiveTimePeriodInMonths",
"value": "3"
}
]
}
]
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"app": "CX4U",
"ConfigurableTypes": [
{
"name": "IdentifierType",
"description": "Holds the lookup values for Additional Identifier types",
"configurations": [
{
"ccsValue": "SSN",
"faValue": "SEN",
"isPrimary": true
},
{
"ccsValue": "DriverLicense",
"faValue": "DRIVER_LICENSE"
}
]
},
{
"name": "CommunicationType",
"description": "Holds the lookup values for COMMUNICATION_TYPE",
"configurations": [
{
"ccsValue": "CSS",
"faValue": "WEB"
},
{
"ccsValue": "FAX",
"faValue": "TLX"
}
]
},
{
"name": "ContactPurpose",
"description": "Holds the lookup values for CONTACT_PURPOSE type",
"configurations": [
{
"ccsValue": "PERSONAL",
"faValue": "PERSONAL"
}
]
}
],
"KMConfigurations": [
{
"name": "Data",
"description": "Holds the data needed for KM Configuration",
"configurations": [
{
"locationId": "locId1",
"locationName": "locName1",
"kmId": "articleId1",
"kmTitle": "article1"
},
{
"locationId": "locId1",
"locationName": "locName2",
"kmId": "articleId2",
"kmTitle": "article2"
}
]
}
],
"ExtendedFields": [
{
"name": "Fields",
"description": "Holds the Extended fields mapping",
"configurations": [
{
"ccsValue": "Field1",
"faValue": "Feild1_EXT"
},
{
"ccsValue": "Field2",
"faValue": "Feild2_EXT"
}
]
}
],
"Settings": [
{
"name": "assets",
"description": "Placeholder for general settings",
"configurations": [
{
"name": "visible",
"value": "true"
},
{
"name": "inActiveTimePeriodInMonths",
"value": "3"
}
]
}
]
}