> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a System Contact > ## 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 ## Commonly Used Body Parameters | CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required | | --- | --- | --- | --- | --- | --- | --- | --- | | Contact Code | syscontact | GsyscContactCode | Unique user defined code to identify a contact record | string | 10 | DA, ZA, DP, ZALL, VB, A1EL-JJ | Yes | | Partner Code | syscontact | GsyscPartnCode | Code representing the partner company/ organization the contact belongs to. | string | 8 | ZZ, TRHI1, A1ELECT, MAESTRO, VBC | Yes | | Partner Type Code | syscontact | GsyscPartnTypeCode | Contact type: Business partner, organization, or company, determined by the GsyscPartnCode of the organization with which this contact is associated. | string | 1 | Company ‘C’ or ‘P’ Partner. | Yes | | Last Update Date | syscontact | GsyscLastUpdDate | Date when the contact record was last updated. | datetime | | 2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ... | Yes | | Html Email (Checkbox) | syscontact | GsyscHtmlEmailFlag | Indicates if HTML emails are preferred, Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | Yes | | Email 1 | syscontact | GsyscEmail1 | Primary email address | string | 100 | | No | | Is Active (Checkbox) | syscontact | GsyscActiveFlag | A flag indicating whether the contact is active (“Y”) or not active (“N”). | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | Employee Number | syscontact | GsyscEmpNo | Employee number associated with the contact code | string | 16 | TRHI-WK-SAL1 | No | | VUUID | syscontact | GsyscVUuid | Virtual Unique Universal Identifier used to retrieve this single record from CMiC. | string | 64 | 9EDA99A5DD392163E0530100007F16DD | No | ## Other (Optional) Body Parameters | CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required | | --- | --- | --- | --- | --- | --- | --- | --- | | First Name | syscontact | GsyscFirstName | Contact's first name | string | 60 | Walter | No | | Middle Name | syscontact | GsyscMiddleName | Contact's middle name | string | 60 | Hartwell | No | | Last Name | syscontact | GsyscLastName | Contact's last name | string | 60 | White | No | | Prefix | syscontact | GsyscPrefixName | Prefix for the contact's name (e.g., Mr., Ms., Dr.) | string | 16 | Mr. | No | | Contact Description | syscontact | GsyscContactDesc | Description or notes about the contact code | string | 300 | Consultant, Owner, Electrical Engineer, Testing | No | | Address Company Code | syscontact | GsyscAddCompCode | Code representing the contact’s company address | string | 8 | ZZ, SUS, CCC, … | No | | Address Code | syscontact | GsyscAddCode | User defined Address code, identifying the address. Used for reports and log builder. | string | 8 | ALL, ZSCH, CCC-OH, ... | No | | Address Line 1 | syscontact | GsyscAddLine1 | First line of the contact's address | string | 40 | 137 Union Street | No | | Address Line 2 | syscontact | GsyscAddLine2 | Second line of the contact's address | string | 40 | 0 | No | | Address Line 3 | syscontact | GsyscAddLine3 | Third line of the contact's address | string | 40 | 0 | No | | Region Code | syscontact | GsyscRegionCode | Code representing the geographical region of the contact | string | 3 | NY – New York | No | | Postal Code | syscontact | GsyscPostalCode | Postal or ZIP code of the contact's address | string | 12 | 89120 | No | | Country | syscontact | GsyscCountry | Country of the contact's address | string | 30 | USA | No | | Work Phone Number | syscontact | GsyscWorkPhoneNum | Work phone number of the contact | string | 100 | (416) 555-0123 | No | | Home Phone Number | syscontact | GsyscHomePhoneNum | Home phone number of the contact | string | 100 | (416) 555-0123 | No | | Mobile Number | syscontact | GsyscMobileNum | Mobile phone number of the contact | string | 40 | (416) 555-0123 | No | | Pager Number | syscontact | GsyscPagerNum | Pager number (if applicable) | string | 40 |  7736529999 | No | | Fax Number 1 | syscontact | GsyscFaxNum1 | Primary fax number | string | 100 | 888-567-0023 | No | | Fax Number 2 | syscontact | GsyscFaxNum2 | Secondary fax number | string | 100 | 888-555-0023 | No | | Email 2 | syscontact | GsyscEmail2 | Secondary email address | string | 100 | | No | | Website URL | syscontact | GsyscWwwSite | Contact's website URL | string | 100 | | No | | CLV Value Code 1 | syscontact | GsyscClvValueCode1 | Classifier Value 1. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | CLV Value Code 2 | syscontact | GsyscClvValueCode2 | Classifier Value 2. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | CLV Value Code 3 | syscontact | GsyscClvValueCode3 | Classifier Value 3. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | CLV Value Code 4 | syscontact | GsyscClvValueCode4 | Classifier Value 4. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | CLV ValueCode 5 | syscontact | GsyscClvValueCode5 | Classifier Value 5. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | CLV Value Code 6 | syscontact | GsyscClvValueCode6 | Classifier Value 6. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No | | PM Role Code | syscontact | GsyscPmRoleCode | Project Role this contact has been assigned to under project management | string | 10 | MASTER, PROJCOORD, RVMNGR | No | | Other Details | syscontact | GsyscOther | Used for additional details or miscellaneous information about the contact | string | 200 | 0 | No | | Preferred Contact Method | syscontact | GsyscPrefContactMth | Preferred method of contacting the contact (e.g., Email, Phone) | string | 10 | MAIL, EMAIL, Phone | No | | Is Primary (Checkbox) | syscontact | GsyscPrimaryFlag | Indicates if the contact is a Primary Contact for the organization specified by Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | Is Bid Contact | syscontact | GsyscBidFlag | This flag indicates if the contact is a bidding contact Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | Last Update User | syscontact | GsyscLastUpdUser | User who last updated the contact record | string | 30 | DAR, UIG, ALV12, ... | No | | Collaboration User (checkbox) | syscontact | GsyscCollabUserFlag | Indicates if the contact is a collaboration user, Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | Collaboration Usage Price | syscontact | GsyscCollabUsagePrice | Pricing related to collaboration usage | number | 18 | 0 | No | | Independent Contractor (Checkbox) | syscontact | GsyscIndepContractorFlag | Indicates if the contact is an independent contractor. Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | #N/A | syscontact | GsysAltFaxMethodPrefix | #N/A | string | 60 | #N/A | No | | #N/A | syscontact | GsysAltFaxMethodSuffix | #N/A | string | 100 | #N/A | No | | Alternative Fax Method (Checkbox) | syscontact | GsyscAltFaxMethodFlag | Indicates if an alternative fax method is used for the contact Yes - "Y" / No - "N". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No | | Alternative Fax Method Prefix | syscontact | GsyscAltFaxMethodPrefix | Prefix for alternative fax methods for the contact | string | 60 | 0 | No | | Alternative Fax Method Suffix | syscontact | GsyscAltFaxMethodSuffix | Suffix for alternative fax methods for the contact | string | 100 | 0 | No | | HRSS Role Code | syscontact | GsyscHrssRoleCode | This is the HR Role assigned to the contact for approving related HR ESS Workflows | string | 10 | DA | No | | Name Suffix | syscontact | GsyscSuffixName | Suffix for the contact's name (e.g., Jr., Sr., III) | string | 60 | Jr., Sr., III | No | | Employee Trade Code | syscontact | GpyempTradeCode | Code representing the employee contacts trade or specialty of the GsyscEmpNo | string | 4 | 11PCH, 1610, CE28 | No | | Trade Name | syscontact | GpytrdTradeName | Name of the trade or specialty for the above GpyempTradeCode for GsyscEmpNo | string | 30 | 0 | No | | Trade Rate | syscontact | GpytrdTradeRate | Rate associated with the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No | | Trade Charge Rate | syscontact | GpytrdTradeChargeRate | Charge rate for the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No | | Trade Billing Rate | syscontact | GpytrdTradeBillingRate | Billing rate for the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No | | Employee Company Code | syscontact | GpyempCompCode | Code representing the employee's company for GsyscEmpNo | string | 8 | ZZC, TRHI2, PYUS | No | | Employee WRL Code | syscontact | GpyempWrlCode | WRL (Workforce Resource Locator) code for the employee for GsyscEmpNo | string | 15 | ZCHI, 123 | No | | Employee WRL Name | syscontact | GpyempWrlName | WRL (Workforce Resource Locator) name for the employee for GsyscEmpNo | string | 4000 | Company ZZ West Chicago | No | | Integration User Create Date | syscontact | GsyscIuCreateDate | Date when this contact record was created in CMiC. Should YYYY-MM-DDThh:mm:ssZ | datetime | | 2010-06-25T10:51:17-04:00, 2016-01-05T10:44:33-05:00, ... | No | | Integration User Update Date | syscontact | GsyscIuUpdateDate | Date when the this contact record was updated in CMiC. | datetime | | 2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ... | No | ## OpenAPI ````json POST /hcm-rest-api/rest/1/syscontact { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/hcm-rest-api/rest/1/syscontact": { "post": { "tags": [ "HCM | System Contacts" ], "summary": "Create a System Contact", "description": "## Overview\n\nThe 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. \n\n## UI Navigation\n\nSystem > Security > Users> User Maintenance\n\n## Reference Article\n\n\n\n## Commonly Used Body Parameters\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n| Contact Code | syscontact | GsyscContactCode | Unique user defined code to identify a contact record | string | 10 | DA, ZA, DP, ZALL, VB, A1EL-JJ | Yes |\n| Partner Code | syscontact | GsyscPartnCode | Code representing the partner company/ organization the contact belongs to. | string | 8 | ZZ, TRHI1, A1ELECT, MAESTRO, VBC | Yes |\n| Partner Type Code | syscontact | GsyscPartnTypeCode | Contact type: Business partner, organization, or company, determined by the GsyscPartnCode of the organization with which this contact is associated. | string | 1 | Company ‘C’ or ‘P’ Partner. | Yes |\n| Last Update Date | syscontact | GsyscLastUpdDate | Date when the contact record was last updated. | datetime | | 2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ... | Yes |\n| Html Email (Checkbox) | syscontact | GsyscHtmlEmailFlag | Indicates if HTML emails are preferred, Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | Yes |\n| Email 1 | syscontact | GsyscEmail1 | Primary email address | string | 100 | | No |\n| Is Active (Checkbox) | syscontact | GsyscActiveFlag | A flag indicating whether the contact is active (“Y”) or not active (“N”). | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| Employee Number | syscontact | GsyscEmpNo | Employee number associated with the contact code | string | 16 | TRHI-WK-SAL1 | No |\n| VUUID | syscontact | GsyscVUuid | Virtual Unique Universal Identifier used to retrieve this single record from CMiC. | string | 64 | 9EDA99A5DD392163E0530100007F16DD | No |\n\n## Other (Optional) Body Parameters\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n| First Name | syscontact | GsyscFirstName | Contact's first name | string | 60 | Walter | No |\n| Middle Name | syscontact | GsyscMiddleName | Contact's middle name | string | 60 | Hartwell | No |\n| Last Name | syscontact | GsyscLastName | Contact's last name | string | 60 | White | No |\n| Prefix | syscontact | GsyscPrefixName | Prefix for the contact's name (e.g., Mr., Ms., Dr.) | string | 16 | Mr. | No |\n| Contact Description | syscontact | GsyscContactDesc | Description or notes about the contact code | string | 300 | Consultant, Owner, Electrical Engineer, Testing | No |\n| Address Company Code | syscontact | GsyscAddCompCode | Code representing the contact’s company address | string | 8 | ZZ, SUS, CCC, … | No |\n| Address Code | syscontact | GsyscAddCode | User defined Address code, identifying the address. Used for reports and log builder. | string | 8 | ALL, ZSCH, CCC-OH, ... | No |\n| Address Line 1 | syscontact | GsyscAddLine1 | First line of the contact's address | string | 40 | 137 Union Street | No |\n| Address Line 2 | syscontact | GsyscAddLine2 | Second line of the contact's address | string | 40 | 0 | No |\n| Address Line 3 | syscontact | GsyscAddLine3 | Third line of the contact's address | string | 40 | 0 | No |\n| Region Code | syscontact | GsyscRegionCode | Code representing the geographical region of the contact | string | 3 | NY – New York | No |\n| Postal Code | syscontact | GsyscPostalCode | Postal or ZIP code of the contact's address | string | 12 | 89120 | No |\n| Country | syscontact | GsyscCountry | Country of the contact's address | string | 30 | USA | No |\n| Work Phone Number | syscontact | GsyscWorkPhoneNum | Work phone number of the contact | string | 100 | (416) 555-0123 | No |\n| Home Phone Number | syscontact | GsyscHomePhoneNum | Home phone number of the contact | string | 100 | (416) 555-0123 | No |\n| Mobile Number | syscontact | GsyscMobileNum | Mobile phone number of the contact | string | 40 | (416) 555-0123 | No |\n| Pager Number | syscontact | GsyscPagerNum | Pager number (if applicable) | string | 40 |  7736529999 | No |\n| Fax Number 1 | syscontact | GsyscFaxNum1 | Primary fax number | string | 100 | 888-567-0023 | No |\n| Fax Number 2 | syscontact | GsyscFaxNum2 | Secondary fax number | string | 100 | 888-555-0023 | No |\n| Email 2 | syscontact | GsyscEmail2 | Secondary email address | string | 100 | | No |\n| Website URL | syscontact | GsyscWwwSite | Contact's website URL | string | 100 | | No |\n| CLV Value Code 1 | syscontact | GsyscClvValueCode1 | Classifier Value 1. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| CLV Value Code 2 | syscontact | GsyscClvValueCode2 | Classifier Value 2. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| CLV Value Code 3 | syscontact | GsyscClvValueCode3 | Classifier Value 3. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| CLV Value Code 4 | syscontact | GsyscClvValueCode4 | Classifier Value 4. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| CLV ValueCode 5 | syscontact | GsyscClvValueCode5 | Classifier Value 5. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| CLV Value Code 6 | syscontact | GsyscClvValueCode6 | Classifier Value 6. This is a user defined custom code. Users can add up to 6 additional values to the Contact record. | string | 16 | 0 | No |\n| PM Role Code | syscontact | GsyscPmRoleCode | Project Role this contact has been assigned to under project management | string | 10 | MASTER, PROJCOORD, RVMNGR | No |\n| Other Details | syscontact | GsyscOther | Used for additional details or miscellaneous information about the contact | string | 200 | 0 | No |\n| Preferred Contact Method | syscontact | GsyscPrefContactMth | Preferred method of contacting the contact (e.g., Email, Phone) | string | 10 | MAIL, EMAIL, Phone | No |\n| Is Primary (Checkbox) | syscontact | GsyscPrimaryFlag | Indicates if the contact is a Primary Contact for the organization specified by Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| Is Bid Contact | syscontact | GsyscBidFlag | This flag indicates if the contact is a bidding contact Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| Last Update User | syscontact | GsyscLastUpdUser | User who last updated the contact record | string | 30 | DAR, UIG, ALV12, ... | No |\n| Collaboration User (checkbox) | syscontact | GsyscCollabUserFlag | Indicates if the contact is a collaboration user, Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| Collaboration Usage Price | syscontact | GsyscCollabUsagePrice | Pricing related to collaboration usage | number | 18 | 0 | No |\n| Independent Contractor (Checkbox) | syscontact | GsyscIndepContractorFlag | Indicates if the contact is an independent contractor. Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| #N/A | syscontact | GsysAltFaxMethodPrefix | #N/A | string | 60 | #N/A | No |\n| #N/A | syscontact | GsysAltFaxMethodSuffix | #N/A | string | 100 | #N/A | No |\n| Alternative Fax Method (Checkbox) | syscontact | GsyscAltFaxMethodFlag | Indicates if an alternative fax method is used for the contact Yes - \"Y\" / No - \"N\". | string | 1 | Yes – ‘Y’ / No – ‘N’ | No |\n| Alternative Fax Method Prefix | syscontact | GsyscAltFaxMethodPrefix | Prefix for alternative fax methods for the contact | string | 60 | 0 | No |\n| Alternative Fax Method Suffix | syscontact | GsyscAltFaxMethodSuffix | Suffix for alternative fax methods for the contact | string | 100 | 0 | No |\n| HRSS Role Code | syscontact | GsyscHrssRoleCode | This is the HR Role assigned to the contact for approving related HR ESS Workflows | string | 10 | DA | No |\n| Name Suffix | syscontact | GsyscSuffixName | Suffix for the contact's name (e.g., Jr., Sr., III) | string | 60 | Jr., Sr., III | No |\n| Employee Trade Code | syscontact | GpyempTradeCode | Code representing the employee contacts trade or specialty of the GsyscEmpNo | string | 4 | 11PCH, 1610, CE28 | No |\n| Trade Name | syscontact | GpytrdTradeName | Name of the trade or specialty for the above GpyempTradeCode for GsyscEmpNo | string | 30 | 0 | No |\n| Trade Rate | syscontact | GpytrdTradeRate | Rate associated with the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No |\n| Trade Charge Rate | syscontact | GpytrdTradeChargeRate | Charge rate for the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No |\n| Trade Billing Rate | syscontact | GpytrdTradeBillingRate | Billing rate for the trade or specialty of the GpyempTradeCode | number | 16 | 0 | No |\n| Employee Company Code | syscontact | GpyempCompCode | Code representing the employee's company for GsyscEmpNo | string | 8 | ZZC, TRHI2, PYUS | No |\n| Employee WRL Code | syscontact | GpyempWrlCode | WRL (Workforce Resource Locator) code for the employee for GsyscEmpNo | string | 15 | ZCHI, 123 | No |\n| Employee WRL Name | syscontact | GpyempWrlName | WRL (Workforce Resource Locator) name for the employee for GsyscEmpNo | string | 4000 | Company ZZ West Chicago | No |\n| Integration User Create Date | syscontact | GsyscIuCreateDate | Date when this contact record was created in CMiC. Should YYYY-MM-DDThh:mm:ssZ | datetime | | 2010-06-25T10:51:17-04:00, 2016-01-05T10:44:33-05:00, ... | No |\n| Integration User Update Date | syscontact | GsyscIuUpdateDate | Date when the this contact record was updated in CMiC. | datetime | | 2024-11-11T16:41:10-05:00, 2023-09-12T14:00:25-04:00, ... | No |", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "GsyscEmpNo": null, "GsyscEmail1": "jane.doe@cmicglobal.com", "GsyscPartnCode": "013035", "GsyscPartnTypeCode": "P", "GsyscContactCode": "KC", "GsyscLastUpdDate": "2022-09-19T17:35:13+00:00", "GsyscHtmlEmailFlag": "N", "GsyscActiveFlag": "Y", "GsyscVUuid": "" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/vnd.oracle.adf.resourceItem+json" } ], "responses": { "201": { "description": "Created", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourceitem+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "example": { "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:13+00:00", "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" } ] } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````