LogicGate Workflow Map API

openapi: 3.2.0
info:
  title: Risk Cloud Workflow Map API
  description: 'Welcome to the Risk Cloud API v2! This is a collection of new API-first and RESTful API endpoints to streamline the creation of custom integrations with the Risk Cloud.


    For the API documentation of our legacy API v1 endpoints, reference Risk Cloud API v1.'
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.7.0
servers:
- url: https://{env}.logicgate.com
  description: The LogicGate API application.
  variables:
    env:
      default: qa
security:
- API Token: []
- basic: []
tags:
- name: Workflow Map
  description: A Workflow Map represents a relationship between two Workflows
paths:
  /api/v2/workflow-maps:
    get:
      tags:
      - Workflow Map
      summary: Retrieve workflow maps
      description: '**Permissions:** Build Access


        Retrieve a page of all workflow maps that the current user has Build Access to a parent application to.'
      operationId: readAllWorkflowMaps
      parameters:
      - name: workflow-id
        in: query
        description: The unique ID of a workflow where, if provided, the response will only contain workflow maps from the identified workflow
        required: false
        schema:
          type: string
        example: a1b2c3d4
      - name: page
        in: query
        description: The zero-indexed page number (must not be less than 0, defaults to 0)
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
        example: 0
      - name: size
        in: query
        description: The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20)
        required: false
        schema:
          type: integer
          format: int32
          minimum: 1
        example: 20
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageModelOutWorkflowMapApiOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
    post:
      tags:
      - Workflow Map
      summary: Create a workflow map
      description: '**Permissions:** Build Access to parent applications


        Create a workflow map from a JSON request body.'
      operationId: createWorkflowMap
      parameters:
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowMapApiCreateIn'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowMapApiOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
  /api/v2/workflow-maps/{id}:
    get:
      tags:
      - Workflow Map
      summary: Retrieve a workflow map
      description: '**Permissions:** Build Access to a parent application


        Retrieve a workflow map specified by the ID in the URL path.'
      operationId: readWorkflowMap
      parameters:
      - name: id
        in: path
        description: The unique ID of the workflow map
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowMapApiOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
    delete:
      tags:
      - Workflow Map
      summary: Delete a workflow map
      description: '**Permissions:** Build Access to a parent application


        Delete a workflow map specified by the ID in the URL path.'
      operationId: deleteWorkflowMap
      parameters:
      - name: id
        in: path
        description: The unique ID of the workflow map
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
    patch:
      tags:
      - Workflow Map
      summary: Update a workflow map
      description: '**Permissions:** Build Access to a parent application


        Update a workflow map specified by the ID in the URL path from a JSON request body. Only present properties with non-empty values are updated.'
      operationId: updateWorkflowMap
      parameters:
      - name: id
        in: path
        description: The unique ID of the workflow map
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'A bearer authorization header containing a Risk Cloud API access token in the format `Authorization: Bearer {TOKEN}`.


          To obtain a Risk Cloud API access token, refer to [Obtain an API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) in the [LogicGate Help Center](https://help.logicgate.com/hc/en-us).'
        required: true
        schema:
          type: string
        example: Bearer {TOKEN}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowMapApiUpdateIn'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowMapApiOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppBadRequestResponse'
      x-beta: 'true'
components:
  schemas:
    AppBadRequestResponse:
      type: object
      properties:
        property:
          type: string
        value:
          type: string
        message:
          type: string
    WorkflowMapApiCreateIn:
      type: object
      description: Workflow Map (Create)
      properties:
        from:
          type: string
          description: The unique ID of the source workflow of the workflow map relationship
          example: a1b2c3d4
          minLength: 1
        to:
          type: string
          description: The unique ID of the destination workflow of the workflow map relationship
          example: a1b2c3d4
          minLength: 1
        relationship:
          type: string
          description: The type of the relationship between workflows
          enum:
          - OneToOne
          - OneToMany
          - ManyToOne
          - ManyToMany
          example: ONE_TO_MANY
      required:
      - from
      - relationship
      - to
      title: Workflow Map (Create)
    WorkflowMapApiOut:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of this Risk Cloud resource
          example: a1b2c3d4
        from:
          type: string
          description: The unique ID of the source workflow of the workflow map relationship
          example: a1b2c3d4
        to:
          type: string
          description: The unique ID of the destination workflow of the workflow map relationship
          example: a1b2c3d4
        relationship:
          type: string
          description: The type of the relationship between workflows
          enum:
          - OneToOne
          - OneToMany
          - ManyToOne
          - ManyToMany
          example: ONE_TO_MANY
        object:
          type: string
          description: Identifies the type of object this data represents
          example: workflow-map
      title: Workflow Map (Response)
    WorkflowMapApiUpdateIn:
      type: object
      description: Workflow (Update)
      properties:
        relationship:
          type: string
          description: The type of the relationship between workflows
          enum:
          - OneToOne
          - OneToMany
          - ManyToOne
          - ManyToMany
          example: ONE_TO_MANY
      required:
      - relationship
      title: Workflow Map (Update)
    PageModelOutWorkflowMapApiOut:
      type: object
      properties:
        content:
          type: array
          description: A array of returned items
          items:
            $ref: '#/components/schemas/WorkflowMapApiOut'
        links:
          $ref: '#/components/schemas/PageLinksOut'
          description: A collection of page URL links for navigation and iteration
        page:
          $ref: '#/components/schemas/PageInfoOut'
          description: A collection page metadata
      title: Page (Response)
    PageInfoOut:
      type: object
      properties:
        size:
          type: integer
          format: int64
          description: The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20)
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of items available
          example: 50
        totalPages:
          type: integer
          format: int64
          description: The total number of pages available based on the size
          example: 3
        number:
          type: integer
          format: int64
          description: The zero-indexed page number (must not be less than 0, defaults to 0)
          example: 0
      title: Page Info
    PageLinksOut:
      type: object
      properties:
        first:
          type: string
          description: A URL path to the first page of requested data
          example: /api/v2/resource?page=0&size=20
        prev:
          type: string
          description: A URL path to the next page of requested data or `null` if currently on first page
          example: /api/v2/resource?page=2&size=20
        self:
          type: string
          description: A URL path to the current page of requested data
          example: /api/v2/resource?page=3&size=20
        next:
          type: string
          description: A URL link to the next page of requested data or `null` if currently on last page
          example: /api/v2/resource?page=4&size=20
        last:
          type: string
          description: A URL link to the last page of requested data
          example: /api/v2/resource?page=6&size=20
      title: Page Links
  securitySchemes:
    API_Token:
      type: http
      name: Authorization
      in: header
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      name: Authorization
      in: header
      scheme: basic
      bearerFormat: basic
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/