> ## 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. # Update workflow primary field ## OpenAPI ````yaml PATCH /api/v1/workflows/{workflow}/primary-field 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/workflows/{workflow}/primary-field: patch: tags: - Workflow summary: >- Update an existing workflow to relate to the given primary field object and return the updated workflow. operationId: updateWorkflowPrimaryField parameters: - name: workflow in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PrimaryField_BasicWorkflowSummary' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Workflow_BasicWorkflowSummary' components: schemas: PrimaryField_BasicWorkflowSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time field: $ref: '#/components/schemas/Field_BasicWorkflowSummary' 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 Workflow_BasicWorkflowSummary: type: object description: >- An entity that contains information about a set of steps within a particular application. discriminator: propertyName: workflowType oneOf: - description: Circular reference to ControlWorkflow_BasicWorkflowSummary - description: 'And other types: JiraWorkflow_BasicWorkflowSummary' 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_BasicWorkflowSummary' description: Object containing all SLA information. allowAec: type: boolean description: Enables automated evidence collection. allowRcsa: type: boolean description: Allow Risk & Control Self-Assessments. primaryField: $ref: '#/components/schemas/PrimaryField_BasicWorkflowSummary' workflowType: type: string enum: - WORKFLOW - JIRA_WORKFLOW - CONTROL_WORKFLOW - ANALYSIS_WORKFLOW currentValueUserGroupMappings: type: array items: $ref: >- #/components/schemas/CurrentValueUserGroupMapping_BasicWorkflowSummary automatedAccessEnabled: type: boolean automatedAccessFields: type: array description: Fields that triggers automated access changes items: $ref: '#/components/schemas/Field_BasicWorkflowSummary' maxItems: 6 minItems: 0 automatedAccessFieldId: type: string summaryFields: type: array items: type: object properties: workflow: description: Circular reference to Workflow_BasicWorkflowSummary writeOnly: true field: $ref: '#/components/schemas/Field_BasicWorkflowSummary' priority: type: integer format: int32 neo4jId: type: string fieldId: type: string required: - priority maxItems: 5 minItems: 0 contains: description: Circular reference to Workflow_BasicWorkflowSummary writeOnly: true canSelect: description: Circular reference to Workflow_BasicWorkflowSummary writeOnly: true pluralizedRecordPrefix: type: string required: - active - allowAec - allowGroups - allowRcsa - automatedAccessEnabled - automatedAccessFieldId - automatedAccessFields - created - currentValueUserGroupMappings - description - id - name - primaryField - priority - recordPrefix - requireGroups - sla - summaryFields - updated - workflowType - xpos - ypos Field_BasicWorkflowSummary: 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_BasicWorkflowSummary' - description: >- And other types: ExternalUser_BasicWorkflowSummary, ExternalId_BasicWorkflowSummary, TextArea_BasicWorkflowSummary, DatePicker_BasicWorkflowSummary, Number_BasicWorkflowSummary, ESignature_BasicWorkflowSummary, Checkbox_BasicWorkflowSummary, MultiSelect_BasicWorkflowSummary, Radio_BasicWorkflowSummary, Select_BasicWorkflowSummary, Attachment_BasicWorkflowSummary, User_BasicWorkflowSummary, Evidence_BasicWorkflowSummary, Calculation_BasicWorkflowSummary, FixedDateCalculation_BasicWorkflowSummary, LinkedRecordsCount_BasicWorkflowSummary, DueDate_BasicWorkflowSummary, TransientFieldDaysUntilDue_BasicWorkflowSummary, AnnualLossExposure_BasicWorkflowSummary, AecInfo_BasicWorkflowSummary, Text_BasicWorkflowSummary, ExternalUser_BasicWorkflowSummary, ExternalId_BasicWorkflowSummary, TextArea_BasicWorkflowSummary, DatePicker_BasicWorkflowSummary, Number_BasicWorkflowSummary, ESignature_BasicWorkflowSummary, Checkbox_BasicWorkflowSummary, MultiSelect_BasicWorkflowSummary, Radio_BasicWorkflowSummary, Select_BasicWorkflowSummary, Attachment_BasicWorkflowSummary, User_BasicWorkflowSummary, Evidence_BasicWorkflowSummary, Calculation_BasicWorkflowSummary, TextConcatenation_BasicWorkflowSummary, FixedDateCalculation_BasicWorkflowSummary, LinkedRecordsCount_BasicWorkflowSummary, DueDate_BasicWorkflowSummary, TransientFieldDaysUntilDue_BasicWorkflowSummary, AnnualLossExposure_BasicWorkflowSummary, AecInfo_BasicWorkflowSummary 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. copyRecordAccessField: type: boolean currencyForNumberDisplayingFields: description: Circular reference to Field_BasicWorkflowSummary writeOnly: true requiresUniqueValue: type: boolean parameterizedCurrentValues: type: array items: $ref: '#/components/schemas/CurrentValueObject_BasicWorkflowSummary' writeOnly: true analysisOutputField: type: boolean currentValuesFromOtherField: description: Circular reference to Field_BasicWorkflowSummary writeOnly: true formatForNumberDisplayingFields: description: Circular reference to Field_BasicWorkflowSummary writeOnly: true crossWorkflowCalculation: type: boolean validTypeForCalculationInput: type: boolean required: - active - copyRecordAccessField - created - fieldType - id - name - updated ServiceLevelAgreement_BasicWorkflowSummary: type: object properties: enabled: type: boolean duration: type: integer format: int64 required: - duration - enabled CurrentValueUserGroupMapping_BasicWorkflowSummary: type: object properties: currentValue: $ref: '#/components/schemas/CurrentValue_BasicWorkflowSummary' userGroup: $ref: '#/components/schemas/UserGroup_BasicWorkflowSummary' required: - currentValue - userGroup Text_BasicWorkflowSummary: allOf: - description: Circular reference to Field_BasicWorkflowSummary required: - fieldType CurrentValueObject_BasicWorkflowSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_BasicWorkflowSummary' - description: >- And other types: CurrentDateValue_BasicWorkflowSummary, CurrentDateRangeValue_BasicWorkflowSummary, CurrentJobValue_BasicWorkflowSummary, CurrentCommonValue_BasicWorkflowSummary, CurrentDateValue_BasicWorkflowSummary, CurrentDateRangeValue_BasicWorkflowSummary, LabelValue_BasicWorkflowSummary, CleanAttachment_BasicWorkflowSummary, DirtyAttachment_BasicWorkflowSummary, PendingAttachment_BasicWorkflowSummary, CurrentGoogleAttachmentValue_BasicWorkflowSummary, CurrentSharepointAttachmentValue_BasicWorkflowSummary, Active_BasicWorkflowSummary, Automated_BasicWorkflowSummary, Disabled_BasicWorkflowSummary, External_BasicWorkflowSummary, Locked_BasicWorkflowSummary, Service_BasicWorkflowSummary, CurrentNumericRangeValue_BasicWorkflowSummary, CurrentJobValue_BasicWorkflowSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time discriminator: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - created - discriminator - id - updated CurrentValue_BasicWorkflowSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_BasicWorkflowSummary' - description: >- And other types: CurrentDateValue_BasicWorkflowSummary, CurrentDateRangeValue_BasicWorkflowSummary, CurrentJobValue_BasicWorkflowSummary, CurrentCommonValue_BasicWorkflowSummary, CurrentDateValue_BasicWorkflowSummary, CurrentDateRangeValue_BasicWorkflowSummary, LabelValue_BasicWorkflowSummary, CleanAttachment_BasicWorkflowSummary, DirtyAttachment_BasicWorkflowSummary, PendingAttachment_BasicWorkflowSummary, CurrentGoogleAttachmentValue_BasicWorkflowSummary, CurrentSharepointAttachmentValue_BasicWorkflowSummary, Active_BasicWorkflowSummary, Automated_BasicWorkflowSummary, Disabled_BasicWorkflowSummary, External_BasicWorkflowSummary, Locked_BasicWorkflowSummary, Service_BasicWorkflowSummary, CurrentNumericRangeValue_BasicWorkflowSummary, CurrentJobValue_BasicWorkflowSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time discriminator: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - created - discriminator - id - updated UserGroup_BasicWorkflowSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time title: type: string required: - active - created - id - title - updated CurrentCommonValue_BasicWorkflowSummary: allOf: - description: Circular reference to CurrentValueObject_BasicWorkflowSummary required: - description 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.