PUT /service/callHomeGeneral

Use this method to modify the general Call Home configuration settings.

This request modifies the general Call Home configuration. When this request is made for the first time, it creates an associated Default Call Home forwarder that matches all devices from the management server.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://{management_server_IP}/service/callHomeGeneral

Query parameters

None

Request body

You can specify contact information using one of the following sets of attributes.

Table 1. Primary and secondary contacts.
Attributes Required / Optional Type Description
primaryContact Optional Object Information about the primary contact
  fullName Optional String Contact name
  companyName Optional String Company name
  contactEmail Optional String Contact email address
  contactPhone Optional String Contact phone number
  streetAddress Optional String Address
  city Optional String City
  stateProvince Optional String State or province
  postalCode Optional String Postal code
  country Optional String Country
  preferredContactMethod Optional String Preferred contact method key

To get at list of keys for supported contact methods, use GET /service/contactMethods.

secondaryContacts Optional Array of objects Information about one or more secondary contacts
  fullName Optional String Contact name
  companyName Optional String Company name
  contactEmail Optional String Contact email address
  contactPhone Optional String Contact phone number
  streetAddress Optional String Address
  city Optional String City
  stateProvince Optional String State or province
  postalCode Optional String Postal code
  country Optional String Country or region
  preferredContactMethod Optional String Preferred contact method key

To get at list of keys for supported contact methods, use GET /service/contactMethods.

The following example modifies the general Call Home configuration settings.

{
   "primaryContact": {
      "fullName": "John",
      "companyName": "SomeCompany",
      "country": "RO",
      "contactEmail": "john@company.com",
      "contactPhone": "+41234567890",
      "streetAddress": "Calea Floreasca 169A",
      "city": "Bucharest",
      "stateProvince": "BU",
      "postalCode": "012345"
      "preferredContactMethod": "any"
   },
   "secondaryContacts": [{
      "fullName": "Jane",
      "companyName": "SomeCompany",
      "contactEmail": "jane@company.com",
      "contactPhone": "+41234567891",
      "country": "RO",
      "streetAddress": "Calea Floreasca 169A",
      "city": "Bucharest",
      "stateProvince": "BU",
      "postalCode": "012345"
      "preferredContactMethod": "email"
   }]
}
Table 2. Contact and system information.
Important: These attributes will be deprecated at a future date.
Attributes Required / Optional Type Description
companyName Optional String Contact company
contactName Optional String Contact name
email Optional String Contact email
phoneNumber Optional String Contact phone number
address Optional String Contact address
city Optional String Contact city
stateProvince Optional String Contact state or province
zipCode Optional String Contact zip code
countryAbv Optional String Contact country or region abbreviation (for example, RO for Romania)
systemCompany Optional String Contact company for the device
systemName Optional String Contact name for the device
systemEmail Optional String Contact email address for the device
systemPhoneNumber Optional String Contact phone number for the device
systemAddress Optional String Address where the device is located
systemCity Optional String City where the device is located
systemZipCode Optional String Zip code where the device is located
​systemStateProvince Optional String State where the device is located
systemCountryAbv Optional String Country or region abbreviation where the device is located

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
The following example is returned if the request is successful.
{
   messages: [
      0: {
         explanation: "",
         id: "FQXHMSS1029I",
         recovery: {
            text: "",
         ​   url: ""​​
         },
         text: "The configuration for Call Home was successfully saved. Forwarder 'Default Call Home'
            was created with this configuration.",
         result: "success"​
      }
   ]
}