> ## 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 a job with a given jobId



## OpenAPI

````yaml PATCH /api/v2/jobs/{jobId}
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/v2/jobs/{jobId}:
    patch:
      tags:
        - Job
      summary: Update a job with a given jobId.
      operationId: update_1
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobIn_ExtendedJobSummary'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job_ExtendedJobSummary'
components:
  schemas:
    JobIn_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          minLength: 1
        description:
          type: string
          maxLength: 2000
          minLength: 0
        enabled:
          type: boolean
        jobType:
          type: string
          enum:
            - EVENT
            - SCHEDULE
            - END_USER
            - ADMIN
            - EVIDENCE
        trigger:
          $ref: '#/components/schemas/TriggerIn_ExtendedJobSummary'
        operationConditionGroups:
          type: array
          items:
            $ref: '#/components/schemas/OperationConditionGroupIn_ExtendedJobSummary'
          minItems: 1
        incomplete:
          type: boolean
      required:
        - description
        - enabled
        - id
        - incomplete
        - jobType
        - name
        - operationConditionGroups
        - trigger
    Job_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        trigger:
          $ref: '#/components/schemas/Trigger_ExtendedJobSummary'
        jobExecutions:
          type: string
          description: Please use the JobExecutionController for job history.
        jobHistory:
          type: string
          description: Please use the JobExecutionController for job history.
        recentExecution:
          type: string
          description: recentExecution
        jobType:
          type: string
        operationConditionGroups:
          type: array
          items:
            $ref: '#/components/schemas/OperationConditionGroup_ExtendedJobSummary'
        creator:
          type: string
          description: creator
      required:
        - creator
        - description
        - enabled
        - id
        - jobExecutions
        - jobHistory
        - jobType
        - name
        - operationConditionGroups
        - recentExecution
        - trigger
    TriggerIn_ExtendedJobSummary:
      type: object
      discriminator:
        propertyName: triggerType
      oneOf:
        - description: Circular reference to AssignedTriggerIn_ExtendedJobSummary
        - description: >-
            And other types: CreatedTriggerIn_ExtendedJobSummary,
            MovedTriggerIn_ExtendedJobSummary, DateTriggerIn_ExtendedJobSummary,
            DueDateTriggerIn_ExtendedJobSummary,
            FixedTriggerIn_ExtendedJobSummary,
            FieldUpdatedTriggerIn_ExtendedJobSummary,
            EndpointTriggerIn_ExtendedJobSummary,
            AssignedTriggerIn_ExtendedJobSummary,
            CreatedTriggerIn_ExtendedJobSummary,
            MovedTriggerIn_ExtendedJobSummary,
            DueDateTriggerIn_ExtendedJobSummary,
            DateTriggerIn_ExtendedJobSummary, FixedTriggerIn_ExtendedJobSummary,
            FieldUpdatedTriggerIn_ExtendedJobSummary,
            EndpointTriggerIn_ExtendedJobSummary
      properties:
        id:
          type: string
        workflowId:
          type: string
        sourceId:
          type: string
        triggerType:
          type: string
          enum:
            - Moved
            - Created
            - Assigned
            - DateTrigger
            - DueDate
            - Fixed
            - Endpoint
            - FieldUpdated
      required:
        - id
        - sourceId
        - triggerType
        - workflowId
    OperationConditionGroupIn_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        priority:
          type: integer
          format: int32
        conditionsEnabled:
          type: boolean
        conditionsUseAndOperator:
          type: boolean
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/TriggerConditionIn_ExtendedJobSummary'
        operations:
          type: array
          items:
            $ref: '#/components/schemas/OperationIn_ExtendedJobSummary'
          minItems: 1
      required:
        - conditions
        - conditionsEnabled
        - conditionsUseAndOperator
        - id
        - operations
        - priority
    Trigger_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        workflowId:
          type: string
        workflow:
          $ref: '#/components/schemas/WorkflowSummaryOut_ExtendedJobSummary'
        sourceId:
          type: string
        source:
          $ref: '#/components/schemas/StepOut_ExtendedJobSummary'
        invalidatedByStepDeletion:
          type: boolean
        triggerType:
          type: string
      required:
        - active
        - created
        - id
        - invalidatedByStepDeletion
        - source
        - sourceId
        - updated
        - workflow
        - workflowId
    OperationConditionGroup_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        priority:
          type: integer
          format: int32
        conditionsEnabled:
          type: boolean
        conditionsUseAndOperator:
          type: boolean
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/TriggerConditionOut_ExtendedJobSummary'
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Operation_ExtendedJobSummary'
      required:
        - active
        - conditions
        - conditionsEnabled
        - conditionsUseAndOperator
        - created
        - id
        - operations
        - priority
        - updated
    TriggerConditionIn_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        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
        fieldId:
          type: string
          minLength: 1
        currentValue:
          type: string
          description: currentValue
      required:
        - currentValue
        - fieldId
        - id
        - operator
        - priority
    OperationIn_ExtendedJobSummary:
      type: object
      discriminator:
        propertyName: operationType
      oneOf:
        - $ref: '#/components/schemas/FieldUpdateOperationIn_ExtendedJobSummary'
        - description: >-
            And other types: DateFieldUpdateOperationIn_ExtendedJobSummary,
            NumberFieldUpdateOperationIn_ExtendedJobSummary,
            GroupsAndUsersUpdateOperationIn_ExtendedJobSummary,
            WebhookOperationIn_ExtendedJobSummary,
            MapExistingToTriggerIn_ExtendedJobSummary,
            MoveRecordIn_ExtendedJobSummary,
            CreateNewAndMapToTriggerIn_ExtendedJobSummary,
            CreateNewAndMapToExistingIn_ExtendedJobSummary,
            CollectEvidenceOperationIn_ExtendedJobSummary,
            CustomCollectEvidenceOperationIn_ExtendedJobSummary,
            MergeCollectEvidenceOperationIn_ExtendedJobSummary,
            EmailMessageOperationIn_ExtendedJobSummary,
            InAppMessageOperationIn_ExtendedJobSummary,
            SlackMessageOperationIn_ExtendedJobSummary,
            WorkEmailSummaryOperationIn_ExtendedJobSummary,
            GenerateDocumentOperationIn_ExtendedJobSummary,
            FailedJobSummaryOperationIn_ExtendedJobSummary,
            AecFailedJobSummaryOperationIn_ExtendedJobSummary,
            TeamsMessageOperationIn_ExtendedJobSummary,
            WorkatoCollectEvidenceOperationIn_ExtendedJobSummary,
            EvidenceTestingOperationIn_ExtendedJobSummary,
            AgentOperationIn_ExtendedJobSummary,
            FieldUpdateOperationIn_ExtendedJobSummary,
            DateFieldUpdateOperationIn_ExtendedJobSummary,
            NumberFieldUpdateOperationIn_ExtendedJobSummary,
            GroupsAndUsersUpdateOperationIn_ExtendedJobSummary,
            WebhookOperationIn_ExtendedJobSummary,
            MapExistingToTriggerIn_ExtendedJobSummary,
            MoveRecordIn_ExtendedJobSummary,
            CreateNewAndMapToTriggerIn_ExtendedJobSummary,
            CreateNewAndMapToExistingIn_ExtendedJobSummary,
            CollectEvidenceOperationIn_ExtendedJobSummary,
            CustomCollectEvidenceOperationIn_ExtendedJobSummary,
            MergeCollectEvidenceOperationIn_ExtendedJobSummary,
            RiskCloudCollectEvidenceOperationIn_ExtendedJobSummary,
            WorkatoCollectEvidenceOperationIn_ExtendedJobSummary,
            EmailMessageOperationIn_ExtendedJobSummary,
            InAppMessageOperationIn_ExtendedJobSummary,
            SlackMessageOperationIn_ExtendedJobSummary,
            WorkEmailSummaryOperationIn_ExtendedJobSummary,
            GenerateDocumentOperationIn_ExtendedJobSummary,
            FailedJobSummaryOperationIn_ExtendedJobSummary,
            AecFailedJobSummaryOperationIn_ExtendedJobSummary,
            TeamsMessageOperationIn_ExtendedJobSummary,
            EvidenceTestingOperationIn_ExtendedJobSummary,
            AgentOperationIn_ExtendedJobSummary
      properties:
        id:
          type: string
        priority:
          type: integer
          format: int32
        enabled:
          type: boolean
        type:
          type: string
          enum:
            - AEC_FAILED_JOB_SUMMARY
            - AGENT
            - CONTROLS_TESTING
            - CREATE_MAP_EXISTING
            - CREATE_MAP_NONE
            - CREATE_MAP_TRIGGER
            - COLLECT_EVIDENCE
            - CUSTOM_COLLECT_EVIDENCE
            - DATE_FIELD_UPDATE
            - DUE_DATE_FIELD_UPDATE
            - EMAIL_MESSAGE
            - EXISTING_MAP_TRIGGER
            - FAILED_JOB_SUMMARY
            - FIELD_UPDATE
            - GENERATE_DOCUMENT
            - GROUPS_AND_USERS_UPDATE
            - IN_APP_MESSAGE
            - MERGE_COLLECT_EVIDENCE
            - MOVE_RECORD
            - NUMBER_FIELD_UPDATE
            - RISK_CLOUD_COLLECT_EVIDENCE
            - SERVICE
            - SLACK_MESSAGE
            - TEAMS_MESSAGE
            - WEBHOOK
            - WORK_EMAIL_SUMMARY
            - WORKATO_COLLECT_EVIDENCE
        operationType:
          type: string
      required:
        - enabled
        - id
        - priority
        - type
    WorkflowSummaryOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
          description: ID of the workflow.
        active:
          type: boolean
          description: True if the workflow is active.
        created:
          type: string
          format: date-time
          description: Created Date of the workflow.
        updated:
          type: string
          format: date-time
          description: Last Updated Date of the workflow.
        name:
          type: string
          description: Name of the workflow.
        recordPrefix:
          type: string
          description: Prefix 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
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_ExtendedJobSummary'
          description: Object containing all SLA information.
        allowAec:
          type: boolean
          description: Enabled automated evidence collection.
        applicationId:
          type: string
          description: The parent application ID of this workflow.
        workflowType:
          type: string
          description: The type of this workflow (LG or Jira).
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        application:
          $ref: '#/components/schemas/ApplicationSummaryOut_ExtendedJobSummary'
          description: The parent application of this workflow.
      required:
        - active
        - allowAec
        - allowGroups
        - application
        - applicationId
        - created
        - id
        - name
        - recordPrefix
        - requireGroups
        - sla
        - updated
        - workflowType
        - xpos
        - ypos
    StepOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Step name.
        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
          writeOnly: true
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_ExtendedJobSummary'
          description: Object containing all SLA information.
        workflowId:
          type: string
          writeOnly: true
        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
        autofillEnabled:
          type: boolean
          description: Whether or not to enable autofill on the step.
        stepType:
          type: string
          description: >-
            Step type determines whether a step is an ORIGIN, END, or CHAIN
            step.
          enum:
            - ORIGIN
            - CHAIN
            - END
        workflow:
          $ref: '#/components/schemas/WorkflowSummaryOut_ExtendedJobSummary'
          description: Parent workflow of this step.
        public:
          type: boolean
      required:
        - active
        - assignableUserType
        - autofillEnabled
        - created
        - id
        - isPublic
        - name
        - priority
        - sla
        - stepType
        - updated
        - userGroupOperationType
        - workflow
        - workflowId
        - xpos
        - ypos
    TriggerConditionOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        conditionType:
          type: string
        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/FieldBasicsOut_ExtendedJobSummary'
        currentValue:
          type: string
          description: currentValue
      required:
        - active
        - conditionType
        - created
        - currentValue
        - field
        - id
        - operator
        - priority
        - updated
    Operation_ExtendedJobSummary:
      type: object
      discriminator:
        propertyName: operationType
      oneOf:
        - $ref: '#/components/schemas/FieldUpdateOperationOut_ExtendedJobSummary'
        - description: >-
            And other types: WebhookOperationOut_ExtendedJobSummary,
            MapExistingToTriggerOut_ExtendedJobSummary,
            MoveRecordOut_ExtendedJobSummary,
            CreateNewAndMapToTriggerOut_ExtendedJobSummary,
            CreateNewAndMapToExistingOut_ExtendedJobSummary,
            EmailMessageOperationOut_ExtendedJobSummary,
            InAppMessageOperationOut_ExtendedJobSummary,
            SlackMessageOperationOut_ExtendedJobSummary,
            WorkEmailSummaryOperationOut_ExtendedJobSummary,
            GenerateDocumentOperationOut_ExtendedJobSummary,
            DateFieldUpdateOperationOut_ExtendedJobSummary,
            NumberFieldUpdateOperationOut_ExtendedJobSummary,
            FailedJobSummaryOperationOut_ExtendedJobSummary,
            AecFailedJobSummaryOperationOut_ExtendedJobSummary,
            CollectEvidenceOperationOut_ExtendedJobSummary,
            CustomCollectEvidenceOperationOut_ExtendedJobSummary,
            TeamsMessageOperationOut_ExtendedJobSummary,
            MergeCollectEvidenceOperationOut_ExtendedJobSummary,
            RiskCloudCollectEvidenceOperationOut_ExtendedJobSummary,
            WorkatoCollectEvidenceOperationOut_ExtendedJobSummary,
            EvidenceTestingOperationOut_ExtendedJobSummary,
            AgentOperationOut_ExtendedJobSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        type:
          type: string
          enum:
            - AEC_FAILED_JOB_SUMMARY
            - AGENT
            - CONTROLS_TESTING
            - CREATE_MAP_EXISTING
            - CREATE_MAP_NONE
            - CREATE_MAP_TRIGGER
            - COLLECT_EVIDENCE
            - CUSTOM_COLLECT_EVIDENCE
            - DATE_FIELD_UPDATE
            - DUE_DATE_FIELD_UPDATE
            - EMAIL_MESSAGE
            - EXISTING_MAP_TRIGGER
            - FAILED_JOB_SUMMARY
            - FIELD_UPDATE
            - GENERATE_DOCUMENT
            - GROUPS_AND_USERS_UPDATE
            - IN_APP_MESSAGE
            - MERGE_COLLECT_EVIDENCE
            - MOVE_RECORD
            - NUMBER_FIELD_UPDATE
            - RISK_CLOUD_COLLECT_EVIDENCE
            - SERVICE
            - SLACK_MESSAGE
            - TEAMS_MESSAGE
            - WEBHOOK
            - WORK_EMAIL_SUMMARY
            - WORKATO_COLLECT_EVIDENCE
        priority:
          type: integer
          format: int32
        enabled:
          type: boolean
        operationType:
          type: string
      required:
        - active
        - created
        - enabled
        - id
        - operationType
        - priority
        - type
        - updated
    FieldUpdateOperationIn_ExtendedJobSummary:
      allOf:
        - description: Circular reference to OperationIn_ExtendedJobSummary
        - type: object
          properties:
            crossflow:
              $ref: '#/components/schemas/CrossflowIn_ExtendedJobSummary'
            values:
              type: array
              items:
                type: string
            clearField:
              type: boolean
      discriminator:
        propertyName: operationType
      required:
        - clearField
        - crossflow
        - values
    ServiceLevelAgreement_ExtendedJobSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    ApplicationSummaryOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
        type:
          type: string
        color:
          type: string
        icon:
          type: string
        live:
          type: boolean
        permissionsEnabled:
          type: boolean
      required:
        - active
        - color
        - created
        - icon
        - id
        - live
        - name
        - permissionsEnabled
        - type
        - updated
    FieldBasicsOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        label:
          type: string
        fieldType:
          type: string
        required:
          type: boolean
        readOnly:
          type: boolean
        currentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValueBasicsOut_ExtendedJobSummary'
        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
      required:
        - currentValues
        - fieldType
        - id
        - label
        - name
        - operators
        - readOnly
        - required
    FieldUpdateOperationOut_ExtendedJobSummary:
      allOf:
        - description: Circular reference to Operation_ExtendedJobSummary
        - type: object
          properties:
            crossflow:
              $ref: '#/components/schemas/CrossflowSummaryOut_ExtendedJobSummary'
            field:
              $ref: '#/components/schemas/FieldBasicsOut_ExtendedJobSummary'
            fieldWorkflowId:
              type: string
            values:
              type: array
              items:
                type: string
            clearField:
              type: boolean
      required:
        - active
        - clearField
        - created
        - crossflow
        - enabled
        - field
        - fieldWorkflowId
        - id
        - priority
        - type
        - updated
        - values
    CrossflowIn_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of this Risk Cloud resource
        crossflowReducer:
          type: string
          description: >-
            Indicates the determination of a field in a scenario where a linked
            workflow is connected via a X_TO_MANY relationship.
          enum:
            - NEWEST
            - OLDEST
            - MOST_RECENTLY_LINKED
            - LEAST_RECENTLY_LINKED
            - SUM
            - AVERAGE
            - HIGHEST
            - LOWEST
        calcSpecificToStep:
          type: boolean
          description: Determines if calc field operation is specific to step.
        calcStep:
          $ref: '#/components/schemas/Step_ExtendedJobSummary'
          description: Selected step for calc field operation.
        fieldWorkflowId:
          type: string
          description: The workflow ID that contains the message field.
        fieldWorkflow:
          type: string
          description: >-
            The workflow object that contains the message field.Deprecated.  Use
            'fieldWorkflowId' instead.
        priority:
          type: integer
          format: int32
          description: >-
            The order of the message fields in the message text.Every priority
            must be unique.  A priority cannot be duplicated in one message.
        systemField:
          type: string
          description: >-
            Populated if the message field is a system field.Either systemField
            or customFieldId can be populated.  Not both.
          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
        customFieldId:
          type: string
          description: >-
            The ID of the custom message field.Either systemField or
            customFieldId can be populated.  Not both.
        customField:
          type: string
          description: >-
            The object of the custom message field.Deprecated.  Use
            'customFieldId' instead.
      required:
        - calcSpecificToStep
        - calcStep
        - crossflowReducer
        - customField
        - customFieldId
        - fieldWorkflow
        - fieldWorkflowId
        - id
        - priority
        - systemField
    CurrentValueBasicsOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        archived:
          type: boolean
        created:
          type: string
          format: date-time
        discriminator:
          type: string
        updated:
          type: string
          format: date-time
        textValue:
          type: string
        numericValue:
          type: number
          format: double
        temporalValue:
          type: string
          format: date-time
        valueType:
          type: string
      required:
        - active
        - archived
        - created
        - discriminator
        - id
        - numericValue
        - temporalValue
        - textValue
        - updated
        - valueType
    CrossflowSummaryOut_ExtendedJobSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of this Risk Cloud resource
        crossflowReducer:
          type: string
          enum:
            - NEWEST
            - OLDEST
            - MOST_RECENTLY_LINKED
            - LEAST_RECENTLY_LINKED
            - SUM
            - AVERAGE
            - HIGHEST
            - LOWEST
        calcSpecificToStep:
          type: boolean
        calcStep:
          $ref: '#/components/schemas/Step_ExtendedJobSummary'
        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
        fieldWorkflow:
          $ref: '#/components/schemas/WorkflowSummaryOut_ExtendedJobSummary'
        fieldWorkflowId:
          type: string
        customField:
          $ref: '#/components/schemas/FieldBasicsOut_ExtendedJobSummary'
        customFieldId:
          type: string
        priority:
          type: integer
          format: int32
      required:
        - calcSpecificToStep
        - calcStep
        - crossflowReducer
        - customField
        - customFieldId
        - fieldWorkflow
        - fieldWorkflowId
        - id
        - priority
        - systemField
    Step_ExtendedJobSummary:
      type: object
      description: An entity to store details about a specific step within a workflow
      discriminator:
        propertyName: stepType
      oneOf:
        - $ref: '#/components/schemas/Origin_ExtendedJobSummary'
        - description: >-
            And other types: Chain_ExtendedJobSummary, End_ExtendedJobSummary,
            Origin_ExtendedJobSummary, Chain_ExtendedJobSummary,
            End_ExtendedJobSummary
      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_ExtendedJobSummary'
          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_ExtendedJobSummary
          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
    Origin_ExtendedJobSummary:
      allOf:
        - description: Circular reference to Step_ExtendedJobSummary
  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.