Contents x
    Create a System Contact
    • 13 Jun 2025
    • 7 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Create a System Contact

    • Updated on 13 Jun 2025
    • 7 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /hcm-rest-api/rest/1/syscontact

    Overview

    The System Contact API is used to create, view and manage contacts. Contacts can be company contacts, business partners, vendors or customers of the company entity setup in CMiC.

    UI Navigation

    System > Security > Users> User Maintenance

    Reference Article

    https://docs.cmicglobal.com/portal/Content/E_Reference_Material/DocuSign_Integration/Reference/Using_System_Contacts.htm?Highlight

    Commonly Used Body Parameters

    CMiC UI FieldnameObjectNameDescriptionTypeData LengthExampleRequired
    Contact CodesyscontactGsyscContactCodeUnique user defined code to identify a contact recordstring10DA, ZA, DP, ZALL, VB, A1EL-JJYes
    Partner CodesyscontactGsyscPartnCodeCode representing the partner company/ organization the contact belongs to.string8ZZ, TRHI1, A1ELECT, MAESTRO, VBCYes
    Partner Type CodesyscontactGsyscPartnTypeCodeContact type: Business partner, organization, or company, determined by the GsyscPartnCode of the organization with which this contact is associated.string1Company ‘C’ or ‘P’ Partner.Yes
    Last Update DatesyscontactGsyscLastUpdDateDate when the contact record was last updated.datetime2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ...Yes
    Html Email (Checkbox)syscontactGsyscHtmlEmailFlagIndicates if HTML emails are preferred, Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’Yes
    Email 1syscontactGsyscEmail1Primary email addressstring100da@cmic.caNo
    Is Active (Checkbox)syscontactGsyscActiveFlagA flag indicating whether the contact is active (“Y”) or not active (“N”).string1Yes – ‘Y’ / No – ‘N’No
    Employee NumbersyscontactGsyscEmpNoEmployee number associated with the contact codestring16TRHI-WK-SAL1No
    VUUIDsyscontactGsyscVUuidVirtual Unique Universal Identifier used to retrieve this single record from CMiC.string649EDA99A5DD392163E0530100007F16DDNo

    Other (Optional) Body Parameters

    CMiC UI FieldnameObjectNameDescriptionTypeData LengthExampleRequired
    First NamesyscontactGsyscFirstNameContact's first namestring60WalterNo
    Middle NamesyscontactGsyscMiddleNameContact's middle namestring60HartwellNo
    Last NamesyscontactGsyscLastNameContact's last namestring60WhiteNo
    PrefixsyscontactGsyscPrefixNamePrefix for the contact's name (e.g., Mr., Ms., Dr.)string16Mr.No
    Contact DescriptionsyscontactGsyscContactDescDescription or notes about the contact codestring300Consultant, Owner, Electrical Engineer, TestingNo
    Address Company CodesyscontactGsyscAddCompCodeCode representing the contact’s company addressstring8ZZ, SUS, CCC, …No
    Address CodesyscontactGsyscAddCodeUser defined Address code, identifying the address. Used for reports and log builder.string8ALL, ZSCH, CCC-OH, ...No
    Address Line 1syscontactGsyscAddLine1First line of the contact's addressstring40137 Union StreetNo
    Address Line 2syscontactGsyscAddLine2Second line of the contact's addressstring400No
    Address Line 3syscontactGsyscAddLine3Third line of the contact's addressstring400No
    Region CodesyscontactGsyscRegionCodeCode representing the geographical region of the contactstring3NY – New YorkNo
    Postal CodesyscontactGsyscPostalCodePostal or ZIP code of the contact's addressstring1289120No
    CountrysyscontactGsyscCountryCountry of the contact's addressstring30USANo
    Work Phone NumbersyscontactGsyscWorkPhoneNumWork phone number of the contactstring100(416) 555-0123No
    Home Phone NumbersyscontactGsyscHomePhoneNumHome phone number of the contactstring100(416) 555-0123No
    Mobile NumbersyscontactGsyscMobileNumMobile phone number of the contactstring40(416) 555-0123No
    Pager NumbersyscontactGsyscPagerNumPager number (if applicable)string407736529999No
    Fax Number 1syscontactGsyscFaxNum1Primary fax numberstring100888-567-0023No
    Fax Number 2syscontactGsyscFaxNum2Secondary fax numberstring100888-555-0023No
    Email 2syscontactGsyscEmail2Secondary email addressstring100ravi.venkatachalam@cmic.caNo
    Website URLsyscontactGsyscWwwSiteContact's website URLstring100<www.cmicglobal.com>No
    CLV Value Code 1syscontactGsyscClvValueCode1Classifier Value 1. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    CLV Value Code 2syscontactGsyscClvValueCode2Classifier Value 2. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    CLV Value Code 3syscontactGsyscClvValueCode3Classifier Value 3. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    CLV Value Code 4syscontactGsyscClvValueCode4Classifier Value 4. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    CLV ValueCode 5syscontactGsyscClvValueCode5Classifier Value 5. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    CLV Value Code 6syscontactGsyscClvValueCode6Classifier Value 6. This is a user defined custom code. Users can add up to 6 additional values to the Contact record.string160No
    PM Role CodesyscontactGsyscPmRoleCodeProject Role this contact has been assigned to under project managementstring10MASTER, PROJCOORD, RVMNGRNo
    Other DetailssyscontactGsyscOtherUsed for additional details or miscellaneous information about the contactstring2000No
    Preferred Contact MethodsyscontactGsyscPrefContactMthPreferred method of contacting the contact (e.g., Email, Phone)string10MAIL, EMAIL, PhoneNo
    Is Primary (Checkbox)syscontactGsyscPrimaryFlagIndicates if the contact is a Primary Contact for the organization specified by Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’No
    Is Bid ContactsyscontactGsyscBidFlagThis flag indicates if the contact is a bidding contact Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’No
    Last Update UsersyscontactGsyscLastUpdUserUser who last updated the contact recordstring30DAR, UIG, ALV12, ...No
    Collaboration User (checkbox)syscontactGsyscCollabUserFlagIndicates if the contact is a collaboration user, Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’No
    Collaboration Usage PricesyscontactGsyscCollabUsagePricePricing related to collaboration usagenumber180No
    Independent Contractor (Checkbox)syscontactGsyscIndepContractorFlagIndicates if the contact is an independent contractor. Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’No
    #N/AsyscontactGsysAltFaxMethodPrefix#N/Astring60#N/ANo
    #N/AsyscontactGsysAltFaxMethodSuffix#N/Astring100#N/ANo
    Alternative Fax Method (Checkbox)syscontactGsyscAltFaxMethodFlagIndicates if an alternative fax method is used for the contact Yes - "Y" / No - "N".string1Yes – ‘Y’ / No – ‘N’No
    Alternative Fax Method PrefixsyscontactGsyscAltFaxMethodPrefixPrefix for alternative fax methods for the contactstring600No
    Alternative Fax Method SuffixsyscontactGsyscAltFaxMethodSuffixSuffix for alternative fax methods for the contactstring1000No
    HRSS Role CodesyscontactGsyscHrssRoleCodeThis is the HR Role assigned to the contact for approving related HR ESS Workflowsstring10DANo
    Name SuffixsyscontactGsyscSuffixNameSuffix for the contact's name (e.g., Jr., Sr., III)string60Jr., Sr., IIINo
    Employee Trade CodesyscontactGpyempTradeCodeCode representing the employee contacts trade or specialty of the GsyscEmpNostring411PCH, 1610, CE28No
    Trade NamesyscontactGpytrdTradeNameName of the trade or specialty for the above GpyempTradeCode for GsyscEmpNostring300No
    Trade RatesyscontactGpytrdTradeRateRate associated with the trade or specialty of the GpyempTradeCodenumber160No
    Trade Charge RatesyscontactGpytrdTradeChargeRateCharge rate for the trade or specialty of the GpyempTradeCodenumber160No
    Trade Billing RatesyscontactGpytrdTradeBillingRateBilling rate for the trade or specialty of the GpyempTradeCodenumber160No
    Employee Company CodesyscontactGpyempCompCodeCode representing the employee's company for GsyscEmpNostring8ZZC, TRHI2, PYUSNo
    Employee WRL CodesyscontactGpyempWrlCodeWRL (Workforce Resource Locator) code for the employee for GsyscEmpNostring15ZCHI, 123No
    Employee WRL NamesyscontactGpyempWrlNameWRL (Workforce Resource Locator) name for the employee for GsyscEmpNostring4000Company ZZ West ChicagoNo
    Integration User Create DatesyscontactGsyscIuCreateDateDate when this contact record was created in CMiC. Should YYYY-MM-DDThh:mm:ssZdatetime2010-06-25T10:51:17-04:00, 2016-01-05T10:44:33-05:00, ...No
    Integration User Update DatesyscontactGsyscIuUpdateDateDate when the this contact record was updated in CMiC.datetime2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ...No
    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "GsyscEmpNo": null, "GsyscEmail1": "jane.doe@cmicglobal.com", "GsyscPartnCode": "013035", "GsyscPartnTypeCode": "P", "GsyscContactCode": "KC", "GsyscLastUpdDate": "2022-09-19T17:35:13Z", "GsyscHtmlEmailFlag": "N", "GsyscActiveFlag": "Y", "GsyscVUuid": "" }
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
  "GsyscContactCode": "KC",
  "GsyscFirstName": null,
  "GsyscMiddleName": null,
  "GsyscLastName": null,
  "GsyscPrefixName": null,
  "GsyscEmpNo": null,
  "GsyscContactDesc": null,
  "GsyscAddCompCode": null,
  "GsyscAddCode": null,
  "GsyscAddLine1": null,
  "GsyscAddLine2": null,
  "GsyscAddLine3": null,
  "GsyscRegionCode": null,
  "GsyscPostalCode": null,
  "GsyscCountry": null,
  "GsyscWorkPhoneNum": null,
  "GsyscHomePhoneNum": null,
  "GsyscMobileNum": null,
  "GsyscPagerNum": null,
  "GsyscFaxNum1": null,
  "GsyscFaxNum2": null,
  "GsyscEmail1": "jane.doe@cmicglobal.com",
  "GsyscEmail2": null,
  "GsyscWwwSite": null,
  "GsyscClvValueCode1": null,
  "GsyscClvValueCode2": null,
  "GsyscClvValueCode3": null,
  "GsyscClvValueCode4": null,
  "GsyscClvValueCode5": null,
  "GsyscClvValueCode6": null,
  "GsyscPmRoleCode": null,
  "GsyscOther": null,
  "GsyscPrefContactMth": null,
  "GsyscActiveFlag": "Y",
  "GsyscPartnCode": "013035",
  "GsyscPartnTypeCode": "P",
  "GsyscPrimaryFlag": null,
  "GsyscBidFlag": null,
  "GsyscLastUpdDate": "2022-09-19T17:35:13Z",
  "GsyscLastUpdUser": null,
  "GsyscCollabUserFlag": null,
  "GsyscCollabUsagePrice": null,
  "GsyscHtmlEmailFlag": "N",
  "GsyscIndepContractorFlag": null,
  "GsysAltFaxMethodPrefix": null,
  "GsysAltFaxMethodSuffix": null,
  "GsyscAltFaxMethodFlag": null,
  "GsyscAltFaxMethodPrefix": null,
  "GsyscAltFaxMethodSuffix": null,
  "GsyscHrssRoleCode": null,
  "GsyscSuffixName": null,
  "GpyempTradeCode": null,
  "GpytrdTradeName": null,
  "GpytrdTradeRate": null,
  "GpytrdTradeChargeRate": null,
  "GpytrdTradeBillingRate": null,
  "GpyempCompCode": null,
  "GpyempWrlCode": null,
  "GpyempWrlName": null,
  "GsyscVUuid": "F2A8505593052DDBE05316821FAC9500",
  "GsyscIuCreateDate": null,
  "GsyscIuUpdateDate": null,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/syscontact/F2A8505593052DDBE05316821FAC9500",
      "name": "syscontact",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/syscontact/F2A8505593052DDBE05316821FAC9500",
      "name": "syscontact",
      "kind": "item"
    }
  ]
}
    object
    What's Next
    Contact Us
    Copyright © 2024 CMiC All Rights Reserved