> ## 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. # Retrieve a list of bulk create workflow source > Used to get a list of bulk create workflow source based on the workflow link id.Please see the API Usage Guide for this endpoint for further instructions. ## OpenAPI ````yaml GET /api/v1/bulk-create-workflow-source/section/workflow-link/{id} 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/bulk-create-workflow-source/section/workflow-link/{id}: get: tags: - BulkCreateWorkflowSource summary: Retrieve a list of bulk create workflow source. description: >- Used to get a list of bulk create workflow source based on the workflow link id.Please see the API Usage Guide for this endpoint for further instructions. operationId: getBulkCreateWorkflowSource parameters: - name: id in: path description: The unique ID of the workflowLink required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/BulkCreateWorkflowSource' components: schemas: BulkCreateWorkflowSource: type: object properties: sourceWorkflow: $ref: '#/components/schemas/Workflow' layout: $ref: '#/components/schemas/Layout' sourceSearchStep: $ref: '#/components/schemas/Step' destinationCreateStep: $ref: '#/components/schemas/Step' defaultAssignee: $ref: '#/components/schemas/Crossflow' defaultDueDate: $ref: '#/components/schemas/Crossflow' tableReport: $ref: '#/components/schemas/TableReport' id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time sourceType: type: string enum: - workflow required: - active - created - defaultAssignee - defaultDueDate - destinationCreateStep - id - layout - sourceSearchStep - sourceWorkflow - tableReport - updated Workflow: 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' - description: 'And other types: JiraWorkflow' 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' description: Object containing all SLA information. allowAec: type: boolean description: Enables automated evidence collection. allowRcsa: type: boolean description: Allow Risk & Control Self-Assessments. workflowMaps: type: array items: $ref: '#/components/schemas/WorkflowMap' fields: type: array items: description: Circular reference to Field steps: type: array description: List of nodes that the workflow contains. items: $ref: '#/components/schemas/Step' sequence: $ref: '#/components/schemas/WorkflowSequence' application: $ref: '#/components/schemas/Application' 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' primaryField: $ref: '#/components/schemas/PrimaryField' applicationId: type: string workflowType: type: string enum: - WORKFLOW - JIRA_WORKFLOW - CONTROL_WORKFLOW - ANALYSIS_WORKFLOW currentValueUserGroupMappings: type: array items: $ref: '#/components/schemas/CurrentValueUserGroupMapping' automatedAccessEnabled: type: boolean automatedAccessFields: type: array description: Fields that triggers automated access changes items: description: Circular reference to Field maxItems: 6 minItems: 0 automatedAccessFieldId: type: string summaryFields: type: array items: $ref: '#/components/schemas/WorkflowSummaryField' maxItems: 5 minItems: 0 applicationName: type: string contains: description: Circular reference to Workflow writeOnly: true canSelect: description: Circular reference to Workflow writeOnly: true pluralizedRecordPrefix: type: string required: - active - allowAec - allowGroups - allowRcsa - application - applicationId - automatedAccessEnabled - automatedAccessFieldId - automatedAccessFields - created - currentValueUserGroupMappings - description - fields - id - name - primaryField - priority - recordPrefix - requireGroups - sequence - sla - steps - summaryFields - updated - userGroups - workflowMaps - workflowType - xpos - ypos Layout: type: object description: >- An entity used to group a collection of layout fields related to record data discriminator: propertyName: layoutType oneOf: - $ref: '#/components/schemas/Default' - description: >- And other types: Repository, Display, TableReport, Default, Repository, Display, TableReport properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time title: type: string defaultLayout: type: boolean layoutFields: type: array items: $ref: '#/components/schemas/LayoutField' workflow: description: Circular reference to Workflow workflowId: type: string layoutFieldNames: type: array items: type: string layoutType: type: string required: - active - created - defaultLayout - id - layoutFieldNames - layoutFields - title - updated - workflow - workflowId Step: type: object description: An entity to store details about a specific step within a workflow discriminator: propertyName: stepType oneOf: - $ref: '#/components/schemas/Origin' - description: 'And other types: Chain, End, Origin, Chain, End' 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' description: Object containing all SLA information. workflow: description: Circular reference to Workflow workflowId: type: string 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 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 - workflow - workflowId - xpos - ypos Crossflow: type: object description: An entity for managing cross-workflow field data and crossflow rules. properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time crossflowReducer: type: string description: Determination of a field in X_TO_MANY linked workflow scenarios. enum: - NEWEST - OLDEST - MOST_RECENTLY_LINKED - LEAST_RECENTLY_LINKED - SUM - AVERAGE - HIGHEST - LOWEST systemField: type: string description: >- Optional. A system field that will drive crossflow rules. Will always be null when an field rule uses a custom field instead of a system field. 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 fieldWorkflow: $ref: '#/components/schemas/Workflow' description: The owning workflow of the field that will drive crossflow rules. customField: $ref: '#/components/schemas/Field' description: >- Optional. A field that will drive crossflow rules. Will always be null when an field rule uses a system field instead of a custom field. priority: type: integer format: int32 description: >- Determines the fields place within the expression. Priority is in descending order with 0 being the first field in the expression. calcSpecificToStep: type: boolean description: Determines if calc field operation is specific to step. calcStep: $ref: '#/components/schemas/Step' description: Selected step for calc field operation. required: - active - calcSpecificToStep - calcStep - created - crossflowReducer - customField - fieldWorkflow - id - priority - systemField - updated TableReport: allOf: - $ref: '#/components/schemas/Layout' - type: object properties: userFilterAndSort: $ref: '#/components/schemas/UserFilterAndSort' filterList: type: array items: $ref: '#/components/schemas/ReportFilter' workflowJoins: type: array items: $ref: '#/components/schemas/TableReportJoin' priority: type: integer format: int32 description: type: string documentsEnabled: type: boolean inlineEditEnabled: type: boolean asyncExportEnabled: type: boolean includeArchivedRecords: type: boolean flattenTableEnabled: type: boolean flattenReducer: type: string enum: - MOST_RECENTLY_CREATED - FIRST_CREATED aiInsightsEnabled: type: boolean autoExpand: type: boolean version: type: integer format: int32 lastAccessed: type: string format: date-time pageSize: type: integer format: int32 viewableTitle: type: string required: - aiInsightsEnabled - asyncExportEnabled - autoExpand - description - documentsEnabled - filterList - flattenReducer - flattenTableEnabled - includeArchivedRecords - inlineEditEnabled - lastAccessed - priority - userFilterAndSort - version - workflowJoins ControlWorkflow: allOf: - description: Circular reference to Workflow - type: object properties: recordCount: type: integer format: int32 centralFramework: type: boolean required: - active - allowAec - centralFramework - created - id - recordCount - requireGroups - updated - workflowType ServiceLevelAgreement: type: object properties: enabled: type: boolean duration: type: integer format: int64 required: - duration - enabled WorkflowMap: type: object description: >- A super-class that is used to manage the relationship type between two connected workflows. discriminator: propertyName: workflowMapType oneOf: - $ref: '#/components/schemas/OneToOne' - description: >- And other types: OneToMany, ManyToOne, ManyToMany, OneToOne, OneToMany, ManyToOne, ManyToMany properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time workflow: description: Circular reference to Workflow parentWorkflow: description: Circular reference to Workflow parentId: type: string childId: type: string parentResult: $ref: '#/components/schemas/WorkflowResult' workflowMapType: type: string description: WorkflowMap type required: - active - childId - created - id - parentId - parentResult - parentWorkflow - updated - workflow - workflowMapType WorkflowSequence: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time value: type: integer format: int64 incrementBy: type: integer format: int64 format: type: string required: - active - created - format - id - incrementBy - updated - value Application: 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: description: Circular reference to User 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}$ workflows: type: array description: Workflows associated to the application. items: description: Circular reference to Workflow defaultHomeScreen: $ref: '#/components/schemas/HomeScreen' required: - active - color - copied - created - createdBy - currency - defaultHomeScreen - description - icon - id - imported - live - name - permissionsEnabled - shortCode - sourceApplicationId - sourceEnvironment - type - updated - uxriEnabled - workflows UserGroup: 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 users: type: array items: description: Circular reference to User currentValue: $ref: '#/components/schemas/CurrentValue' required: - active - automatedUserGroup - automatedUserGroupFieldLabel - created - currentValue - id - recordDefault - title - updated - users PrimaryField: 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 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: type: object properties: currentValue: $ref: '#/components/schemas/CurrentValue' userGroup: $ref: '#/components/schemas/UserGroup' required: - currentValue - userGroup WorkflowSummaryField: type: object properties: workflow: description: Circular reference to Workflow writeOnly: true field: description: Circular reference to Field priority: type: integer format: int32 neo4jId: type: string fieldId: type: string required: - priority Default: allOf: - description: Circular reference to Layout description: >- The "default" layout functions as the application's fallback when there is no workflow specific layout to use or a user specific layout to use. LayoutField: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time header: type: string priority: type: integer format: int32 link: type: boolean direction: type: string enum: - ASC - DESC 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 labelDisplayType: type: string enum: - VALUE - LABEL - ALL workflow: type: string description: workflow field: type: string description: field workflowMap: type: string description: workflow fieldId: type: string workflowId: type: string workflowMapId: type: string layoutId: type: string toDelete: type: boolean isPrimaryField: type: boolean primaryField: type: boolean 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 headerOrFieldName: type: string category: type: string enum: - ANALYSIS - APPLICATION - AUTOMATED_EVIDENCE - GLOBAL - RECORD - USERS - WORKFLOW sortProperty: type: string sortable: type: boolean customField: type: boolean required: - active - created - direction - field - fieldId - header - id - isPrimaryField - labelDisplayType - layoutId - link - priority - systemField - toDelete - updated - workflow - workflowId - workflowMap - workflowMapId Origin: allOf: - description: Circular reference to Step Field: 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' - description: >- And other types: ExternalUser, ExternalId, TextArea, DatePicker, Number, ESignature, Checkbox, MultiSelect, Radio, Select, Attachment, User, Evidence, Calculation, FixedDateCalculation, LinkedRecordsCount, DueDate, TransientFieldDaysUntilDue, AnnualLossExposure, AecInfo, Text, ExternalUser, ExternalId, TextArea, DatePicker, Number, ESignature, Checkbox, MultiSelect, Radio, Select, Attachment, User, Evidence, Calculation, TextConcatenation, FixedDateCalculation, LinkedRecordsCount, DueDate, TransientFieldDaysUntilDue, AnnualLossExposure, AecInfo 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' 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' workflow: $ref: '#/components/schemas/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 workflowId: type: string copyRecordAccessField: type: boolean currencyForNumberDisplayingFields: description: Circular reference to Field writeOnly: true valueType: type: string global: type: boolean requiresUniqueValue: type: boolean parameterizedCurrentValues: type: array items: $ref: '#/components/schemas/CurrentValueObject' writeOnly: true analysisOutputField: type: boolean discrete: type: boolean currentValuesFromOtherField: description: Circular reference to Field writeOnly: true formatForNumberDisplayingFields: description: Circular reference to Field 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 - workflowId UserFilterAndSort: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time sortDirection: type: string enum: - ASC - DESC sortColumnId: type: string 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 sortField: description: Circular reference to Field tableReport: description: Circular reference to TableReport userFilters: type: array items: $ref: '#/components/schemas/UserFilter' required: - active - created - id - sortColumnId - sortDirection - sortField - systemField - tableReport - updated - userFilters ReportFilter: type: object discriminator: propertyName: filterType oneOf: - description: Circular reference to BuildFilter properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time filterType: type: string fixed: type: boolean 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 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 myUserFilter: type: boolean labelFilter: type: boolean discreteLabels: type: array items: type: string uniqueItems: true type: type: string field: description: Circular reference to Field values: type: array items: $ref: '#/components/schemas/CurrentValue' recordRelationship: type: string enum: - CURRENT_STEP - ORIGIN_STEP filteredRelatives: type: array items: $ref: '#/components/schemas/Step' workflow: description: Circular reference to Workflow filteredRelativeIds: type: array items: type: string workflowId: type: string currentValueIds: type: array items: type: string userStatus: type: string enum: - ACTIVE - DISABLED - EXTERNAL - LOCKED - SERVICE - AUTOMATED valid: type: boolean required: - active - created - currentValueIds - discreteLabels - field - filterType - filteredRelativeIds - filteredRelatives - fixed - id - labelFilter - myUserFilter - operator - recordRelationship - systemField - type - updated - userStatus - values - workflow - workflowId TableReportJoin: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time isDistinct: type: boolean comesFrom: description: Circular reference to TableReportJoin joinedWorkflow: description: Circular reference to Workflow joinedThrough: $ref: '#/components/schemas/WorkflowMap' comesFromId: type: string distinct: type: boolean relativeDepth: type: integer format: int32 required: - active - comesFrom - comesFromId - created - id - isDistinct - joinedThrough - joinedWorkflow - updated OneToOne: allOf: - description: Circular reference to WorkflowMap WorkflowResult: type: object properties: allowAec: type: boolean allowGroups: type: boolean id: type: string name: type: string recordPrefix: type: string xpos: type: integer format: int32 ypos: type: integer format: int32 workflowType: type: string enum: - WORKFLOW - JIRA_WORKFLOW - CONTROL_WORKFLOW - ANALYSIS_WORKFLOW application: $ref: '#/components/schemas/ApplicationResult' required: - allowAec - allowGroups - application - id - name - recordPrefix - workflowType - xpos - ypos HomeScreen: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time title: type: string description: type: string availableToAll: type: boolean tableReports: type: array items: $ref: '#/components/schemas/TableReport' application: description: Circular reference to Application dashboard: $ref: '#/components/schemas/Dashboard' users: type: array items: description: Circular reference to User uniqueItems: true roles: type: array items: $ref: '#/components/schemas/Role' uniqueItems: true creator: description: Circular reference to User defaultTableReports: type: array items: $ref: '#/components/schemas/DefaultTableReport' required: - active - application - availableToAll - created - creator - dashboard - defaultTableReports - description - id - roles - tableReports - title - updated - users CurrentValue: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue' - description: >- And other types: CurrentDateValue, CurrentDateRangeValue, CurrentJobValue, CurrentCommonValue, CurrentDateValue, CurrentDateRangeValue, LabelValue, CleanAttachment, DirtyAttachment, PendingAttachment, CurrentGoogleAttachmentValue, CurrentSharepointAttachmentValue, Active, Automated, Disabled, External, Locked, Service, CurrentNumericRangeValue, CurrentJobValue 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 field: type: string description: field 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 - field - id - isDefault - numericValue - priority - textValue - updated - userGroup - valueType Text: allOf: - description: Circular reference to Field required: - fieldType CurrentValueObject: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - description: Circular reference to CurrentCommonValue - description: >- And other types: CurrentDateValue, CurrentDateRangeValue, CurrentJobValue, CurrentCommonValue, CurrentDateValue, CurrentDateRangeValue, LabelValue, CleanAttachment, DirtyAttachment, PendingAttachment, CurrentGoogleAttachmentValue, CurrentSharepointAttachmentValue, Active, Automated, Disabled, External, Locked, Service, CurrentNumericRangeValue, CurrentJobValue 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 field: type: string description: field 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 - field - id - isDefault - numericValue - priority - textValue - updated - userGroup - valueType UserFilter: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time filterType: type: string fixed: type: boolean 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 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 myUserFilter: type: boolean labelFilter: type: boolean discreteLabels: type: array items: type: string uniqueItems: true type: type: string field: description: Circular reference to Field values: type: array items: $ref: '#/components/schemas/CurrentValue' recordRelationship: type: string enum: - CURRENT_STEP - ORIGIN_STEP filteredRelatives: type: array items: $ref: '#/components/schemas/Step' workflow: description: Circular reference to Workflow filteredRelativeIds: type: array items: type: string workflowId: type: string currentValueIds: type: array items: type: string userStatus: type: string enum: - ACTIVE - DISABLED - EXTERNAL - LOCKED - SERVICE - AUTOMATED user: description: Circular reference to User buildFilter: $ref: '#/components/schemas/BuildFilter' enabled: type: boolean valid: type: boolean required: - active - buildFilter - created - enabled - filterType - id - updated - user ApplicationResult: type: object properties: id: type: string name: type: string shortCode: type: string color: type: string icon: type: string hasDashboard: type: boolean type: type: string live: type: boolean permissionsEnabled: type: boolean workflows: type: array items: description: Circular reference to WorkflowResult required: - color - hasDashboard - icon - id - live - name - permissionsEnabled - shortCode - type - workflows Dashboard: allOf: - $ref: '#/components/schemas/Section' - type: object properties: creator: description: Circular reference to User owner: description: Circular reference to User editor: description: Circular reference to User filters: type: array items: $ref: '#/components/schemas/ReportFilter' workflow: description: Circular reference to Workflow viewableTitle: type: string required: - active - collapsed - color - colspan - conditionsAndParentsValid - conditionsEnabled - conditionsUseAndOperator - conditionsValid - created - creator - defaultState - editor - filters - guidance - icon - id - name - owner - parent - parentId - priority - step - stepId - updated Role: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string locked: type: boolean superAdmin: type: boolean defaultRoleForNewUsers: type: boolean autoprovisioned: type: boolean externalId: type: string stepPermissionSets: type: array items: $ref: '#/components/schemas/StepPermissionSet' uniqueItems: true moduleEntitlements: type: array items: $ref: '#/components/schemas/ModuleEntitlement' uniqueItems: true userGroup: $ref: '#/components/schemas/UserGroup' users: type: array items: description: Circular reference to User userCount: type: integer format: int32 moduleCount: type: integer format: int32 required: - active - autoprovisioned - created - defaultRoleForNewUsers - externalId - id - locked - moduleEntitlements - name - stepPermissionSets - superAdmin - updated - userCount - userGroup - users DefaultTableReport: type: object properties: title: type: string workflowId: type: string workflowPriority: type: integer format: int32 required: - title - workflowId - workflowPriority CurrentCommonValue: allOf: - description: Circular reference to CurrentValue - $ref: '#/components/schemas/CurrentValueObject' required: - description - guidance BuildFilter: allOf: - $ref: '#/components/schemas/ReportFilter' required: - active - created - filterType - id - updated Section: type: object discriminator: propertyName: sectionType oneOf: - $ref: '#/components/schemas/FormSection' - description: >- And other types: Dashboard, DashboardSection, FieldLink, FormSection, FormSection, FormSection, GraphReport, HtmlSection, VisualReport, WorkflowLink, AnalysisReport, EmbeddedReport, EvidenceSection, DataWarehouseLink, ScopingSection 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' subSections: type: array items: 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' parent: $ref: '#/components/schemas/SectionObject' 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 parent: $ref: '#/components/schemas/SectionObject' 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 - parent - parentId - priority - step - stepId - subSections - updated StepPermissionSet: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string locked: type: boolean defaultStepPermissionSetForNewUsers: type: boolean permissions: type: array items: $ref: '#/components/schemas/StepPermission' users: type: array items: description: Circular reference to User application: description: Circular reference to Application applicationId: type: string userIds: type: array items: type: string required: - active - application - applicationId - created - defaultStepPermissionSetForNewUsers - id - locked - name - permissions - updated - userIds - users ModuleEntitlement: type: object properties: role: description: Circular reference to Role module: $ref: '#/components/schemas/Module' operationType: type: string enum: - READ - EDIT neo4jId: type: string created: type: string format: date-time updated: type: string format: date-time end: $ref: '#/components/schemas/Module' type: type: string enum: - STEP_PERMISSION - APPLICATION - MODULE endId: type: string startId: type: string required: - created - end - updated FormSection: allOf: - description: Circular reference to Section - type: object properties: subSections: type: array items: {} numberOfColumns: type: integer format: int32 readOnly: type: boolean required: - active - collapsed - color - colspan - conditionsAndParentsValid - conditionsEnabled - conditionsUseAndOperator - conditionsValid - created - defaultState - guidance - icon - id - name - numberOfColumns - parent - parentId - priority - readOnly - step - stepId - updated SectionObject: type: object discriminator: propertyName: sectionType oneOf: - $ref: '#/components/schemas/FormSection' - description: >- And other types: Dashboard, DashboardSection, FieldLink, FormSection, FormSection, FormSection, GraphReport, HtmlSection, VisualReport, WorkflowLink, AnalysisReport, EmbeddedReport, EvidenceSection, DataWarehouseLink, ScopingSection 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' parent: {} 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 - parent - parentId - priority - step - stepId - updated StepPermission: type: object properties: neo4jId: type: string created: type: string format: date-time updated: type: string format: date-time end: $ref: '#/components/schemas/Step' operationType: type: string enum: - READ - EDIT permissionSetId: type: string step: $ref: '#/components/schemas/Step' permissionSet: description: Circular reference to StepPermission writeOnly: true type: type: string deprecated: true enum: - STEP_PERMISSION - APPLICATION - MODULE endId: type: string startId: type: string required: - created - end - operationType - permissionSetId - updated Module: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time value: type: string enum: - A_ASSIGN - A_BULK_UPDATE_FIELDS - A_BULK_LINK_RECORDS - A_IMPORT - A_ALL_FIELDS - A_BUILD - A_API_ACCESS - A_MCP_ACCESS - A_DELETE_RECORDS - A_DUPLICATE_RECORDS - C_CONTROL_FRAMEWORKS - C_EVIDENCE_AUTOMATIONS - C_EVIDENCE_SOURCES - C_GAP_ANALYSIS - A_QUANTIFY - R_RECORDS - R_STATUS - R_PRODUCTIVITY - R_TABLE_REPORTS - R_DASHBOARDS - R_SPARK_AI_REPORTING_ASSISTANT - ADMIN_ALL onlyUse: type: boolean tab: type: string name: type: string required: - active - created - id - name - onlyUse - tab - updated - value 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.