EM Application Data

kingland recognizes each client may utilize the application in slightly different manners but a common base understanding is important in order to formulate client specific needs to that end, the application has the built in ability to configure many data fields and functions to meet the desired outcomes the data fields used within entity management (em), and by extension, decision management (dm), are outlined below the objective of this document is to provide a base understanding of the intent of the data fields, the api structure, where the data fields are displayed in the user interface, and other field nuances the columns used in each of the tables are api field name the name of the data field as displayed in the user interface the actual database field name may or may not be the same field type / max limit the type of json field used for the data field and a maximum length for string fields the definitions and properties of each field type are listed under data field types below required indicates whether the data field is required (yes) refer to specific api documents for additional details on conditions when it may be required default ui field label indicates the label displayed for the field in the user interface this is called “default” because a client organization may change the field labels to meet their needs default data value indicates the default value if not provided definition indicates the purpose of the field, where the reference data is maintained (if any), and any additional context or conditional properties of the data field example api code / value indicates an example value of what is stored in the actual database example ui display indicates an example value of what is displayed in the user interface data field types the following json data types are typically utilized within em and generally visible within application programming interface (api) requests and responses array this data type includes objects and field\ value pairs related to the record arrays are primarily visible within api requests and responses object this data type includes field\ value pairs related to the record objects are primarily visible within api requests and responses number this data type represents any negative or positive, whole or decimal number there are two types of numbers that have special characteristics and meanings long this data type is a whole number that represents the unique identifier of an data object or type of reference data contained within em characteristics include a 32 bit signed integer that can store whole number values within the range of 2,147,483,648 to 2,147,483,648 unique numerical values are used to represent data objects and reference data the unique identifier is stored in the database and the name associated to the respective identifier is displayed in the user interface integer this data type is a number that represents the date and time in unix time format (sometimes referred to as epoch time) this date and time format is used for communicating between services example 1644883200 represents 00 00 00 on february 15, 2022 (start of day/midnight) characteristics include unix time is the number of milliseconds from midnight, january 1, 1970 utc to the specific date and time negative numbers represent dates and times prior to january 1, 1970, back to december 13, 1901 there are 86,400 seconds in each day utc is greenwich mean time without daylight savings time adjustments it represents a moment that is the same everywhere the user interface displays this type of data field in one of two ways date only as "yyyy mm dd" (2022 02 15), or "yyyy mm dd hh🇲🇲ss" (2022 02 15 00 00 00) in 24 hour format the time portion may be displayed for time sensitive fields (e g , import date, approved on, date first added) and may or may not display the seconds date and time is displayed in the local time zone in the user interface exception the date and time displayed in reports are displayed in utc since it may not be known which time zone the report was generated within or to where distributed most date fields are system generated and should not be provided in api requests do not provide “0” if the timestamp is unknown; simply do not provide anything at all if “0” is provided, the user interface displays blank and api results return “0” string this data type stores alphanumeric characters up to the designated length as indicated in parentheses (999) boolean this data type allows the value of "true" or "false" note fields returned in the api responses that are not used or not useful have been excluded from this document (e g , transactionid, maintransactionid, count) each of the individual apis do list all the fields legal entity data the data fields and values contained in the tables are specific to legal entity records the definition column contains a description of the field(s) and where defined reference data values can be found details / review details these fields are contained in the legalentity data object data model api field name field type / max limit default ui field label definition example api code / value example ui display entityid long entity id the unique object identifier of the entity object 16886 16886 legalname string legal name the legal name of the entity the default ui field label is legal name andrews & associates llc andrews & associates llc isactive boolean active indicates whether the entity is active or inactive the user interface returns active records by default use this field when trying to match the api results to the ui results true yes long contact person 10133 janice anderson long entity type indicates the type of entity being created values are found in reference data as category object type 70004 legal entity long andrews & associates llc n/a array of long calculated designation 10013001 sec restricted long 6000004 use manual process (approval) long data use flag 10004002 shareable across member firms expirationdate integer inactivation date the unix timestamp when the entity was made inactive only the date portion of the timestamp is displayed in the user interface for inactive entities the system sets this date 1627639810000 2021 07 30 long inactivation reason 10011008 no longer in business deactivationcomment string (65,535) deactivation comment contains the free form comment provided when the entity was inactivated this entity is no longer in business as of december 2020 this entity is no longer in business as of december 2020 lastapproveddate integer approved on the unix timestamp when the entity was last approved the full date and time are displayed the system sets this date 1721682959139 2024 08 01 10 11 51 lastrevieweddate integer last rp verification date the unix timestamp when the last responsible party (rp) review was completed only the date portion of the timestamp is displayed the system sets this date 1715774400000 2024 05 15 long approved by 10133 janice anderson approvecompletiondate integer the unix timestamp when the approval was completed this is not displayed in the user interface the system sets this date 1722454865544 n/a long 10002001 businessstatusdate integer review due date the unix timestamp for the next rp verification review due date this timestamp only has the date portion and no time associated to it the system sets this date 1722427200000 2024 07 31 publiccomment string comment the optional comment a user may add to the entity overall this is the comment under review details section this is the comment under review details sect long 10133 n/a primaryrpsourceentityid long indicates the unique object identifier of the entity from where the primary rp was sourced 16886 n/a long last rp verification user 10133 janice anderson isdirectlydesignated boolean indicates whether the entity has a direct designation true n/a long domicile 170234 united states of america long legal structure 10017001 corporation long fiscal year end 390003 march activationdate integer the unix timestamp when the record was created the user interface displays only the date portion for activation date and the full timestamp for date first added the system sets this date 1627639810000 2022 03 28 15 42 51 long primary auditor 10001001 internal publicentity boolean indicates whether the entity is considered to be a “public entity” as defined by its industry classification this field is not displayed in the user interface false n/a contactpersondisplayname contactpersonid the display name of the user who is the contact person for the entity the unique object identifier of the user who is the primary internal contact person for the entity entitytypefieldvalue entitytypefield gupname gupid the name of the gup entity is populated in this field this field is not directly displayed but can be viewed in the tree hierarchy view in the user interface (the entity is at the top of the tree) the unique object identifier of the entity that is the global ultimate parent (gup) of the entity if the entity has no gup, the identifier of the entity is stored in this field to indicate it is the gup calculateddesignationtypename calculateddesignationids the name of the highest priority designation type applied to the entity is displayed in the user interface the unique object identifier of the highest priority designation type applied to the entity values are found in reference data as category designation type srflagvalue srflagcode sr flag calculated sr flag the name of the service request action is displayed in the user interface the unique object identifier of the service request action values are found in reference data as category sr flag datauseflagvalue datauseflagcode note this field does not currently drive any functionality and is a placeholder for possible future confidentiality requirements the name of the value is displayed in the user interface the unique object identifier of the data use purpose of the entity record values are found in reference data as category data use inactivationreasonvalue inactivationreasoncode the name of the value is displayed in the user interface the unique object identifier of the reason the entity record was inactivated values are found in reference data as category deactivation reason lastapprovebyuserdisplayname lastapprovedbyuserid the display name of the user who last approved the entity the unique object identifier of the user who last approved the entity reviewcycleperiodvalue reviewcycleperiodcode review due month review cycle period additionally, this field drives the month(s) displayed in the review due month field in the user interface values are found in reference data as category month the name of the review period is displayed in the user interface the unique object identifier of the cadence when the record is reviewed values are found in reference data as category review cycle period january, march, july, september, november bi monthly initialapprovedbyuserdisplayname initialapprovedbyuserid the display name of the user who initially approved the entity the field is not displayed in the user interface the unique object identifier of the user who initially approved the entity lastrpverificationuserdisplayname lastrpverificationuserid the display name of the user who last performed the rp verification the unique object identifier of the user who last performed the rp verification domicilevalue domicilecode the name of the country is displayed in the user interface indicates the country in which the entity is domiciled/incorporated values are found in reference data as category country data legalstructurevalue legalstructurecode the name of the legal structure is displayed in the user interface indicates the legal structure of the entity record values are found in reference data as category legal structure fiscalyearendmonthvalue fiscalyearendmonthcode the name of the month displays in the user interface indicates the fiscal yearend month for the entity values are found in reference data as category month date first added activation date primaryauditorvalue primaryauditorcode the name of the auditor type associated to the entity is displayed in the user interface the unique object identifier of the primary auditor on the entity values are found in reference data as category auditor names these fields are contained in the namelist array and the default value is specific to a legal entity record data model api field name field type / max limit default ui field label definition example api code / value example ui display nameid long n/a the unique object identifier of the name object 46351 n/a long legal name 240001 legal name namevalue string (255) contains the respective free form name(s) on the entity record andrews & associates llc andrews & associates llc nametypevalue nametypecode the name type value(s) are displayed in the user interface the default ui field label depends on the type of name represented (i e , legal, alias) the unique object identifier of the type of name on the entity record values are found in reference data as category name type regulators these fields are contained in the regulatorlist array data model api field name field type / max limit default ui field label definition example api code / value example ui display regulatorid long the unique object identifier of the regulator object associated to the entity this field is not displayed in the user interface 2044 n/a long regulators 10016095 u s sec regulatorvalue regulatorcode the name of the regulator associated to the entity a drop down list of these values is presented in the user interface for selection by the user the unique object identifier of the regulator code associated to the entity values are found in reference data as category regulator classifications these fields are contained in the industrylist array data model api field name field type / max limit default ui field label definition example api code / value example ui display industryid long the unique object identifier of the industry classification object 21 n/a long 503245 711310 promoters of performing arts, sports, & similar events w/facility industryclassificationvalue industryclassificationcode sic naics note a field is added to the ui for each type of classification defined in reference data as category industry classification type a few of the standard classification standards are listed in the default ui label column the classification values are tied to the respective type to display in the applicable ui field dropdown list using the parentid and type fields the name of the classification is displayed in the user interface the unique object identifier of the industry classification type values are found in reference data as category industry classification natural person data the data fields and values contained in the tables are specific to natural person records the definition column contains a description of the field(s) and where defined reference data values can be found details / review details these fields are contained in the naturalperson data object data model api field name field type / max limit default ui field label definition example api code / value example ui display entityid long entity id the unique object identifier of the entity object 16886 16886 legalname string legal name the legal name of the entity the default ui field label is legal name andrews & associates llc andrews & associates llc isactive boolean active indicates whether the record is active or inactive only active records appear in search results by default users may set their preference to include inactive records in search results, or the user may select whether to include inactive records during each search activity (checkbox located under search filters) true yes long contact person 10133 janice anderson long entity type indicates the type of entity being created values are found in reference data as category object type 70004 legal entity long andrews & associates llc n/a array of long calculated designation 10013001 sec restricted long 6000004 use manual process (approval) long data use flag 10004002 shareable across member firms expirationdate integer inactivation date the unix timestamp when the entity was made inactive only the date portion of the timestamp is displayed in the user interface for inactive entities the system sets this date 1627639810000 2021 07 30 long inactivation reason 10011008 no longer in business deactivationcomment string (65,535) deactivation comment contains the free form comment provided when the entity was inactivated this entity is no longer in business as of december 2020 this entity is no longer in business as of december 2020 lastapproveddate integer approved on the unix timestamp when the entity was last approved the full date and time are displayed the system sets this date 1721682959139 2024 08 01 10 11 51 lastrevieweddate integer last rp verification date the unix timestamp when the last responsible party (rp) review was completed only the date portion of the timestamp is displayed the system sets this date 1715774400000 2024 05 15 long approved by 10133 janice anderson approvecompletiondate integer the unix timestamp when the approval was completed this is not displayed in the user interface the system sets this date 1722454865544 n/a long 10002001 businessstatusdate integer review due date the unix timestamp for the next rp verification review due date this timestamp only has the date portion and no time associated to it the system sets this date 1722427200000 2024 07 31 publiccomment string comment the optional comment a user may add to the entity overall this is the comment under review details section this is the comment under review details sect long 10133 n/a primaryrpsourceentityid long indicates the unique object identifier of the entity from where the primary rp was sourced 16886 n/a long last rp verification user 10133 janice anderson isdirectlydesignated boolean indicates whether the entity has a direct designation true n/a effectivedate integer the unix timestamp when the record was created the user interface displays only the date portion for activation date and the full timestamp for date first added the system sets this date 1627639810000 2022 03 28 15 42 51 firstname string first name the natural person’s first name meredith meredith middlename string middle name the natural person’s middle name or initial g g lastname string last name the natural person’s last name andrews andrews contactpersondisplayname contactpersonid the display name of the user who is the contact person for the entity the unique object identifier of the user who is the primary internal contact person for the entity entitytypefieldvalue entitytypefield gupname gupid the name of the gup entity is populated in this field this field is not directly displayed but can be viewed in the tree hierarchy view in the user interface (the entity is at the top of the tree) the unique object identifier of the entity that is the global ultimate parent (gup) of the entity if the entity has no gup, the identifier of the entity is stored in this field to indicate it is the gup calculateddesignationtypename calculateddesignationids the name of the highest priority designation type applied to the entity is displayed in the user interface the unique object identifier of the highest priority designation type applied to the entity values are found in reference data as category designation type srflagvalue srflagcode sr flag calculated sr flag the name of the service request action is displayed in the user interface the unique object identifier of the service request action values are found in reference data as category sr flag datauseflagvalue datauseflagcode note this field does not currently drive any functionality and is a placeholder for possible future confidentiality requirements the name of the value is displayed in the user interface the unique object identifier of the data use purpose of the entity record values are found in reference data as category data use inactivationreasonvalue inactivationreasoncode the name of the value is displayed in the user interface the unique object identifier of the reason the entity record was inactivated values are found in reference data as category deactivation reason lastapprovebyuserdisplayname lastapprovedbyuserid the display name of the user who last approved the entity the unique object identifier of the user who last approved the entity reviewcycleperiodvalue reviewcycleperiodcode review due month review cycle period additionally, this field drives the month(s) displayed in the review due month field in the user interface values are found in reference data as category month the name of the review period is displayed in the user interface the unique object identifier of the cadence when the record is reviewed values are found in reference data as category review cycle period january, march, july, september, november bi monthly initialapprovedbyuserdisplayname initialapprovedbyuserid the display name of the user who initially approved the entity the field is not displayed in the user interface the unique object identifier of the user who initially approved the entity lastrpverificationuserdisplayname lastrpverificationuserid the display name of the user who last performed the rp verification the unique object identifier of the user who last performed the rp verification date first added activation date aliases these fields are contained in the namelist array and default value is specific to a natural person record this array is only used for alias names for a natural person data model api field name field type / max limit default ui field label definition example api code / value example ui display nameid long n/a the unique object identifier of the name object n/a long alias alias namevalue string (255) alias contains the respective free form name(s) on the entity record grace andrews grace andrews nametypevalue nametypecode the name type value(s) are displayed in the user interface the default ui field label depends on the type of name represented (i e , legal, alias) the unique object identifier of the type of name on the entity record values are found in reference data as category name type common data addresses these fields are contained in the addresslist array data model api field name field type / max limit default ui field label definition example api code / value example ui display addressid long the unique object identifier of the address object 2099 n/a long 120003 addresslineone string (500) street address 1 contains the first free form address line on the entity record 4983 corporate circle 4983 corporate circle addresslinetwo string (500) street address 2 contains the second free form address on the entity record suite 1212 suite 1212 addresslinethree string (500) street address 3 contains the third free form address line on the entity record 12th floor 12th floor addresslinefour string (500 street address 4 contains the fourth free form address line on the entity record east wing east wing city string (512) city contains the free form address city on the entity record quantam city quantam city long state / province 370803 california long country 170234 united states of america postalcode string (25) postal code contains the free form address postal code on the entity record 55555 55555 addresstypevalue addresstypecode natural person address (np) headquarters (le) the value of the address type is displayed in the user interface as the heading for the specific address indicates the type of address on the entity record values are found in reference data as category address type natural person address headquarters stateprovincevalue stateprovincecode the name of the state is displayed in the user interface indicates the address state (country subdivision) on the entity record values are found in reference data as category state province data countryvalue countrycode the name of the country is displayed in the user interface indicates the address country on the entity record values are found in reference data as category country data business relationship flags these fields are contained in the brflaglist array data model api field name field type / max limit default ui field label definition example api code / value example ui display long long 2001001 approval required brflagtypevalue brflagtypecode calculated br flag other calculated br flag vendors calculated br flag mbr the name of the br flag type which is used as the default ui field labels the word calculated is appended to the beginning of the display labels as the system calculates based on a hierarchy of importance from inherited values the word “calculated” is dropped when in edit mode in the user interface the unique object identifier of the business relationships associated to the entity there are three separate values (i e , mbr, vendors, other) values are found in reference data as category br flag type 2000003 2000002 2000001 other vendors mbr brflagvaluedisplaykey brflagvaluecode the name of the br flag value on the entity a drop down list of these values is presented in the user interface for selection by the user the unique object identifier of the br flag value associated to the br flag type fields values are found in reference data as category br flag value identifiers these fields are contained in the identifierlist array while identifiers are generally used for legal entities, identifier types geared toward a natural person could be defined therefore, this model is common to legal entity and natural person data model api field name field type / max limit default ui field label definition example api code / value example ui display identifierid long n/a the unique object identifier of the identifier object this is not displayed in the user interface 67 n/a long 200005 duns identifiervalue string (50) contains the free form identifier on the entity record the default ui field label is the identifier type name 259836541 259836541 identifiertypevalue identifiertypecode sec cik lei duns the name of the identifier type is displayed in the user interface as the field label for each identifier type defined in reference data a few of the most common ones are listed in the default ui field label column the unique object identifier of the entity identifier type values are found in reference data as category identifier type direct designations a direct designation is applied directly to the entity and not inherited from another associated entity the defined fields and values for direct designations are the same as for indirect designations these fields are contained in the directdesignationlist array in the entity search api response data model api field name field type / max limit default ui field label definition example api code / value example ui display directdesignationid long designation id the unique object identifier of the direct designation object 5679 5679 long designation type 10013001 sec restricted long designation level 560429 global long n/a 100000247 n/a directdesignationreason string direct designation reason sec independence required by regulation sec independence required by regulation indirectdesignationreason string indirect designation reason the entity is required to have sec independence per regulation the entity is required to have sec independence per regulation long data use flag 10004002 shareable across member firms publiccomment string (65,535) designation comment contains the optional free form designation public comment on the designation this is the comment added to the designation this is the comment added to the designation long local restriction level 560481 united states long n/a 10133 n/a initialapprovedate integer n/a the unix timestamp when the designation was initially approved this field is not displayed in the user interface 1689092241857 n/a long audit type 10013101 standard long local restriction type(s) officeid long n/a 1945 n/a long designation office(s) 560425 atlanta/birmingham groupentitydetailid long n/a the unique object identifier of the designation group entity object the group entity object contains fields identifying entities grouped together for designation and audit purposes 98 n/a groupentityid long group entity the unique object identifier of the entity grouped with the current entity the name of the group entity is displayed in the user interface but is not provided in the api search response 16891 andrews events and life celebrations unlimited long n/a 70004 n/a long group auditor 10013206 bdo directdesignationtypevalue directdesignationtypecode the name of the direct designation type is displayed in the user interface the unique object identifier of the designation type values are found in reference data as category designation type only one designation type is allowed per designation object directdesignationlevelvalue directdesignationlevelcode the name of the designation level is displayed in the user interface the unique object identifier of the designation level values are found in reference data as category location hierarchy the default designation level is global but all other locations designated with member firm location type are displayed in the ui dropdown field only one designation level is allowed per designation designations may be inherited based on inheritance rules reasontemplatevalue reasontemplatecode the designation reason template name is not displayed in the user interface the unique object identifier of the reason template used for designations values are found in reference data as category direct designation reason note the template text is the suggested text that is prefilled in the ui and may be overwritten or changed by the user the text from the template field of the direct designation reason reference data is displayed in the user interface note the template text is the suggested text that is prefilled in the ui and may be overwritten or changed by the user (this sample has been modified by the user) the text from the indirect reason field of the direct designation reason reference data is displayed in the user interface datauseflagvalue datauseflagcode note this field does not currently drive any functionality and is a placeholder for future confidentiality requirements the data use name value is displayed in the user interface and defaults "shareable across member firms" the unique object identifier of the data use flag values are found in reference data as category data use localrestrictionlevelvalue localrestrictionlevel the name of the local restriction level is displayed in the user interface the unique object identifier of the local restriction level values are found in reference data as category location hierarchy the values used for local restriction are those whose location type is member firm initialapprovedbyuserdisplayname initialapprovedbyuserid the display name of the user who initially approved the entity this field is not displayed in the user interface the unique object identifier of the user who initially approved the designation audittypevalue audittypecode the name of the audit type is displayed in the user interface the unique object identifier of the audit type object values are found in reference data as category audit type localrestrictiontypevalue localrestrictiontypecode the name of the local restriction type is displayed in the user interface the unique object identifier of the local restriction type values are system managed and found in reference data as category restriction category a single designation may have multiple local restriction types 10011205 10011204 10011201 employment relationships business relationships services the user may add 0 to many office locations for certain designation types (e g restricted, watchlist), at least one office location is required the unique object identifier of the direct designation office object the designation office object allows the association of office locations to the designation locationvalue locationcode the name of the designation office is displayed in the user interface the unique object identifier of the designation office code values are defined in reference data as category location hierarchy where the location type is office groupentitytypevalue groupentitytypecode the name of the group entity type is not displayed in the user interface within the designation the unique object identifier of the group entity type values are system managed and found in reference data as category object type groupentityauditortypevalue groupentityauditortypecode the name of the group entity auditor is displayed in the user interface the default ui field label is group auditor the unique object identifier of the group entity auditor type values are found in reference data as category group auditor indirect designations an indirect designation is one that is inherited from another associated entity the defined fields and values for indirect designations are the same as for direct designations with the addition of the originating entity id these fields are contained in the indirectdesignationlist array in the entity search api response data model api field name field type / max limit default ui label definition example api code / value example ui display indirectdesignationid long designation id the unique object identifier of the indirect designation object 6137 6137 originatingentityid long indirect designation from … 166326 indirect designation from andrews, janis nina long 10013025 audit team restricted long 560429 global long 10015509 audit team restricted directdesignationreason string audit team restricted audit team restricted indirectdesignationreason string audit team restricted audit team restricted long 10004002 shareable across member firms publiccomment string (65,535) contains the optional free form designation public comment on the designation this is the comment added to the designation this is the comment added to the designation long 560481 united states long 10133 n/a initialapprovedate integer the unix timestamp when the designation was initially approved this field is not displayed in the user interface 1689092241857 n/a long 10013101 standard long officeid long 1945 n/a long 560425 atlanta/birmingham groupentitydetailid long the unique object identifier of the designation group entity object the group entity object contains fields identifying entities grouped together for designation and audit purposes 98 n/a groupentityid long the unique object identifier of the entity grouped with the current entity the name of the group entity is displayed in the user interface but is not provided in the api search response 16891 andrews events and life celebrations unlimited long 70004 n/a long 10013206 bdo the name of the originating entity is listed after the section heading “indirect designation from …” the unique object identifier of the entity from which the indirect designation was inherited indirectdesignationtypevalue indirectdesignationtypecode the name of the indirect designation type is displayed in the user interface the unique object identifier of the designation type values are found in reference data as category designation type only one designation type is allowed per designation object indirectdesignationlevelvalue indirectdesignationlevelcode the name of the designation level is displayed in the user interface the unique object identifier of the designation level values are found in reference data as category location hierarchy the default designation level is global but all other locations designated with member firm location type are displayed in the ui dropdown field only one designation level is allowed per designation designations may be inherited based on inheritance rules reasontemplatevalue reasontemplatecode the designation reason template name is not displayed in the user interface the unique object identifier of the reason template used for designations values are found in reference data as category direct designation reason note the template text is the suggested text that is prefilled in the ui and may be overwritten or changed by the user the text from the template field of the direct designation reason reference data is displayed in the user interface note the template text is the suggested text that is prefilled in the ui and may be overwritten or changed by the user (this sample has been modified by the user) the text from the indirect reason field of the direct designation reason reference data is displayed in the user interface datauseflagvalue datauseflagcode note this field does not currently drive any functionality and is a placeholder for future confidentiality requirements the data use name value is displayed in the user interface and defaults "shareable across member firms" the unique object identifier of the data use flag values are found in reference data as category data use localrestrictionlevelvalue localrestrictionlevel the name of the local restriction level is displayed in the user interface the unique object identifier of the local restriction level values are found in reference data as category location hierarchy the values used for local restriction are those whose location type is member firm initialapprovedbyuserdisplayname initialapprovedbyuserid the display name of the user who initially approved the entity this field is not displayed in the user interface the unique object identifier of the user who initially approved the designation audittypevalue audittypecode the name of the audit type is displayed in the user interface the unique object identifier of the audit type object values are found in reference data as category audit type localrestrictiontypevalue localrestrictiontypecode the name of the local restriction type is displayed in the user interface the unique object identifier of the local restriction type values are system managed and found in reference data as category restriction category a single designation may have multiple local restriction types 10011205 10011204 10011201 employment relationships business relationships services the user may add 0 to many office locations for certain designation types (e g restricted, watchlist), at least one office location is required the unique object identifier of the direct designation office object the designation office object allows the association of office locations to the designation locationvalue locationcode the name of the designation office is displayed in the user interface the unique object identifier of the designation office code values are defined in reference data as category location hierarchy where the location type is office groupentitytypevalue groupentitytypecode the name of the group entity type is not displayed in the user interface within the designation the unique object identifier of the group entity type values are system managed and found in reference data as category object type groupentityauditortypevalue groupentityauditortypecode the name of the group entity auditor is displayed in the user interface the default ui field label is group auditor the unique object identifier of the group entity auditor type values are found in reference data as category group auditor responsible party and contacts these fields are contained in userrolelist array data model api field name field type / max limit default ui field label definition example api code / value example ui display long role 102 responsible party long display name 10221 mark anderson isdirect boolean n/a indicates whether the role was added directly to the entity (true) or whether it was inherited based on entity associations (false) an hierarchical tree icon is displayed in the user interface in front of the role name when it is inherited (false) false \<icon> roletypevalue roletypeid the name of the role type is displayed in the user interface the unique object identifier of the role type assigned to the user values are found in reference data as entity role userdisplayname userid the display name of the user is displayed in the user interface the unique object identifier of the user assigned to the role values are found by search for users within the system associations these fields are contained in the association array two tables are shown using the same array structure to illustrate ownership/business associations and officer/director associations the same object model is used but some fields may or may not be populated based on the type of association ownership/business this type of association reflects an ownership or business relationship between two legal entities or a natural person and a legal entity the association and represents the ownership level of the parent entity to the child entity this type of association is listed in the ownership/business table under the associations tab in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display associationid long n/a the unique object identifier of the association object 19775 n/a fromobjectid long association the unique object identifier of the entity in the association that is the parent 16886 andrews & associates llc fromobjecttypeid long n/a the unique object identifier of the type of entity that is the parent in the association values are found in reference data as category object type 70004 n/a toobjectid long association the unique object identifier of the entity in the association that is the child 124711 andrews consolidated properties toobjecttypeid long n/a the unique object identifier of the type of entity that is the child in the association values are found in reference data as category object type 70004 n/a relationshiptypeid long relationship type the unique object identifier of the type of association represented values are found in reference data as category relationship type 290007 control material relationshippercentage number (### ##) ownership percentage a number from 0 to 100 with two optional decimals points representing the ownership percentage of the director/officer 60 0 60% isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a transactiondate integer n/a the unix timestamp when the transaction occurred not used at this time 1679676858596 n/a initialapprovedbyuserid long n/a the unique object identifier of the user who initially approved the association 10133 n/a initialapproveddate integer n/a the unix timestamp when the association was initially approved 1679676858596 n/a attributes object n/a this object contains several association attributes n/a n/a attributes publiccomment string association public comment the comment added to the association object this is only valid for ownership/business association this is my association comment this my association comment attributes datauseflagcode long association data use flag the unique object identifier of the data use type values are found in reference data as category data use 10004002 shareable across member firms parent object n/a this object contains information about the parent entity in the association n/a n/a parent objectid long association the unique object identifier of the entity in the association that is the parent this is the same value as the fromobjectid 16886 andrews & associates llc parent objecttypeid long n/a the unique object identifier of the type of entity that is the parent in the association values are found in reference data as category object type this is the same value as fromobjecttypeid 70004 n/a parent displayname string association the name of the parent entity andrews & associates llc andrews & associates llc parent isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a parent transactiondate integer n/a not used at this time null n/a parent domicilecode long n/a the unique object identifier of the country the parent entity is domiciled in values are found in reference data as category country data this field is only valid for legal entities and will be null for natural persons 170234 n/a parent children n/a not used at this time null n/a parent parentcount integer n/a not used at this time 0 n/a parent childcount integer n/a not used at this time 0 n/a parent decorators n/a not used at this time null n/a parent relationshiptoparent n/a not used at this time null n/a child object n/a this object contains information about the child entity in the association n/a n/a child objectid long n/a the unique object identifier of the entity in the association that is the child this is the same value as the fromobjectid 124711 n/a child objecttypeid long n/a the unique object identifier of the type of entity that is the child in the association values are found in reference data as category object type this is the same value as fromobjecttypeid 70004 n/a child displayname string association the name of the child entity andrews consolidated properties andrews consolidated properties child isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a child transactiondate integer n/a not used at this time null n/a child domicilecode boolean n/a the unique object identifier of the country the child entity is domiciled in values are found in reference data as category country data this field is only valid for legal entities and will be null for natural persons 170234 n/a child children string n/a not used at this time null n/a child parentcount integer n/a not used at this time 0 n/a child childcount integer n/a not used at this time 0 n/a child decorators n/a not used at this time null n/a child relationshiptoparent n/a not used at this time null n/a director/officer this type of association reflects a role or position a natural person holds within the legal entity the natural person is always represented as the parent entity and the legal entity is always represented as the child entity this type of association is listed in the director/officer table under the associations tab in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display associationid long n/a the unique object identifier of the association object 2110 n/a fromobjectid long association the unique object identifier of the entity in the association that is the parent 1000000023 andrews, janis nina fromobjecttypeid long n/a the unique object identifier of the type of entity that is the parent in the association values are found in reference data as category object type 70006 n/a toobjectid long association the unique object identifier of the entity in the association that is the child 16886 andrews & associates llc toobjecttypeid long n/a the unique object identifier of the type of entity that is the child in the association values are found in reference data as category object type 70004 n/a relationshiptypeid long relationship type the unique object identifier of the type of association represented values are found in reference data as category relationship type 290012 officer relationshippercentage number (### ##) ownership percentage a number from 0 to 100 with two optional decimals points representing the ownership percentage of the director/officer 75 0 75% isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a transactiondate integer n/a the unix timestamp when the transaction occurred not used at this time 1661871549353 n/a initialapprovedbyuserid long n/a the unique object identifier of the user who initially approved the association 10133 n/a initialapproveddate integer n/a the unix timestamp when the association was initially approved 1648501154538 n/a attributes object n/a this object contains several association attributes n/a n/a attributes formkey string form key the name of the form from which the director/officer equity ownership information was obtained sec form 3 sec form 3 attributes classofshare string class of shares a string describing the type of shares owned by the director/officer preferred preferred attributes titlecategory string title the title of the director/officer secretary secretary attributes datauseflagcode long n/a the unique object identifier of the data use type values are found in reference data as category data use 10004002 shareable across member firms attributes directororofficereffectivedate integer effective date the unix timestamp when the director/officer appointment became effective only the date is displayed in the user interface 1660107600000 2022 08 10 parent object n/a this object contains information about the parent entity in the association n/a n/a parent objectid long association the unique object identifier of the entity in the association that is the parent this is the same value as the fromobjectid 1000000023 andrews, janis nina parent objecttypeid long n/a the unique object identifier of the type of entity that is the parent in the association values are found in reference data as category object type this is the same value as fromobjecttypeid 70006 n/a parent displayname string n/a the name of the parent entity andrews, janis nina andrews, janis nina parent isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a parent transactiondate integer n/a not used at this time null n/a parent domicilecode long n/a the unique object identifier of the country the parent entity is domiciled in values are found in reference data as category country data this field is only valid for legal entities and will be null for natural persons null n/a parent children n/a not used at this time null n/a parent parentcount integer n/a not used at this time 0 n/a parent childcount integer n/a not used at this time 0 n/a parent decorators n/a not used at this time null n/a parent relationshiptoparent n/a not used at this time null n/a child object n/a this object contains information about the child entity in the association n/a n/a child objectid long association the unique object identifier of the entity in the association that is the child this is the same value as the fromobjectid 16886 andrews & associates llc child objecttypeid long n/a the unique object identifier of the type of entity that is the child in the association values are found in reference data as category object type this is the same value as fromobjecttypeid 70004 n/a child displayname string association the name of the child entity andrews & associates llc andrews & associates llc child isactive boolean n/a indicates whether the association is active or not only active associations are displayed in the user interface by default true n/a child transactiondate integer n/a not used at this time null n/a child domicilecode boolean n/a the unique object identifier of the country the child entity is domiciled in values are found in reference data as category country data this field is only valid for legal entities and will be null for natural persons 170234 n/a child children string n/a not used at this time null n/a child parentcount integer n/a not used at this time 0 n/a child childcount integer n/a not used at this time 0 n/a child decorators n/a not used at this time null n/a child relationshiptoparent n/a not used at this time null n/a system administration the system administration data is available to be viewed and in some cases managed by the client organization administrators language administration the language management workflow instance contains the following fields and is displayed in the language administration page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display importinstanceid long import id the unique object identifier of the workflow instance 302 302 userid long n/a the unique object identifier of the user who uploaded the language file 10132 n/a username string uploaded by the username of the user who uploaded the language file jesse sommerfeld jesse sommerfeld contentversionid integer n/a the unique identifier of the version of language content established with the language import 284 n/a languagetypecode long n/a the unique object identifier of the language type values are found in reference data as category language type 1648125867255 n/a filename string file name the name of the file that was uploaded spanish20240806 json spanish20240806 json importstatus status the system defined status of the language import workflow 3 completed itemstotal integer result the total count of records in the language import file this number is used to display the result where the last number is the total record count 5192 5192 of 5192 itemschanged integer result the number of records that were successfully changed this number is used to display the result where the first number is the changed records count 5192 5192 of 5192 submissiondate integer submission date the unix timestamp when the language import file was submitted the date and time are displayed in the user interface 1722968712983 2024 08 06 13 25 12 errormessage string result the error message is displayed in the result column in the user interface if the import fails file content to json failed importinstanceid \[303], filename add rp request json file content to json failed importinstanceid \[303], filename add rp request json errorcode long n/a the unique object identifier of the import status 104 n/a completeddate integer completion date the unix timestamp when the language import file was processed the date and time are displayed in the user interface 1722968723684 2024 08 06 13 25 23 isdeleted boolean n/a indicates if the import workflow instance was deleted false n/a attributes object n/a not used at this time n/a n/a rejectionfilepath string n/a the location path to the rejection file if the language import submission is rejected 302/rejection spanish20240806 json n/a filepath no label the location path to the import submission results file this accessed via the user interface by clicking on the file download icon on the far right 302/spanish20240806 json group management the group data model contains the following fields and is displayed in the group management page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display groupid long n/a the unique object identifier of the group 100 n/a groupname string (100) name name of the group global level 1 global level 1 groupdesc string (100) description description of the group the global group that performs first level review the global group that performs first level review isactive boolean status indicates if the group is active or not true active attributes object n/a contains additional details of the group n/a n/a attributes grouplevel long level the unique object identifier of the level assigned to the group values are found in reference data as category group level 380203 global level 1 attributes groupfunction long function the unique object identifier of the function assigned to the group values are found in reference data as category group function 380102 independence attributes grouplocation long location the unique object identifier of the location assigned to the group values are found in reference data as location hierarchy 560429 global externalgroupid string (100) external group id the external identifier assigned to the group 1650 1650 role management the role data model contains the following fields and is displayed in the role management page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display roleid long n/a the unique object identifier of the role 10037 n/a rolename string (100) name the name of the role collaborator collaborator roledesc string (100) description the description of the role this role allows a user to collaborate on a request this role allows a user to collaborate on a request isactive boolean status indicates if the role is active or not true active attributes object n/a this object contains additional settings for roles n/a n/a attributes isentityrole string n/a indicates whether the role is an entity user role if “t”, the role appears in the user interface dropdown list in responsible party and contacts null n/a attributes ispartnerrole string n/a indicates whether the role is an entity partner role if “t”, the role appears in the user interface dropdown list in responsible party and contacts null n/a attributes is platform system role string n/a indicates whether the role is a platform level system role null n/a issystemrole boolean n/a indicates if the role is a system defined role false n/a objecttypecode integer n/a the unique object identifier of the type of object the role can be associated to 70007 n/a visible boolean n/a indicates if the role is visible within the user interface true n/a rules management the rules management data model contains the following fields and is displayed in the rules management page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display ruledefid long n/a the unique object identifier of the rule definition object 57 n/a rulekey string n/a the key assigned to the rule definition for ease of identification and use ra1000 n/a name string (128) name the user friendly name for the rule definition ra1000 duplicate entity ra1000 duplicate entity description string (500) description this field is a user friendly description that may describe the rule and its functions duplicate entity check duplicate entity check implref string n/a a reference to the type of rule implementation duplicatefieldscheckrule n/a categorycode long category the unique object identifier of the rule category values are found in reference data as category rule category 300002 duplication defaulterrorlevelcode long error level the unique object identifier of the rule error level values are found in reference data as category rule error level 310002 warning isactive boolean status this field indicates if the rule is active or inactive true active defaultmetadata object n/a the object contains additional rule definition aspects n/a n/a defaultmetadata check fields string check fields indicates the fields to check for the rule legalentityname country legalentityname country defaultmetadata rule complexity string rule complexity indicates the complexity of the rule medium medium message string (500) message the message identifier that links to the language file where all messages are maintained the message from the language file is displayed in the user interface the message may contain placeholders for things like required fields ra1000 message multiple entities cannot have the same legal name, headquarters address city, and headquarters address country locate the other entity using search and evaluate if they are duplicates if they are delete the change request if you determine they are not duplicates, update one of the records to change either the name, city or country {{requiredfields}} baseruledefid long n/a the unique object identifier of the base rule associated to the rule 56 n/a isconfigure boolean n/a indicates whether the rule is configurable or not true n/a baserulename string base rule the name of the base rule definition ra199 duplicate entity id base rule ra199 duplicate entity id base rule baseruledescription string n/a the description of the base rule definition ra199 base description n/a isapex boolean n/a indicates if the rule is the apex of the rule definition tree true n/a user management the user management data model contains the following fields and is displayed in the user management page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display userid long n/a the unique object identifier of the user 10133 n/a isactive boolean status indicates whether the user is active or not true active username string (200) n/a the user name assigned to the user this may or may not be the same value as the email address janice anderson\@kingland com mailto\ janice anderson\@kingland com n/a email string (200) this is the user's email address aande\@zipmail com mailto\ aande\@zipmail com aande\@zipmail com mailto\ aande\@zipmail com displayname string (200) display name the display name of the user janice anderson janice anderson firstname string (200) first name the first name of the user janice janice lastname string (200) last name the last name of the user anderson anderson country string (200) country the name of the country the user is associated to us us effectivedate integer n/a the unix timestamp when the user was added to the system 1647339085158 n/a lastdatesynchronized integer last date active directory synchronized the unix timestamp when the user was last synchronized the organization identity provider 1647339085158 2022 03 15 10 11 gmt lastdateuseragreement integer last user agreement the unix timestamp when the user agreement was last confirmed 1715023500908 2024 05 06 19 25 gmt memberfirmid long n/a the unique object identifier of the member firm the user is associated to values are found in reference data as category location hierarchy where the location type is member firm 560481 n/a memberfirmname string member firm the name of the member firm the user is associated to values are found in reference data as category location hierarchy where the location type is member firm this is displayed as member firm in the user search results page in the user interface united states united states externalsourceid string external id the user identifier used in the organization identify provider system or the source of the user information 135 135 externalhruserid string n/a the user identifier used by the organization hr system from which user information may be provided null n/a idpuserid string n/a the user identifier generated by the organization identity provider system 00000000 0000 0000 0000 00000000010133 n/a idpid string n/a the identity provider system identifier null n/a preferredlanguage long n/a the unique object identifier of the user preferred language values are found in reference data as category language type 220001 n/a preferredlanguagevalue string language the name of the user preferred language values are found in reference data as category language type global english global english preferredpagesize long n/a the unique object identifier of the user preferred page size values are found in reference data as category page size default 380003 n/a preferredpagesizevalue string page results the name of the user preferred page size values are found in reference data as category page size default 50 50 office string office the office the user is associated to in the organization identity provider system software park software park locationoverride long n/a the unique object identifier of the office associated to the user as the location override values are found in reference data as category location hierarchy 560481 n/a locationoverridevalue string location override the name of the office associated to the user as the location override values are found in reference data as category location hierarchy united states united states issupervisor boolean group role indicates if the user a supervisor of a group this indication displays in the users table of the specific group in group management false member grouplist array n/a the array contains the group objects the user is associated to n/a n/a grouplist groupid long n/a the unique object identifier of the group associated to the user 1033 n/a grouplist groupname string name the name of the group associated to the user gal2 ind united states gal2 ind united states grouplist groupdesc string description the description of the group associated to the user gal2 independence united states gal2 independence united states grouplist grouplevel long n/a the unique object identifier of the group level associated to the group values are found in reference data as category group level 380204 n/a grouplist grouplevelvalue string n/a the name of the group level associated to the group values are found in reference data as category group level global level 2 n/a grouplist groupfunction long n/a the unique object identifier of the group function associated to the group values are found in reference data as category group function 380102 n/a grouplist groupfunctionvalue string n/a the name of the group function associated to the group values are found in reference data as category group function independence n/a grouplist grouplocation long n/a the unique object identifier of the group location associated to the group values are found in reference data as category location heirarchy where location type is member firm 560481 n/a grouplist grouplocationvalue string n/a the name of the group location associated to the group values are found in reference data as category location heirarchy where location type is member firm united states n/a grouplist externalgroupid string n/a the external identifier associated to the group us165 n/a rolelist array n/a the array contains the role objects associated to the user n/a n/a rolelist roleid long n/a the unique object identifier of the role associated to the user 114 n/a rolelist rolename string name the name of the role associated to the user eligible to be responsible party eligible to be responsible party rolelist roledesc string n/a the description of the role associated to the user eligible to be responsible party n/a rolelist issystemrole boolean n/a indicates whether the role is a system defined role or not false n/a rolelist objecttypecode long n/a the unique object identifier of the type of object the role can be associated to values are found in reference data as category object type 70007 n/a rolelist objecttypevalue string n/a the name of the type of object the role can be associated to values are found in reference data as category object type user n/a permissionlist array n/a the array contains permission objects associated to the user through an assigned role or group the list of permissions is displayed in group management and role management and does not display in the user management page in the user interface n/a n/a permissionlist permissionid long n/a the unique object identifier of the permission associated to the user all permissions are system managed and can be found using get permission api 76 n/a permissionlist permissionname string n/a the name of the permission add natural person n/a permissionlist permissiondesc string n/a the description of the permission ability to create a new natural person n/a permissionlist permissioncategory string n/a the category of the permission the values are system defined (e g , add, update, inactive, review) add n/a permissionlist permissiondisplayname string n/a the display name of the permission associated to the user add natural person n/a workflow definition the workflow definition data model contains the following fields and is displayed in the workflow definition page in the user interface data model api field name field type / max limit default ui field label definition example api code / value example ui display workflowdefid long n/a the unique object identifier of the workflow definition object 11 n/a workflowkey string n/a the key value of the workflow definition workflow parent multiple approvers n/a name string (200) name the name of the workflow definition ob multiple approvers entity workflow parent description string (512) description the description of the workflow definition that may describe the rule and its functions the parent workflow of the entity updates multiple approvers the parent workflow of the entity updates multiple approvers firststepdefid long first step the unique object identifier of the first step of the workflow definition 1067 draft isactive boolean active indicates if the workflow definition is active or not true “active” checkbox is checked workflowtriggerid long trigger the action within the system that initiates the workflow legal entity update legal entity update defworkflowrulexrefmodellist array not used at this time n/a defworkflowrulesetxrefmodellist array n/a the array contains additional attribute objects defining the workflow n/a n/a defworkflowrulesetxrefmodellist workflowdefid long n/a the unique object identifier of the workflow definition 11 n/a defworkflowrulesetxrefmodellist rulesetdefid long n/a the unique object identifier of the ruleset definition 10 n/a firststepkey string n/a the key from the first step in the workflow step draft multiple approvers n/a steps object n/a this object contains an object for each step defined in the workflow n/a n/a \<stepkey> string n/a the step key is the name for each step object the string changes based on the step listed step draft multiple approvers n/a steps \<stepkey> stepdefid long n/a the unique object identifier of the step definition 1067 draft steps \<stepkey> name string name the name of the the step draft draft steps \<stepkey> assignmentgroup long assignment group the unique object identifier of the assignment group associated to the step 1034 le draft steps \<stepkey> isactive boolean active indicates if the step is active or not true box is checked steps \<stepkey> stepkey string n/a the key used to identify the step step draft multiple approvers n/a steps \<stepkey> workflowdefid long n/a the unique object identifier of the workflow definition the step is associated to 11 n/a steps \<stepkey> expectedcompletiontime integer n/a the estimated time to complete the step 1 n/a steps \<stepkey> disablecancel boolean disable cancel indicates if the cancel action is disabled false box is unchecked steps \<stepkey> disablehold boolean disable hold indicates if hold action is disabled false box is unchecked steps \<stepkey> disableresume boolean disable resume indicates if resume action is disabled false box is unchecked steps \<stepkey> overrideholddisplaykey string override hold display key the key to the message when the hold is overridden values are found in the language files in section name workflow instance page multiple approvers child workflow override hold display key multiple approvers child workflow override hold display key steps \<stepkey> defsteprulexrefmodellist array n/a not used at this time n/a steps \<stepkey> defsteprulesetxrefmodellist array n/a not used at this time n/a steps \<stepkey> transitionkeys array n/a the keys to the transitions available from the step these tie to the objects within the transitions object multiple approvers submit n/a transitions object n/a this object contains an object for each transition defined in the workflow n/a n/a \<transitionkey> string n/a the transition key is displayed as the name of the object the string changes based on the transition listed multiple approvers submit n/a transitions \<transitionkey> transitionid long n/a the unique object identifier of the transition 129 n/a transitions \<transitionkey> name string transition name the name of the transition which is visible in the workflow definition map in the user interface submit for review submit for review transitions \<transitionkey> stepdefid long from step the unique object identifier of the step definition which is part of the transition 1067 draft transitions \<transitionkey> nextstepdefid long to step the unique object identifier of the next step in the definition 1068 final approval transitions \<transitionkey> iscommentrequired boolean comment required? indicates whether a comment is required for the transition false box is unchecked transitions \<transitionkey> isreasonrequired boolean transition reason required? indicates whether a transition reason is required false box is unchecked transitions \<transitionkey> displayorder integer display order indicates the display order of the transition in the workflow 1 orders the transitions in the workflow def map transitions \<transitionkey> isactive boolean active indicates if the transition is active true box is checked transitions \<transitionkey> transitionkey string n/a the unique object identifier of the transition multiple approvers submit n/a transitions \<transitionkey> workflowdefid long n/a the unique object identifier of the workflow the transition is part of 11 n/a transitions \<transitionkey> ispushback boolean transition pushback step? indicates if the transition represents a push back to the previous step false box is unchecked transitions \<transitionkey> transitionreasons array n/a the array containing the transitions reasons available for the transition n/a n/a transitions \<transitionkey> transitionreasons transitionreasonid long n/a the unique object identifier of the transition reason 940 n/a transitions \<transitionkey> transitionreasons transitionreasonname string n/a the name of the reason for the specific transition validation errors n/a transitions \<transitionkey> transitionreasons transitionid long n/a the unique object identifier of the transition the reason is associated to 131 n/a transitions \<transitionkey> transitionreasons isactive boolean n/a indicates if the transition reason is active true n/a transitions \<transitionkey> transitionrulesetxrefs array n/a the array contains a cross reference object linking each transition with the ruleset definition n/a n/a transitions \<transitionkey> transitionrulesetxrefs rulesetdefid long n/a the unique object identifier of the ruleset definition 11 n/a transitions \<transitionkey> transitionrulesetxrefs isactive boolean n/a indicates if the ruleset is active true n/a transitions \<transitionkey> transitionrulesetxrefs transitionid long n/a the unique object identifier of the transition the ruleset is associated 129 n/a transitions \<transitionkey> transitionrulexrefs array n/a the array contains a cross reference object linking each transition with the rule definition n/a n/a transitions \<transitionkey> transitionrulexrefs ruledefid long n/a the unique object identifier of the rule definition 1580 n/a transitions \<transitionkey> transitionrulexrefs isactive boolean n/a indicates if the rule is active or not true n/a transitions \<transitionkey> transitionrulexrefs isapex boolean n/a indicates if the rules is at the apex true n/a transitions \<transitionkey> transitionrulexrefs transitionid long n/a the unique object identifier of the transition 129 n/a transitions \<transitionkey> transitionrulexrefs errorlevelcode long n/a the unique object identifier of the error level code associated to the rule/transition pair values are found in reference data as category rule error level 310001 n/a transitions \<transitionkey> fromstepkey string n/a the key value of the “from” step associated to the transition step draft multiple approvers n/a transitions \<transitionkey> nextstepkey string n/a the key value of the “to” step associated to the transition step final approval multiple approvers n/a stepslist array n/a the array contains an object for each available step in the workflow n/a n/a steplist stepdefid long n/a the unique object identifier of the step definition 1067 n/a steplist name string name the name of the step draft draft steplist assignmentgroup long assignment group the unique object identifier of the assignment group associated to the step 1034 le draft steplist isactive boolean active indicates if the step is active true box is checked steplist stepkey string n/a the key used to easily identify the step step draft multiple approvers n/a steplist workflowdefid long n/a the unique object identifier of the workflow definition 11 n/a steplist expectedcompletiontime integer n/a the estimated time for completion of the step 1 n/a steplist disablecancel boolean disable cancel indicates if cancel is disabled for this step false box is unchecked steplist disablehold boolean disable hold indicates if hold is disabled for this step false box is unchecked steplist disableresume boolean disable resume indicates if resume is disabled for this step false box is unchecked steplist overrideholddisplaykey string override hold display key the key to the message when the hold is overridden values are found in the language files in section name workflow instance page multiple approvers child workflow override hold display key multiple approvers child workflow override hold display key steplist defsteprulexrefmodellist array not used at this time steplist defsteprulesetxrefmodellist array not used at this time steplist transitionkeys array n/a the key used for the transition associated to the step multiple approvers child approved n/a transitionslist array n/a the array contains an object for each transition associated to the workflow n/a n/a transitionslist transitionid string n/a the unique object identifier of the transition 131 n/a transitionslist name string transition name the name of the transition push back to draft push back to draft transitionslist stepdefid long n/a the unique object identifier of the step definition 1068 n/a transitionslist iscommentrequired boolean comment required? indicates if a comment is required for the transition true box is checked transitionslist isreasonrequired boolean transition reason required? indicates if a reason is required for the transition true box is checked transitionslist displayorder integer display order the order in which the transition appears in the workflow definition map 1 1 transitionslist isactive boolean active indications if the transition is active true box is checked transitionslist transitionkey string n/a the key for the transition multiple approvers push to draft n/a transitionslist workflowdefid long n/a the unique object identifier of the workflow definition the transition is associated to 11 n/a transitionslist ispushback boolean transition pushback step? indicates if the transition pushes the workflow back to a previous step true box is checked transitionslist transitionreasons array transition reason the array contains a list of transitions reasons associated to the transition n/a n/a transitionslist transitionreasons transitionreasonid long n/a the unique object identifier of the transition reason 932 n/a transitionslist transitionreasons transitionreasonname string reason the transition reason name pending rp approval pending rp approval transitionslist transitionreasons transitionid long n/a the unique object identifier of the transition the reason is associated to 131 n/a transitionslist transitionreasons isactive boolean n/a indicates if the reason is active or not true n/a transitionslist transitionrulesetxrefs array n/a the array contains objects representing the cross reference between the ruleset and the transition n/a n/a transitionslist transitionrulesetxrefs rulesetdefid long n/a the unique object identifier of the ruleset definition 11 n/a transitionslist transitionrulesetxrefs isactive boolean n/a indicates if the ruleset is active true n/a transitionslist transitionrulesetxrefs transitionid long n/a the unique object identifier of the transition 129 n/a transitionslist transitionrulexrefs array transition rules the array contains transitions to rules cross reference objects n/a n/a transitionslist transitionrulexrefs ruledefid long n/a the unique object identifier of the rule definition 1582 n/a transitionslist transitionrulexrefs isactive boolean n/a indicates whether the rule is active true n/a transitionslist transitionrulexrefs isapex boolean n/a indicates whether the rule is at the apex true n/a transitionslist transitionrulexrefs transitionid long n/a the unique object identifier of the transition definition 131 n/a transitionslist transitionrulexrefs errorlevelcode long n/a the unique object identifier of the error level code for the rule transition combination values are found in reference data as category rule error level 310001 n/a transitionslist fromstepkey string n/a the key to the step from which the transition was initiated step final approval multiple approvers shows in workflow map transitionslist nextstepkey string n/a the key to the step to which the transition goes step draft multiple approvers shows in workflow map allowworkitems array no this field provides a listing of types of changes in the system that will trigger the selected workflow values are found in reference data as category workflow allowed workitem type 630001 legal entity update reference management the reference management model contains the following fields for all categories some categories of reference data have additional attributes and that information is contained in the second table called category additional attributes all other configurable reference data categories only have the standard fields data model api field name type field / max limit default ui field label definition example api code / value example ui display id long n/a the unique object identifier of the reference data object 550003 n/a category string (64) n/a this field indicates the category for the reference and is automatically populated when a value is created via the user interface location type n/a key string n/a the key to the reference data object member firm n/a displaykey string (256) name the name displayed in the user interface member firm member firm description string (1000) description the description of the reference data object a member firm within the organization a member firm within the organization isactive boolean status indicates if the reference data object is active or not true "active" box checked displayorder integer n/a orders the display of reference data values in the user interface 3 member firm is the third listed value in the dropdown list additionalattributes object n/a this object contains the additional attribute fields defined for specific reference data categories refer to the category additional attributes table for more details n/a n/a issystemmanaged boolean n/a indicates if the particular reference data value/object is system controlled true displays note in user interface this field has been marked as a system value and cannot be edited isrestricted boolean n/a not used at this time true n/a isroot boolean n/a n/a isreadonly boolean n/a not used at this time false n/a ishierarchical boolean n/a indicates if the reference data object is part of a hierarchical data structure false n/a category additional attributes some reference data categories have additional attributes that are used to define them the additional attributes are displayed as fields in the user interface using the api field name as the default field label additional attributes api field name type field / max limit default ui field label definition example api code / value example ui display audit type this category defines the audit type values and contains the following additional attribute(s) default boolean default indicates if the audit type is the default value true yes component of group boolean component of group indicates if the group component field is presented for the audit type false no br flag link this category defines the values available for the various br flag fields and contains the following additional attribute(s) url string url the url of the external system used for review/approval https // https // label string label the label displayed in the user interface create br request create br request hidden boolean hidden indicates whether the value is hidden from display in the user interface false no location string location the string representing the unique object identifier of the location values are found in reference data as category location hierarchy 560429 global br flag value string br flag value the value displayed in the dropdown list in the user interface use ems (notify) use ems (notify) br flag value this category defines the values displayed in the br flag fields in the user interface using the following additional attribute(s) priority integer priority indicates the order in which the value appears in the dropdown list in the user interface 3 3 legal entity designation override array n/a not used at this time n/a n/a natural person designation override array n/a not used at this time n/a n/a case instance status this category defines the statuses used for decision management (dm) workflow instances and using the following additional attribute(s) tag class string tag class the tag assigned to the workflow for use in retrieving the workflow error tag error tag country data this category defines the countries utilized by em and dm using the following additional indyattribute(s) eu member boolean eu member indicates if the country is a member of the european union false no uk member boolean uk member indicates if the country is a member of the united kingdom true yes country iso abbr string country iso abbr the iso 3166 official abbreviation for the country gb gb deactivation reason this category defines the reasons for deactivating an entity using the following additional attribute(s) indy eligible boolean indy eligible indicates if the deactivation is supported in the independence integration false no designation type this category defines the different designation types using the following additional attribute(s) audit boolean audit indicates whether the audit field should be displayed for the type of designation if true, the audit field appears in the designation section of the ui true yes hidden boolean hidden indicates whether the designation type displays in the designation section of the ui those that are hidden are those types that are automatically derived by inheritance logic if true, the designation type does not appear in the dropdown list in the ui false no priority integer priority used to rank the designations by priority importance the higher the number, the higher priority over lower priority designations 100 100 combined names string combined names the combined name displayed in the ui based on calculated designation, priority, and inheritance {\\"loan rule & business relationship watchlist\\" \[10013023]} {\\"loan rule & business relationship watchlist\\" \[10013023]} calculated factor integer calculated factor this factor is used to manage the calculated designation and determine what designations show together versus which ones supersede others 12 12 local restrictions boolean local restrictions indicates whether local restrictions are valid for the designation type if true, the local restriction fields appear in the ui true yes enableprivatepublicswitch boolean enableprivatepublicswitch is used for iesba restricted only it changes the calculation if the entity has a classification that “ispublic” false no direct reason this category defines the reasons a direct designation is applied using the following additional attribute(s) there is a corresponding indirect reason when entities inherit a designation template string template the templated reason for the direct designation audit client subject to additional restrictions in the united kingdom as a public interest entity audit client subject to additional restrictions in the united kingdom as a public interest entity indirect reason string indirect reason the indirect reason that is applied to inherited designations uk public interest entity audit client affiliate uk public interest entity audit client affiliate designation type string designation type the name of the designation displayed in the ui uk pie restricted uk pie restricted entity details request search this category will be used to define different request search configurations that may be utilized when displaying decision management data within custom sections on the entity details page request search filters string request search filters information used to control the search results within decision management {\n\t\\"casedefinitionids\\" \[],\n\t\\"statusrefids\\" \[],\n\t\\"classificationids\\" \[],\n\t\\"subclassificationids\\" \[],\n\t\\"engagementstatusids\\" \[],\n\t\\"relatedpartyfiltering\\" \\"related party\\",\n\t\\"includeguprequests\\" false\n} {\n\t\\"casedefinitionids\\" \[],\n\t\\"statusrefids\\" \[],\n\t\\"classificationids\\" \[],\n\t\\"subclassificationids\\" \[],\n\t\\"engagementstatusids\\" \[],\n\t\\"relatedpartyfiltering\\" \\"related party\\",\n\t\\"includeguprequests\\" false\n} entity role this category defines the entity roles available on legal entity or natural person entity using the following additional attribute(s) is partner role boolean is partner role indicates if the entity role should appear in the partner role drop down list in the ui false no form risk levels this category defines the different risk levels for form responses within decision management using the following additional attribute(s) risk score integer risk score indicates the score assigned to the form risk level 4 4 status tag font hex color string status tag font hex color indicates the font hex color used for the display of the form status #721c24 #721c24 status tag background hex color string status tag background hex color indicates the background hex color used for the display of the form status #f8d7da #f8d7da group level this category defines the group levels using the following additional attribute(s) isglobal boolean isglobal indicates whether the group level is global or not true yes identifier type this category defines the types of identifiers using the following attribute(s) nisc string nisc not used at this time n/a n/a country long country indicates the country the identifier is valid for 560392 united states of america entity type string entity type indicates the type of entity the identifier is valid for legalentity legal entity sub classification string sub classification not used at this time n/a n/a external identifier code string external identifier code the identifier code used by external systems usseccik usseccik indirect reason this category defines the indirect designation reasons using the following additional attribute(s) see also direct reason template string template the templated indirect reason these values are selected when defining the direct reason uk public interest entity audit client affiliate uk public interest entity audit client affiliate industry classification this category defines the classification types and associated values using the following additional attributes type string type the name of the parent (industry classification type) if the parent is inactive, the identifier string is populated in this field entity classification entity classification ispublic boolean ispublic indicates whether the classification represents a entity that is public false no risk level string risk level indicates the risk level assigned to the classification values are found in reference data as category risk level low risk low risk indyelgible boolean indyeligible indicates whether the classification is eligible for independence integration false no public interest entity boolean public interest entity indicates whether the classification represents an entity considered to be of public interest in certain countries false no industry classification type this category defines the various industry classification type using the following additional attribute(s) cmskey string n/a not used at this time n/a n/a language type this category defines the various language types using the following additional attribute(s) iso code string iso code the iso abbreviation for the language may include country as well fr ca fr ca local code string local code the method of referring to a language locally français canadien français canadien link types this category defines the types of links between decision management requests and other types, using the following additional attribute(s) inverse type string inverse type indicates the inverse label attached to a linked request or record clone of clone of location hierarchy this category defines the hierarchy between various types of locations using the following additional attribute(s) short code string short code the abbreviation or short code representing the location sometimes this is the same thing as the name or display key colorado colorado location type string location type the type of location values are found in reference data as location type office office name type this category defines the name types using the following additional attribute(s) other name boolean other name indicates if the name is considered an “other” type of name true yes object type string object type the list of object (entity) types the name is used with legal entity legal entity language key string language key the key used to manage the name in the language file for display purposes rd legal entity name type 240003 rd legal entity name type 240003 natural person contact this category defines the types of contact methods for natural person using the following additional attribute(s) note contact methods are not used at this time naturalpersoncontacttype string naturalpersoncontacttype the type of contact method represented phone phone natural person name this category defines the types of names used for natural person records using the following additional attribute(s) other name boolean other name indicates if the name is considered an “other” type of name true yes object type string object type the list of object (entity) types the name is used with 70006 natural person language key string language key the key used to manage the name in the language file for display purposes rd natural person name type 720001 rd natural person name type 720001 regulator this category defines the regulator values using the following additional attribute(s) country string country the string of the unique object identifier of the country the regulator is applicable for 560481 united states service sub classifications this category defines the sub classifications for dm services using the following additional attribute(s) service classification string service classification indicates the classification the sub classification is associated to consulting consulting sr flag this category defines the values utilized in the service request fields using the following additional attribute(s) priority integer priority the number indicates the priority order of the values and is used in calculations 1 1 services advisement string services advisement the message presented to the user when the value is selected a service request must be created in the online service request management system for all services proposed for this entity a service request must be created in the online service request management system for all services proposed for this entity legal entity designation override array n/a not used at this time n/a n/a natural person designation override array n/a not used at this time n/a n/a sr flag link this category creates the link between sr flag values fields using the following additional attribute(s) url string url the url of the external system used for review/approval https // https // label string label the label displayed in the user interface create service request create service request hidden boolean hidden indicates whether the value is hidden from display in the user interface false no location string location the string representing the unique object identifier of the location values are found in reference data as category location hierarchy 560429 global sr flag value string sr flag value the value displayed in the dropdown list in the user interface use ems (notify) use ems (notify) workflow allowed workitem type this category defines the type of workflow items allowed for different types of workflows using the following attribute(s) iscustom boolean iscustom indicates if the work item type is custom true yes needpersist boolean needpersist indicates if the work item type needs to be persisted true yes executionorder integer executionorder indicates the order in which the work item type should be executed 1 1 postpersistworkitem string postpersistworkitem indicates the webhook to perform specific workflow rules and/or calls out to other systems form task post persist hook form task post persist hook system controlled data the system controlled data are those elements that are used within em but are not directly visible or configurable by the client organization exports data model api field name type field / max limit default ui field label definition example api code / value example ui display exportid long export id the unique object identifier of the export object 15898 15898 exportname string (500) export name the name of the export entity apple entity apple filesize integer file size the size of the export file (stored in bytes, displayed in kilobytes) 3604 3 52 kb exporttype number export type 1 entity tree initiated integer initiated the unix date when the export was initiated 1669948455000 2022 12 02 10 34 15 completion integer completion the unix date when the export was completed 1669948552000 2022 12 02 10 35 52 status long status the status of the export 410003 failed errormsg string n/a the message returned if an error occurred with the export n/a 1 = entity tree 2 = my trees 3= member firm entity trees 4 = entity search results 5 = member firm clients 6 = member firm clients and affiliates 7 = entity saved search (triggered by subscriptions) this field displays the type of export that was initiated imports the fields are displayed in the import results page as well as the import status panel when an imported is clicked if the labels are different, both are listed data model api field name type field / max limit default ui field label definition example api code / value example ui display importdate integer the unix timestamp when the import was completed 1724255510436 2024 08 21 10 51 50 submissiondate integer the unix timestamp when the import was submitted 1724255442707 2024 08 21 10 50 42 status string status status completed completed filename string (250) file name the name of the file imported sally smith user import xls sally smith user import xls userid long uploaded by the unique object identifier of the user who uploaded the file 10133 janice anderson username string n/a the username of the user who uploaded the file janice anderson\@kingland com mailto\ janice anderson\@kingland com n/a reportmode boolean n/a indicates if the import was run in report mode false n/a allowminorrejections boolean allow minor rejections indicates if minor rejections should be accepted true checkbox is checked filesize integer file size the size of the file imported (stored in bytes, displayed in kilobytes) 18744 18 3 kb recordstotal integer the total number of records in the import file this is displayed in results column and import status panel in the user interface the results column will display an error message if a major rejection occurred, including the rejection code 1 recordsimported integer this is displayed in results column and import status panel in the user interface 1 1 of 1 recordsfailed integer failed this is displayed in import status panel in the user interface 0 workflowinstanceid long n/a the unique object identifier of the workflow instance created by the import 2008468 n/a displayworkflowinstanceid long batch id the identifier of the workflow instance created by the import 2008468 2008468 firstname string n/a the first name of the user the workflow is assigned to janice n/a lastname string n/a the last name of the user the workflow is assigned to anderson n/a displayname string batch assignee the display name of the user the workflow is assigned to janice anderson janice anderson processedstatus long n/a the unique object identifier of the processing status values are found in reference data as category processed status 440010 n/a id long import id the unique object identifier of the import object 1701 1701 defid long import type the unique object identifier of the workflow utilized to process the import 3 user import rejectionpath string \<download link> the path to the location of the rejection file this displays as a link and file download icon on record count for rejections in the import status panel of the user interface 1701/rejection sally smith user import xlsx download link and icon resultpath string \<download link> the path to the location of the import results file this displays as a link and file download icon on record count for processed in the import status panel of the user interface 1701/result sally smith user import xlsx download link and icon filepath string \<download link> the path to the location of the import file this displays as a link and file download icon on the file name in the import status panel of the user interface 1701/sally smith user import xlsx download link and icon completion completed date submission submission date status pending (pending processing) status level scan (record level scan) status approval (pending approval) status complete (completed) status canceled (canceled) status empty scan (empty file scan) status format scan (file format scan) status template scan (record template scan) status failed (failed) the status of the import values are processed results major rejection 104 1 of 1 successful successful records results permission management data model api field name type field / max limit default ui field label definition example api code / value example ui display permissionid long permission id the unique object identifier of the permission object 37 search legal entity permissionname string (100) name the name of the permission search legal entity search legal entity permissiondesc string (500) description the description of the permission ability to search legal entity domain ability to search legal entity domain isactive boolean n/a indicates whether the permission is active or not true n/a ruleset management data model api field name type field / max limit default ui field label definition example api code / value example ui display rulesetid long n/a the unique object identifier of the ruleset object 2115 n/a rulekey string n/a the key used to identify the ruleset rs3 n/a name string (64) name the name of the ruleset rs3 legal entity delegate inheritance phase rs3 legal entity delegate inheritance phase description string (200) description the description of the ruleset rs3 a set of rules that are run in the delegate inheritance phase of the legal entity changes workflow rs3 a set of rules that are run in the delegate inheritance phase of the legal entity changes workflow isactive boolean status indicates if the ruleset is active or not true active checkbox is checked rules array rules contains an object for each rule associated to the ruleset the following rule detail information, other than name, is visible in the user interface under the rules view but is not displayed in the rulesets view n/a n/a rules ruledefid long rules the unique object identifier of the rule n/a n/a rules rulekey string n/a the key used to display the rule n/a n/a rules name string name the name of the rule including the rule key ra1005 delegate assignment not allowed ra1005 delegate assignment not allowed rules description string (200) n/a the description of the rule ra1005 description n/a rules implref string (200) n/a used by the system to track and execute the rule delegateassignedwithnorpcheckrule n/a rules categorycode long n/a the unique object identifier of the rule category values are found in reference data as category rule category 300002 n/a rules defaulterrorlevelcode long n/a the unique object identifier of the type of error generated when triggered values are found in reference data as category rule error level 310001 n/a rules isactive boolean n/a indicate whether the rule is active or not true n/a rules defaultmetadata object n/a the object contains additional attributes defining the rule n/a n/a rules defaultmetadata primary fields string n/a lists the primary fields impacted by the rule userrole roleid isrp n/a rules defaultmetadata rule complexity string n/a indicates the complexity of the rule complex n/a rules defaultmetadata dependent fields string n/a indicates the fields the rule is dependent upon userrole roleid n/a rules message string n/a the unique identifier of the message displayed when the rule is triggered the actual message is found in language file using this key ra1005 message n/a rules basedefid long n/a the unique object identifier of the base rule the ruleset is associated to 15 n/a rules isconfigure boolean n/a indicates if the rule is configurable by the client organization true n/a rules isapex boolean n/a indicates if the rule is the top rule true n/a subscriptions data model field name type field / max limit default ui field label description example api code / value example ui display id long n/a the unique object identifier of the subscription object 135 n/a subscriptiontypecode long n/a the unique object identifier of the object type the subscription is for values are found in reference data as category subscription type “search” is the only value at this time 520001 n/a subscriptionobjectid long n/a the unique object identifier of the saved search that has been subscribed to 89 n/a userid long the unique object identifier of the user subscribed to the saved search 10133 janice anderson effectivestartdate integer the unix timestamp when the subscription became effective and started 1701935810890 december 7, 2023 1 56 50 am effectiveenddate integer the unix timestamp when the subscriptions expires 1724430387928 august 23, 2024 11 26 27 am subscriptionoptions object n/a this object contains the attributes defining the subscription n/a n/a subscriptionoptions intervaltypecode long interval the unique object identifier of the frequency of the subscription values are found in reference data as subscription interval type 520001 hourly subscriptionoptions intervaltypename string interval the name of the frequency of the subscription values are found in reference data as subscription interval type hourly hourly subscriptionoptions subscriptiontype string n/a the name of the subscription type values are found in reference data as subscription approach type the reference data value is appended to the object type of the subscription (e g , workflow instance, legal entity) workflow instance email n/a subscriptionoptions subscriptiontypeid long n/a the unique object identifier of the subscription type values are found in reference data as subscription approach type 760001 n/a subscribermodellist array n/a contains an object for each type of subscriber (i e , user, group) n/a n/a subscribermodellist id long n/a the unique object identifier of the subscription object 135 n/a subscribermodellistsubscribermodellist subscriptionid long n/a the unique object identifier of the subscription object 135 n/a subscribermodellist subscriberid long n/a the unique object identifier of the user or the group associated to the subscription 10133 n/a subscribermodellist subscribertypecode long n/a the unique object identifier of the type of object (user, group) associated to the subscription values are found in reference data as category subscriber type 530001 n/a workflow batch data model field name type field / max limit default ui field label definition example ap code / value example ui display status long status the unique object identifier of the task associated to the workflow instance values are found in reference data as category workflow task status displays as status in my tasks in user interface 360002 claimed userstartdate integer n/a the unix timestamp when the user started the workflow 1716987860025 n/a usercompletedate integer n/a the unix timestamp when the user completed the workflow 1717071891313 n/a enddate integer n/a the unix timestamp when the workflow instance ended 1724421516607 n/a step string n/a the name of the current step in the workflow definition the instance is at draft draft taskcreationdate integer n/a the unix timestamp when the instance was created 1716987860576 n/a comments string (500) n/a the comment associated to the workflow instance this is a comment n/a status name string status the name of the status of the workflow instance as displayed in my tasks view claimed claimed assigneduserid long assigned to the unique object identifier of the user assigned to the workflow instance 10118 syl gansemer workitemname string batch name the name of the entity that is the basis for the workflow instance the boeing company the boeing company last submitted date integer date submitted the unix timestamp of the last date the instance was submitted 1716987860576 2024 05 29 assigned date integer assigned date the unix timestamp when the instance was assigned 1716987860576 2024 05 29 assigned user name string assigned to the name of the user assigned to the instance syl gansemer syl gansemer instance id long id the unique object identifier of the workflow instance this is the child workflow instance if the id and parent id are not the same value 2007590 2007590 parent instance id long parent id the unique object identifier of the parent workflow instance this is the parent workflow instance if the id and parent id are not the same value 2007590 2007590 workgroup id long workgroup the unique object identifier of the current workgroup associated to the workflow instance 1032 gal2 ind glob workgroup name string workgroup the name of the current workgroup associated to the workflow instance gal2 ind glob gal2 ind glob last submitted user name string sender the name of the user who submitted the workflow causing the instance to be created mitch gansemer mitch gansemer last submitted user id long sender the unique object identifier of the user who submitted the workflow causing the instance to be created 10131 mitch gansemer workflowdefid long workflow definition the unique object identifier of the associated workflow definition 11 multiple approvers entity workflow parent workflowdefname string workflow definition the name of the associated workflow definition 10118 multiple approvers entity workflow parent multiple approvers entity workflow parent participating users array n/a contains an object for each participating user object associated to the instance n/a n/a participating users participating user id long participating user the unique object identifier of the participating user(s) associated to the instance 10118 syl gansemer participating users participating user displayname string participating user the name of the participating user(s) associated to the instance syl gansemer syl gansemer fullname string n/a the full name of the workflow instance which is a concatenation of the workflow instance id and the workitem name 2007590 the boeing company 2007590 the boeing company taskid long n/a the unique object identifier of the task associated to the workflow instance 11361 n/a task name string (200) n/a the name of the task which is a concatenation of “batch id”, instance id and workitem name batch id 2007590 draft the boeing company batch id 2007590 draft the boeing company push back reason id long n/a the unique object identifier of the pushback reason values are found in the specific workflow definition for the reject or push back transition 940 n/a push back reason string n/a the name of the pushback reason validation errors n/a last workgroup id long previous workgroup the unique object identifier of the previous workgroup associated to the workflow instance 1034 le draft last workgroup name string previous workgroup the name of the previous workgroup associated to the workflow instance le draft le draftl location id long location the unique object identifier of the location associated to the workflow instance values are found in reference data as category location hierarchy 560481 united states location name string location the name of the location associated to the workflow instance values are found in reference data as category location hierarchy united states united states step id long n/a the unique object identifier of the step within the workflow definition 1069 n/a is latest boolean true indicates whether this is the latest version of the workflow instance true n/a