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. | N/A | |
String (200) | | This is the user's email address. | |||
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. | 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 |