AgileApps Support Wiki

REST API:companyInfo Resource

From AgileApps Support Wiki
Revision as of 08:38, 12 July 2022 by Wikieditor (talk | contribs) (→‎Fields)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Considerations
(Language codes comply with the ISO 639-1 language codes standard.)

Access Permissions

Lock-tiny.gif

Users that have the Access Control permission can use the companyInfo Resource.. 

Get CompanyInfo

Retrieve details for a company.

Method
GET
URI
https://{yourDomain}/networking/rest/companyInfo
Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <companyInfo>
       <id>1325580066</id>
       <name>BobSmithCo</name>
       <street>123 Maple Ave</street>
       <city>Seatle</city>
       <state>WA</state>
       <zip>85495</zip>
       <country>United States</country>
       <date_created>2010-11-12T13:14:15Z</date_created>
       <modified_id type="" 
         uri="https://{domainname}/networking/rest/user/1424089492" 
         displayValue="Peter Parker">1424089492</modified_id>
       <date_modified>2010-11-12T13:14:15Z</date_modified>
       <default_locale>en_US</default_locale>
       <currency_locale>en_US</currency_locale>
       <language>en</language>
       <company_logo type="DOCUMENT" uri=
         "https://{yourDomain}/networking/rest/record/DOCUMENT/51f6bcedde6341ecb7d910643cf0ce77" 
         displayValue="bugs1">51f6bcedde6341ecb7d910643cf0ce77</company_logo>
       <date_format>MM/dd/yyyy</date_format>
       <currency_format>$</currency_format>
       <copy_support_emails_to/>
       <copy_import_emails_to/>
       <time_zone>23</time_zone>
       <starting_app_id>4</starting_app_id> 
       <enabled_all_record_access_log>true</enabled_all_record_access_log>
       <enabled_all_access_violations_log>true</enabled_all_access_violations_log>
       <signature_algorithm>RSA</signature_algorithm>
       <namespace>space1</namespace>
       <generated_classes_package_name>com.platform.space1.generatedobjectclasses
         </generated_classes_package_name>
       <supported_languages>es,en</supported_languages>
       <social_enabled>true</social_enabled>
       <social_feed_retention_days>365</social_feed_retention_days>
       <compliance_bcc_email>archive@xyz.com</compliance_bcc_email>
       <show_view_record_count>true<show_view_record_count>
   </companyInfo>
   
   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Update CompanyInfo

Updates Company information.

Method
PUT
URI
https://{yourDomain}/networking/rest/companyInfo
Request
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <companyInfo>
       <name>BobSmithCo</name>
       <street>123 Maple Ave</street>
       <city>Seatle</city>
       <state>WA</state>
       <zip>85495</zip>
       <country>United States</country>
       <default_locale>en_US</default_locale>
       <currency_locale>en_US</currency_locale>
       <language>en</language>
       <company_logo>51f6bcedde6341ecb7d910643cf0ce77</company_logo>
       <date_format>MM/dd/yyyy</date_format>
       <currency_format>$</currency_format>
       <copy_support_emails_to>12312,123SA12,34R3S23121</copy_support_emails_to>
       <copy_import_emails_to>12312,5633S32,123DFWD232SWD</copy_import_emails_to>
       <time_zone>23</time_zone>
       <starting_app_id>4</starting_app_id> 
       <enabled_all_record_access_log>true</enabled_all_record_access_log>
       <enabled_all_access_violations_log>true</enabled_all_access_violations_log>
       <signature_algorithm>RSA</signature_algorithm>        
       <supported_languages>es,en</supported_languages>
       <social_enabled>true</social_enabled>
       <social_feed_retention_days>365</social_feed_retention_days>
       <compliance_bcc_email>archive@xyz.com</compliance_bcc_email>
       <show_view_record_count>true<show_view_record_count>
       </companyInfo>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>        
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Name Type Attribute Required During Add Description Additional Information
id String Read Only Record Id
name String Editable on Add/Update Checkmark.gif Company Name Ensure that the company name does not exceed 100 characters.
street String Editable on Add/Update Checkmark.gif
city String Editable on Add/Update Checkmark.gif
state String Editable on Add/Update Checkmark.gif
zip String Editable on Add/Update Checkmark.gif
country String Editable on Add/Update Checkmark.gif
default_locale String Editable on Add/Update The locale used for number formats and percentages. A 2-letter language code combined with a 2-letter country code.
Ex: en_US
currency_locale String Editable on Add/Update The locale used for the currency formats. A 2-letter language code combined with a 2-letter country code.
Ex: en_US
language String Editable on Add/Update Checkmark.gif Default language for new users Any two letter language code (for example, - 'en', 'es','pt') that is available to the tenant
company_logo Lookup Editable on Add/Update Document object recordId Retrieve from the Document object using the record Resource
compliance_bcc_email String Editable on Add/Update An address or comma separated list of addresses to Bcc on outgoing messages
date_format String Editable on Add/Update Checkmark.gif Date_Format
currency_format String Editable on Add/Update Checkmark.gif
copy_support_emails_to String Editable on Add/Update Comma-separated list of email addresses to receive copies of support-related communications users
copy_import_emails_to String Editable on Add/Update Comma-separated list of email addresses to receive copies of import status notifications
time_zone Integer Editable on Add/Update Checkmark.gif Time Zone Codes
starting_app_id Integer Editable on Add/Update ID of default application for new users Application ID must exist in the tenant space.
enabled_all_record_access_log Boolean Editable on Add/Update Whether or not Record Access activity is logged
enabled_all_access_violations_log Boolean Editable on Add/Update Whether or not Access Violations are logged LastColNotes
signature_algorithm String Editable on Add/Update Checkmark.gif Algorithm used to generate keys 'DSA' and 'RSA' are the only permitted values
supported_languages String Editable on Add/Update Comma-separated list of supported languages Example: "en","fr","de","it","es","pt", "zh"
social_enabled Boolean Editable on Add/Update Enable or disable Relay (social networking) Defaults to false
social_feed_retention_days Number Editable on Add/Update Number of days to retain Relay feeds Defaults to 365
date_created Date Read Only UTC Format
date_modified Date Read Only UTC Format
modified_id Lookup Read Only User ID
related_task_ownership_change_type String Editable on Add/Update 0 - Assign To New Record Owner; 1 - Retain To Existing Record Owner
trigger_status_update String Editable on Add/Update 0 - Does not open the Case; 1 - Open the Case ServiceDesk Case Settings
enable_html_sanitization Boolean Editable on Add/Update Select the checkbox - enabled; Clear the checkbox - disabled By default, it is disabled.
show_view_record_count Boolean Editable on Add/Update Select the checkbox - enabled; Clear the checkbox - disabled By default, it is enabled for existing and new tenant. When enabled you can see the record count in the Cases Views section.
hide_excel_print Boolean Editable on Add/Update Select the checkbox - enabled; Clear the checkbox - disabled By default, it is disabled for existing and new tenant.
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=REST_API:companyInfo_Resource&oldid=28674"