{"id":1554,"date":"2018-03-16T10:13:54","date_gmt":"2018-03-16T09:13:54","guid":{"rendered":"https:\/\/help.cirrus-shield.com\/docs\/developer-guide\/javascript-library\/create-record\/"},"modified":"2024-09-11T14:49:02","modified_gmt":"2024-09-11T13:49:02","slug":"create-record","status":"publish","type":"docs","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/javascript-library\/create-record\/","title":{"rendered":"Create Record"},"content":{"rendered":"
\n
\n
\n
\n

This function is used to create a new record and it returns the GUID of the newly created one and a message info.<\/p>\n

    \n
  • Function<\/u><\/strong>:<\/u> CreateRecord(<Object Name>, <Matching Field>, <XML Data>, <use ExternalID>, <Asynchronous Update>)\n
      \n
    • var<\/span> ObjResult = CreateRecord(<Object Name>, <Matching Field>, <XML Data>, <use ExternalID>, <Asynchronous Update>);<\/li>\n
    • var<\/span> NewRecordGUID = ObjResult.RecordGUID;<\/li>\n
    • var<\/span> message = msgInfo;<\/li>\n
    • Use External Id: if the value is false<\/strong>, then you must send the GUID of the lookup fields in the XML data otherwise send the external Id value. Also if the parameter useExternalID<\/strong> is not existing in the function parameters, then it will considered as it is set to true<\/strong>.<\/li>\n
    • Asynchronous Update: This parameter is optional and has a default value of true<\/strong>. It triggers the calculation of sharing rules on the record asynchronously. When the API call is part of a series of dependent actions or when we need to immediately display the updated record to the user, it is advisable to set this parameter to false<\/strong>. The false<\/strong> value will indicate to Cirrus Shield that the sharing rules on the record should be calculated synchronously.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

      XML Data Format:<\/u><\/p>\n

      <Data><\/span>\n<Object Name><\/span>\n<Matching Field Name><\/span>\n\nValue\n\n<\/Matching Field Name><\/span>\n<Field Name><\/span>\n\nValue\n\n<\/Field Name><\/span>\n<Field Name><\/span>\n\nValue\n\n<\/Field Name><\/span>\n<\/Object Name><\/span>\n<\/Data><\/span>\n<\/pre>\n
        \n
      • Usage<\/u>:\u00a0<\/u><\/strong>var<\/span> objTask = GetDataByID(GetRecordGUID(),“Task”, “Id,Name,Start,End,Description,Location,Attendees,OwnerId,IsDeleted”<\/span>);<\/li>\n<\/ul>\n
        var<\/span> offset = GetTimeZone();\nvar<\/span> xmlStr = <Data><\/span>;\nxmlStr += <Task><\/span>;\nxmlStr += <Name><\/span>;\nxmlStr += Client Meeting<\/span>;\nxmlStr += <\/Name><\/span>;\nxmlStr += <Start><\/span>;\nxmlStr += objTask.Start + offset;\nxmlStr += <\/Start><\/span>;\nxmlStr += <End><\/span>;\nxmlStr += objTask.End + offset;\nxmlStr += <\/End><\/span>;\nxmlStr += <Description><\/span>;\nxmlStr += objTask.Description;\nxmlStr += <\/Description><\/span>;\nxmlStr += <Location><\/span>;\nxmlStr += objTask.Location;\nxmlStr += <\/Location<\/span>;\nxmlStr += <Attendees><\/span>;\nxmlStr += objTask.Attendees;\nxmlStr += <\/Attendees><\/span>;\nxmlStr += <OwnerId><\/span>;\nxmlStr += objTask.OwnerId;\nxmlStr += <\/OwnerId><\/span>;\nxmlStr += <IsDeleted><\/span>;\nxmlStr += 0;\nxmlStr += <\/IsDeleted><\/span>;\nxmlStr += <\/Task><\/span>;\nxmlStr += <\/Data><\/span>;\n\nvar<\/span>\u00a0ObjResult = CreateRecord(\"Task\"<\/span>, \"Id\"<\/span>, xmlStr, false, true);<\/span>\nvar<\/span> TaskGUID \u00a0= ObjResult.RecordGUID;\nvar<\/span> message = ObjResult.msgInfo;\n<\/pre>\n
          \n
        • Output<\/u><\/strong>:<\/u>\n
            \n
          • Success<\/u><\/strong><\/span>:<\/span>
            <\/u>The following message will be displayed \u201cNew record is created successfully.\u201d<\/span>
            It will return the GUID of the newly created record.<\/li>\n
          • Failure<\/u><\/strong><\/span>:<\/span>
            <\/u>An error message will be displayed.
            The GUID will be null.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n<\/div>\n<\/div>\n<\/section>\n
            <\/p>\n\n\n
            <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":945,"menu_order":12,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"doc_tag":[],"class_list":["post-1554","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1554","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/comments?post=1554"}],"version-history":[{"count":6,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1554\/revisions"}],"predecessor-version":[{"id":10314,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1554\/revisions\/10314"}],"up":[{"embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/945"}],"next":[{"title":"Update Record","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/javascript-library\/update-record\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1555"}],"prev":[{"title":"Get Data By Column","link":"https:\/\/help.cirrus-shield.com\/en\/docs\/developer-guide\/javascript-library\/get-data-by-column\/","href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/docs\/1553"}],"wp:attachment":[{"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/media?parent=1554"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/help.cirrus-shield.com\/en\/wp-json\/wp\/v2\/doc_tag?post=1554"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}