> ## Documentation Index > Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt > Use this file to discover all available pages before exploring further. # Return the RecordDataSummary of a public record > Sections, Conditions, ValueMaps, Fields, and a Record will be hanging together in the response. ## OpenAPI ````yaml GET /api/v1/records/public/{step}/data-summary openapi: 3.1.0 info: title: Risk Cloud API description: >- The Risk Cloud API is a collection of RESTful API endpoints that empower you and your team to directly integrate, automate, and build with the Risk Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints supporting exports in CSV and XSLX formats for flexible integration. This API documentation showcases our Risk Cloud API v1, containing a variety of endpoints with continued support for enabling integrations with the Risk Cloud. Visit the [LogicGate Risk Cloud Developer Portal](https://www.logicgate.com/developer/) to get started with building your custom integration with quick start guides, usage guides, release notes, and more. Or download the [v1 OpenAPI specification](/legacy-openapi.json). Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) endpoints and documentation as well. [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First endpoints that are tailor made for our developer users, offer concise and highly documented details, are supported by a [Postman collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc) and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi), and contain our latest API endpoint releases. contact: name: developer-relations@logicgate.com email: developer-relations@logicgate.com version: v2026.11.0 servers: - url: https://{subdomain}.logicgate.com description: Your Risk Cloud environment. variables: subdomain: description: Your Risk Cloud environment's subdomain (e.g. `qa`). default: your-instance security: - ApiToken: [] - basic: [] tags: - name: Authentication description: >- Getting Started: How to create an [API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) to begin integrating with the Risk Cloud API - name: Attachment description: Endpoints for uploading, downloading, and retrieving record attachments. - name: Field description: Endpoints for creating, updating, and querying fields. - name: Principal description: >- Endpoints for the authenticated principal to view and manage their own details. - name: Record Audit description: Endpoints for retrieving record audit history and productivity data. - name: Step description: Endpoints for retrieving steps and the steps a user can access. - name: Table Report description: Endpoints for retrieving and managing table reports. - name: User Group description: Endpoints for managing user groups and their membership. externalDocs: description: Developer Portal url: https://www.logicgate.com/developer/ paths: /api/v1/records/public/{step}/data-summary: get: tags: - Record summary: Return the RecordDataSummary of a public Record. description: >- Sections, Conditions, ValueMaps, Fields, and a Record will be hanging together in the response. operationId: getPublicRecordDataSummary parameters: - name: step in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RecordDataSummary_RecordDataSummary' components: schemas: RecordDataSummary_RecordDataSummary: type: object properties: record: type: string description: record sections: type: array items: $ref: '#/components/schemas/SectionObject_RecordDataSummary' conditions: type: array items: $ref: '#/components/schemas/FormCondition_RecordDataSummary' valueMaps: type: object additionalProperties: $ref: '#/components/schemas/ValueMap_RecordDataSummary' allAttachmentValues: type: array items: $ref: '#/components/schemas/CleanAttachment_RecordDataSummary' visibleAttachmentValues: type: array items: $ref: '#/components/schemas/CleanAttachment_RecordDataSummary' required: - conditions - record - sections - valueMaps SectionObject_RecordDataSummary: type: object discriminator: propertyName: sectionType oneOf: - $ref: '#/components/schemas/FormSection_RecordDataSummary' - description: >- And other types: Dashboard_RecordDataSummary, DashboardSection_RecordDataSummary, FieldLink_RecordDataSummary, FormSection_RecordDataSummary, FormSection_RecordDataSummary, FormSection_RecordDataSummary, GraphReport_RecordDataSummary, HtmlSection_RecordDataSummary, VisualReport, WorkflowLink_RecordDataSummary, AnalysisReport_RecordDataSummary, EmbeddedReport_RecordDataSummary, EvidenceSection_RecordDataSummary, DataWarehouseLink_RecordDataSummary, ScopingSection_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string color: type: string icon: type: string guidance: type: string priority: type: integer format: int32 colspan: type: integer format: int32 collapsed: type: boolean defaultState: type: string enum: - HIDDEN - INACTIVE conditionsEnabled: type: boolean conditionsUseAndOperator: type: boolean step: $ref: '#/components/schemas/Step_RecordDataSummary' stepId: type: string parentId: type: string conditionsValid: type: boolean conditionsAndParentsValid: type: boolean sectionType: type: string enum: - CONTENT_SECTION - DASHBOARD - DASHBOARD_SECTION - FIELD_LINK - FORM_SECTION - GRAPH_REPORT - HTML_SECTION - STEP_PAGE - SUB_SECTION - VISUAL_REPORT - WORKFLOW_LINK - JIRA_WORKFLOW_LINK - ANALYSIS_REPORT - EMBEDDED_REPORT - EVIDENCE_SECTION - DATA_WAREHOUSE_LINK - SCOPING_SECTION required: - active - collapsed - color - colspan - conditionsAndParentsValid - conditionsEnabled - conditionsUseAndOperator - conditionsValid - created - defaultState - guidance - icon - id - name - parentId - priority - step - stepId - updated FormCondition_RecordDataSummary: type: object description: Conditional display logic for sections on a node. properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time operator: type: string enum: - EQUALS - NOT_EQUALS - IS - IS_NOT - GREATER_THAN - GREATER_THAN_EQUALS - LESS_THAN - LESS_THAN_EQUALS - CONTAINS - DOES_NOT_CONTAIN - 'NULL' - NOT_NULL - DATE_RANGE - NUMERIC_RANGE priority: type: integer format: int32 field: $ref: '#/components/schemas/Field_RecordDataSummary' currentValue: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' fieldId: type: string currentValueId: type: string targetId: description: Circular reference to FormCondition_RecordDataSummary writeOnly: true valid: type: boolean conditionType: type: string target: $ref: '#/components/schemas/Section_RecordDataSummary' fieldType: type: string enum: - TEXT - EXTERNAL_USER - EXTERNAL_ID - TEXT_AREA - DATE_PICKER - NUMBER - E_SIGNATURE - CHECKBOX - MULTI_SELECT - RADIO - SELECT - USER - ATTACHMENT - CALCULATION - TEXT_CONCATENATION - FIXED_DATE_CALCULATION - LINKED_RECORDS_COUNT - DUE_DATE - DAYS_UNTIL_DUE - EVIDENCE - AEC_INFO - ANNUAL_LOSS_EXPOSURE required: - active - created - currentValue - currentValueId - field - fieldId - id - operator - priority - targetId - updated - valid ValueMap_RecordDataSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time user: type: string description: user currentValues: type: array items: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' field: type: string description: field aiGenerated: type: boolean aiUpdatedBy: type: string enum: - AUTOFILL - AUTOMATED_CONTROLS_TESTING - AGENT aiReason: type: string aiConfidence: type: string expressionResult: type: number format: double copyable: type: boolean aiSources: type: array items: $ref: '#/components/schemas/AiSource_RecordDataSummary' dynamicProperties: type: object additionalProperties: {} required: - active - aiConfidence - aiGenerated - aiReason - aiUpdatedBy - created - currentValues - dynamicProperties - field - id - updated - user CleanAttachment_RecordDataSummary: allOf: - $ref: '#/components/schemas/CurrentAttachmentValue_RecordDataSummary' FormSection_RecordDataSummary: allOf: - description: Circular reference to Section_RecordDataSummary - type: object properties: numberOfColumns: type: integer format: int32 readOnly: type: boolean required: - active - collapsed - color - colspan - conditionsAndParentsValid - conditionsEnabled - conditionsUseAndOperator - conditionsValid - created - defaultState - guidance - icon - id - name - numberOfColumns - parentId - priority - readOnly - step - stepId - updated Step_RecordDataSummary: type: object description: An entity to store details about a specific step within a workflow discriminator: propertyName: stepType oneOf: - $ref: '#/components/schemas/Origin_RecordDataSummary' - description: >- And other types: Chain_RecordDataSummary, End_RecordDataSummary, Origin_RecordDataSummary, Chain_RecordDataSummary, End_RecordDataSummary properties: stepType: type: string description: >- Step type. Advisory on writes. The server resolves the persisted step's type from the step id and ignores any client-supplied value. enum: - ORIGIN - CHAIN - END name: type: string description: Step name. description: type: string description: Description of the step. priority: type: integer format: int32 description: >- Determines the step's place in the workflow. Priority is in descending order with 0 being the first step. userGroupOperationType: type: string description: >- Determine how users are able to interact with user groups on the step. By default, new steps will allow FULL_ACCESS user group editing. enum: - FULL_ACCESS - ADD_ONLY - READ_ONLY xpos: type: integer format: int32 description: Vertical position of the step on the process screen. ypos: type: integer format: int32 description: Horizontal position of the step on the process screen. isPublic: type: boolean description: >- Allows a step to become a public step. Public steps allow for a shareable public record link to be generated in the step edit screen. Public steps do not require any login credentials. commentsEnabled: type: boolean description: Allows comments to be displayed on a step. documentsEnabled: type: boolean description: Allows documents to be generated on a step. externalUserMfaRequired: type: boolean description: >- Whether or not to require MFA for external users to access this step. uxriEnabled: type: boolean description: Whether or not to enable UXRI on the step. autofillEnabled: type: boolean description: Whether or not to enable autofill on the step. sla: $ref: '#/components/schemas/ServiceLevelAgreement_RecordDataSummary' description: Object containing all SLA information. assignableUserType: type: string description: >- Determine what users are able to be assigned to a record. By default, new records will allow APP_USERS as assignees. enum: - APP_AND_EXTERNAL_USERS - APP_USERS - EXTERNAL_USERS id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time end: type: boolean contains: description: Circular reference to Step_RecordDataSummary writeOnly: true origin: type: boolean chain: type: boolean required: - active - assignableUserType - autofillEnabled - commentsEnabled - created - description - documentsEnabled - externalUserMfaRequired - id - isPublic - name - priority - sla - stepType - updated - userGroupOperationType - uxriEnabled - xpos - ypos Field_RecordDataSummary: type: object description: >- An entity used to manage input fields used to capture record data for different workflows. discriminator: propertyName: fieldType oneOf: - $ref: '#/components/schemas/Text_RecordDataSummary' - description: >- And other types: ExternalUser_RecordDataSummary, ExternalId_RecordDataSummary, TextArea_RecordDataSummary, DatePicker_RecordDataSummary, Number_RecordDataSummary, ESignature_RecordDataSummary, Checkbox_RecordDataSummary, MultiSelect_RecordDataSummary, Radio_RecordDataSummary, Select_RecordDataSummary, Attachment_RecordDataSummary, User_RecordDataSummary, Evidence_RecordDataSummary, Calculation_RecordDataSummary, FixedDateCalculation_RecordDataSummary, LinkedRecordsCount_RecordDataSummary, DueDate_RecordDataSummary, TransientFieldDaysUntilDue_RecordDataSummary, AnnualLossExposure_RecordDataSummary, AecInfo_RecordDataSummary, Text_RecordDataSummary, ExternalUser_RecordDataSummary, ExternalId_RecordDataSummary, TextArea_RecordDataSummary, DatePicker_RecordDataSummary, Number_RecordDataSummary, ESignature_RecordDataSummary, Checkbox_RecordDataSummary, MultiSelect_RecordDataSummary, Radio_RecordDataSummary, Select_RecordDataSummary, Attachment_RecordDataSummary, User_RecordDataSummary, Evidence_RecordDataSummary, Calculation_RecordDataSummary, TextConcatenation_RecordDataSummary, FixedDateCalculation_RecordDataSummary, LinkedRecordsCount_RecordDataSummary, DueDate_RecordDataSummary, TransientFieldDaysUntilDue_RecordDataSummary, AnnualLossExposure_RecordDataSummary, AecInfo_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time fieldType: type: string enum: - TEXT - EXTERNAL_USER - EXTERNAL_ID - TEXT_AREA - DATE_PICKER - NUMBER - E_SIGNATURE - CHECKBOX - MULTI_SELECT - RADIO - SELECT - USER - ATTACHMENT - CALCULATION - TEXT_CONCATENATION - FIXED_DATE_CALCULATION - LINKED_RECORDS_COUNT - DUE_DATE - DAYS_UNTIL_DUE - EVIDENCE - AEC_INFO - ANNUAL_LOSS_EXPOSURE name: type: string description: The name of the field. labels: type: array items: type: string uniqueItems: true label: type: string description: >- The label will appear as the label for the field when it appears on forms for user's to complete. tooltip: type: string description: A text value that will populate any tooltip information. helpText: type: string description: >- A text value that supplies necessary context for a person to fill out an input field. format: type: string enum: - CURRENCY - DECIMAL currency: type: string enum: - EUR - GBP - USD enabledForRecordAccess: type: boolean currentValues: type: array description: >- Relationship to current values that are associated to the field. A field maybe have multiple current values associated to it. items: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' defaultValues: type: array description: >- Relationship to current values that are defaulted to the field. A field maybe have multiple default current values associated to it. items: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' workflow: $ref: '#/components/schemas/Workflow_RecordDataSummary' description: Workflow object that is associated to the field. analysisEstimate: type: string enum: - CONFIDENCE - MAXIMUM - MINIMUM - MOST_LIKELY analysisType: type: string enum: - CONTACT_FREQUENCY - LOSS_EVENT_FREQUENCY - LOSS_MAGNITUDE - PRIMARY_PRODUCTIVITY_LOSS - PRIMARY_RESPONSE_LOSS - PRIMARY_REPLACEMENT_LOSS - PRIMARY_COMPETITIVE_ADVANTAGE_LOSS - PRIMARY_FINES_OR_JUDGEMENTS_LOSS - PRIMARY_REPUTATION_DAMAGE_LOSS - PROBABILITY_OF_ACTION - RESISTANCE_STRENGTH - SECONDARY_PRODUCTIVITY_LOSS - SECONDARY_RESPONSE_LOSS - SECONDARY_REPLACEMENT_LOSS - SECONDARY_COMPETITIVE_ADVANTAGE_LOSS - SECONDARY_FINES_OR_JUDGEMENTS_LOSS - SECONDARY_REPUTATION_DAMAGE_LOSS - SECONDARY_LOSS_EVENT_FREQUENCY - SECONDARY_LOSS_MAGNITUDE - THREAT_CAPABILITY - THREAT_EVENT_FREQUENCY - VULNERABILITY operators: type: array items: type: string enum: - EQUALS - NOT_EQUALS - IS - IS_NOT - GREATER_THAN - GREATER_THAN_EQUALS - LESS_THAN - LESS_THAN_EQUALS - CONTAINS - DOES_NOT_CONTAIN - 'NULL' - NOT_NULL - DATE_RANGE - NUMERIC_RANGE convertibleTo: type: array items: type: string copyRecordAccessField: type: boolean currencyForNumberDisplayingFields: description: Circular reference to Field_RecordDataSummary writeOnly: true valueType: type: string global: type: boolean requiresUniqueValue: type: boolean parameterizedCurrentValues: type: array items: $ref: '#/components/schemas/CurrentValueObject_RecordDataSummary' writeOnly: true analysisOutputField: type: boolean discrete: type: boolean currentValuesFromOtherField: description: Circular reference to Field_RecordDataSummary writeOnly: true formatForNumberDisplayingFields: description: Circular reference to Field_RecordDataSummary writeOnly: true crossWorkflowCalculation: type: boolean validTypeForCalculationInput: type: boolean required: - active - analysisEstimate - analysisType - convertibleTo - copyRecordAccessField - created - currency - currentValues - defaultValues - enabledForRecordAccess - fieldType - format - helpText - id - label - labels - name - operators - tooltip - updated - workflow CurrentValue_RecordDataSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_RecordDataSummary' - description: >- And other types: CurrentDateValue_RecordDataSummary, CurrentDateRangeValue_RecordDataSummary, CurrentJobValue_RecordDataSummary, CurrentCommonValue_RecordDataSummary, CurrentDateValue_RecordDataSummary, CurrentDateRangeValue_RecordDataSummary, LabelValue_RecordDataSummary, CleanAttachment_RecordDataSummary, DirtyAttachment_RecordDataSummary, PendingAttachment_RecordDataSummary, CurrentGoogleAttachmentValue_RecordDataSummary, CurrentSharepointAttachmentValue_RecordDataSummary, Active_RecordDataSummary, Automated_RecordDataSummary, Disabled_RecordDataSummary, External_RecordDataSummary, Locked_RecordDataSummary, Service_RecordDataSummary, CurrentNumericRangeValue_RecordDataSummary, CurrentJobValue_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time valueType: type: string discriminator: type: string textValue: type: string numericValue: type: number format: double isDefault: type: boolean archived: type: boolean priority: type: integer format: int32 userGroup: type: string description: usergroup fieldId: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - archived - created - discriminator - id - isDefault - numericValue - priority - textValue - updated - userGroup - valueType Section_RecordDataSummary: type: object discriminator: propertyName: sectionType oneOf: - $ref: '#/components/schemas/FormSection_RecordDataSummary' - description: >- And other types: Dashboard_RecordDataSummary, DashboardSection_RecordDataSummary, FieldLink_RecordDataSummary, FormSection_RecordDataSummary, FormSection_RecordDataSummary, FormSection_RecordDataSummary, GraphReport_RecordDataSummary, HtmlSection_RecordDataSummary, VisualReport, WorkflowLink_RecordDataSummary, AnalysisReport_RecordDataSummary, EmbeddedReport_RecordDataSummary, EvidenceSection_RecordDataSummary, DataWarehouseLink_RecordDataSummary, ScopingSection_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string color: type: string icon: type: string guidance: type: string priority: type: integer format: int32 colspan: type: integer format: int32 collapsed: type: boolean defaultState: type: string enum: - HIDDEN - INACTIVE conditionsEnabled: type: boolean conditionsUseAndOperator: type: boolean step: $ref: '#/components/schemas/Step_RecordDataSummary' stepId: type: string parentId: type: string conditionsValid: type: boolean conditionsAndParentsValid: type: boolean sectionType: type: string enum: - CONTENT_SECTION - DASHBOARD - DASHBOARD_SECTION - FIELD_LINK - FORM_SECTION - GRAPH_REPORT - HTML_SECTION - STEP_PAGE - SUB_SECTION - VISUAL_REPORT - WORKFLOW_LINK - JIRA_WORKFLOW_LINK - ANALYSIS_REPORT - EMBEDDED_REPORT - EVIDENCE_SECTION - DATA_WAREHOUSE_LINK - SCOPING_SECTION required: - active - collapsed - color - colspan - conditionsAndParentsValid - conditionsEnabled - conditionsUseAndOperator - conditionsValid - created - defaultState - guidance - icon - id - name - parentId - priority - step - stepId - updated AiSource_RecordDataSummary: type: object properties: type: type: string enum: - USER_ATTACHMENT - FIELD - PROMPT - GENERATED name: type: string required: - name - type CurrentAttachmentValue_RecordDataSummary: type: object description: Entity storing attachment related information of a field's value. discriminator: propertyName: attachmentStatus oneOf: - $ref: '#/components/schemas/PendingAttachment_RecordDataSummary' - description: >- And other types: CleanAttachment_RecordDataSummary, DirtyAttachment_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time valueType: type: string discriminator: type: string textValue: type: string numericValue: type: number format: double isDefault: type: boolean archived: type: boolean priority: type: integer format: int32 userGroup: type: string description: usergroup attachmentStatus: type: string contentType: type: string fileSize: type: integer format: int64 fileExtension: type: string originalFileExtension: type: string awsS3Key: type: string versionCount: type: integer format: int32 updatedBy: type: string source: type: string enum: - USER - GOOGLE - SHAREPOINT office365Eligible: type: boolean wopiFileLockPresent: type: boolean fieldId: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - archived - attachmentStatus - awsS3Key - contentType - created - discriminator - fileExtension - fileSize - id - isDefault - numericValue - originalFileExtension - priority - source - textValue - updated - updatedBy - userGroup - valueType - versionCount Origin_RecordDataSummary: allOf: - description: Circular reference to Step_RecordDataSummary ServiceLevelAgreement_RecordDataSummary: type: object properties: enabled: type: boolean duration: type: integer format: int64 required: - duration - enabled Text_RecordDataSummary: allOf: - description: Circular reference to Field_RecordDataSummary required: - fieldType Workflow_RecordDataSummary: type: object description: >- An entity that contains information about a set of steps within a particular application. discriminator: propertyName: workflowType oneOf: - $ref: '#/components/schemas/ControlWorkflow_RecordDataSummary' - description: 'And other types: JiraWorkflow_RecordDataSummary' properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string description: Name of the workflow. description: type: string description: Description of the workflow. maxLength: 2000 minLength: 0 recordPrefix: type: string description: Name to be used for every record created from the workflow. allowGroups: type: boolean description: Nodes created in the workflow are allowed user groups. requireGroups: type: boolean description: Nodes created in the workflow require user groups. xpos: type: integer format: int32 description: X axis position of the workflow on the application screen ypos: type: integer format: int32 description: Y axis position of the workflow on the application screen priority: type: integer format: int32 description: >- Determines the workflow's place in the application. Priority is in descending order with 0 being the first workflow. sla: $ref: '#/components/schemas/ServiceLevelAgreement_RecordDataSummary' description: Object containing all SLA information. allowAec: type: boolean description: Enables automated evidence collection. allowRcsa: type: boolean description: Allow Risk & Control Self-Assessments. sequence: $ref: '#/components/schemas/WorkflowSequence_RecordDataSummary' application: $ref: '#/components/schemas/Application_RecordDataSummary' description: Application that the workflow belongs to. userGroups: type: array description: User groups that are allowed access to the workflow items: $ref: '#/components/schemas/UserGroup_RecordDataSummary' primaryField: $ref: '#/components/schemas/PrimaryField_RecordDataSummary' workflowType: type: string enum: - WORKFLOW - JIRA_WORKFLOW - CONTROL_WORKFLOW - ANALYSIS_WORKFLOW currentValueUserGroupMappings: type: array items: $ref: >- #/components/schemas/CurrentValueUserGroupMapping_RecordDataSummary automatedAccessEnabled: type: boolean automatedAccessFields: type: array description: Fields that triggers automated access changes items: description: >- An entity used to manage input fields used to capture record data for different workflows. properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time fieldType: type: string enum: - TEXT - EXTERNAL_USER - EXTERNAL_ID - TEXT_AREA - DATE_PICKER - NUMBER - E_SIGNATURE - CHECKBOX - MULTI_SELECT - RADIO - SELECT - USER - ATTACHMENT - CALCULATION - TEXT_CONCATENATION - FIXED_DATE_CALCULATION - LINKED_RECORDS_COUNT - DUE_DATE - DAYS_UNTIL_DUE - EVIDENCE - AEC_INFO - ANNUAL_LOSS_EXPOSURE name: type: string description: The name of the field. labels: type: array items: type: string uniqueItems: true label: type: string description: >- The label will appear as the label for the field when it appears on forms for user's to complete. tooltip: type: string description: A text value that will populate any tooltip information. helpText: type: string description: >- A text value that supplies necessary context for a person to fill out an input field. format: type: string enum: - CURRENCY - DECIMAL currency: type: string enum: - EUR - GBP - USD enabledForRecordAccess: type: boolean currentValues: type: array description: >- Relationship to current values that are associated to the field. A field maybe have multiple current values associated to it. items: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' defaultValues: type: array description: >- Relationship to current values that are defaulted to the field. A field maybe have multiple default current values associated to it. items: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' workflow: description: Workflow object that is associated to the field. analysisEstimate: type: string enum: - CONFIDENCE - MAXIMUM - MINIMUM - MOST_LIKELY analysisType: type: string enum: - CONTACT_FREQUENCY - LOSS_EVENT_FREQUENCY - LOSS_MAGNITUDE - PRIMARY_PRODUCTIVITY_LOSS - PRIMARY_RESPONSE_LOSS - PRIMARY_REPLACEMENT_LOSS - PRIMARY_COMPETITIVE_ADVANTAGE_LOSS - PRIMARY_FINES_OR_JUDGEMENTS_LOSS - PRIMARY_REPUTATION_DAMAGE_LOSS - PROBABILITY_OF_ACTION - RESISTANCE_STRENGTH - SECONDARY_PRODUCTIVITY_LOSS - SECONDARY_RESPONSE_LOSS - SECONDARY_REPLACEMENT_LOSS - SECONDARY_COMPETITIVE_ADVANTAGE_LOSS - SECONDARY_FINES_OR_JUDGEMENTS_LOSS - SECONDARY_REPUTATION_DAMAGE_LOSS - SECONDARY_LOSS_EVENT_FREQUENCY - SECONDARY_LOSS_MAGNITUDE - THREAT_CAPABILITY - THREAT_EVENT_FREQUENCY - VULNERABILITY operators: type: array items: type: string enum: - EQUALS - NOT_EQUALS - IS - IS_NOT - GREATER_THAN - GREATER_THAN_EQUALS - LESS_THAN - LESS_THAN_EQUALS - CONTAINS - DOES_NOT_CONTAIN - 'NULL' - NOT_NULL - DATE_RANGE - NUMERIC_RANGE convertibleTo: type: array items: type: string copyRecordAccessField: type: boolean currencyForNumberDisplayingFields: description: Circular reference to Field_RecordDataSummary writeOnly: true valueType: type: string global: type: boolean requiresUniqueValue: type: boolean parameterizedCurrentValues: type: array items: $ref: '#/components/schemas/CurrentValueObject_RecordDataSummary' writeOnly: true analysisOutputField: type: boolean discrete: type: boolean currentValuesFromOtherField: description: Circular reference to Field_RecordDataSummary writeOnly: true formatForNumberDisplayingFields: description: Circular reference to Field_RecordDataSummary writeOnly: true crossWorkflowCalculation: type: boolean validTypeForCalculationInput: type: boolean required: - fieldType maxItems: 6 minItems: 0 automatedAccessFieldId: type: string summaryFields: type: array items: type: object properties: workflow: description: Circular reference to Workflow_RecordDataSummary writeOnly: true field: description: Circular reference to Field_RecordDataSummary priority: type: integer format: int32 neo4jId: type: string fieldId: type: string required: - priority maxItems: 5 minItems: 0 contains: description: Circular reference to Workflow_RecordDataSummary writeOnly: true canSelect: description: Circular reference to Workflow_RecordDataSummary writeOnly: true pluralizedRecordPrefix: type: string required: - active - allowAec - allowGroups - allowRcsa - application - automatedAccessEnabled - automatedAccessFieldId - automatedAccessFields - created - currentValueUserGroupMappings - description - id - name - primaryField - priority - recordPrefix - requireGroups - sequence - sla - summaryFields - updated - userGroups - workflowType - xpos - ypos CurrentValueObject_RecordDataSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_RecordDataSummary' - description: >- And other types: CurrentDateValue_RecordDataSummary, CurrentDateRangeValue_RecordDataSummary, CurrentJobValue_RecordDataSummary, CurrentCommonValue_RecordDataSummary, CurrentDateValue_RecordDataSummary, CurrentDateRangeValue_RecordDataSummary, LabelValue_RecordDataSummary, CleanAttachment_RecordDataSummary, DirtyAttachment_RecordDataSummary, PendingAttachment_RecordDataSummary, CurrentGoogleAttachmentValue_RecordDataSummary, CurrentSharepointAttachmentValue_RecordDataSummary, Active_RecordDataSummary, Automated_RecordDataSummary, Disabled_RecordDataSummary, External_RecordDataSummary, Locked_RecordDataSummary, Service_RecordDataSummary, CurrentNumericRangeValue_RecordDataSummary, CurrentJobValue_RecordDataSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time valueType: type: string discriminator: type: string textValue: type: string numericValue: type: number format: double isDefault: type: boolean archived: type: boolean priority: type: integer format: int32 userGroup: type: string description: usergroup fieldId: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - archived - created - discriminator - id - isDefault - numericValue - priority - textValue - updated - userGroup - valueType CurrentCommonValue_RecordDataSummary: allOf: - description: Circular reference to CurrentValue_RecordDataSummary required: - description - guidance PendingAttachment_RecordDataSummary: allOf: - $ref: '#/components/schemas/CurrentValue_RecordDataSummary' ControlWorkflow_RecordDataSummary: allOf: - description: Circular reference to Workflow_RecordDataSummary - type: object properties: recordCount: type: integer format: int32 centralFramework: type: boolean required: - active - allowAec - centralFramework - created - id - recordCount - requireGroups - updated - workflowType WorkflowSequence_RecordDataSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time required: - active - created - id - updated Application_RecordDataSummary: type: object description: >- An entity for managing top-level application data. A application represents the highest level of organization for other entities within the application. properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string description: Name of the application. createdBy: $ref: '#/components/schemas/User_RecordDataSummary' description: Creator of the application. description: type: string description: Description of the application. maxLength: 2000 minLength: 0 color: type: string description: Icon color of the application. icon: type: string description: Icon type of the application. enum: - >- fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle type: type: string sourceApplicationId: type: string sourceEnvironment: type: string permissionsEnabled: type: boolean imported: type: boolean copied: type: boolean live: type: boolean currency: type: string enum: - EUR - GBP - USD uxriEnabled: type: boolean description: Whether or not UXRI is enabled on this application. shortCode: type: string description: Short display code for the application in navigation. pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$ defaultHomeScreen: $ref: '#/components/schemas/HomeScreen_RecordDataSummary' required: - active - color - copied - created - createdBy - currency - defaultHomeScreen - description - icon - id - imported - live - name - permissionsEnabled - shortCode - sourceApplicationId - sourceEnvironment - type - updated - uxriEnabled UserGroup_RecordDataSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time recordDefault: type: boolean title: type: string automatedUserGroup: type: boolean automatedUserGroupFieldLabel: type: string required: - active - automatedUserGroup - automatedUserGroupFieldLabel - created - id - recordDefault - title - updated PrimaryField_RecordDataSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time field: description: Circular reference to Field_RecordDataSummary systemField: type: string enum: - NAME - STATUS - CREATED - ENTERED_STEP_DATE - USER_DATE - EFFECTIVE_DUE_DATE - STEP_DUE_DATE - CURRENT_DATE - DUE_DATE - DAYS_UNTIL_DUE - SIMILARITY - RATIONALE - MATCH_CONFIDENCE - COMPLETED_DATE - LAST_COMPLETED_DATE - ID - SEQUENCE - ASSESSMENT_COUNT - USER_NAME - USER_ID - CREATOR_NAME - USER_GROUP - STEP_NAME - STEP_ID - ORIGIN_NAME - ORIGIN_ID - WORKFLOW_NAME - WORKFLOW_RECORD_PREFIX - WORKFLOW_ID - PRIMARY_FIELD - STATE name: type: string required: - active - created - field - id - name - systemField - updated CurrentValueUserGroupMapping_RecordDataSummary: type: object properties: currentValue: $ref: '#/components/schemas/CurrentValue_RecordDataSummary' userGroup: $ref: '#/components/schemas/UserGroup_RecordDataSummary' required: - currentValue - userGroup User_RecordDataSummary: allOf: - description: Circular reference to Field_RecordDataSummary required: - fieldType - permissionSets - roles HomeScreen_RecordDataSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time required: - active - created - id - updated securitySchemes: ApiToken: type: http scheme: bearer bearerFormat: API Token basic: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.