Docusign Maestro API — WorkflowInstanceManagement

naftiko: 1.0.0-alpha2
info:
  label: Docusign Maestro API — WorkflowInstanceManagement
  description: 'Docusign Maestro API — WorkflowInstanceManagement. 4 operations. Lead operation: Docusign Cancels a running
    workflow instance.. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - WorkflowInstanceManagement
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: maestro-workflowinstancemanagement
    baseUri: https://apps.docusign.com/api/maestro
    description: Docusign Maestro API — WorkflowInstanceManagement business capability. Self-contained, no shared references.
    resources:
    - name: v1-accounts-accountId-management-instances-instanceId-cancel
      path: /v1/accounts/{accountId}/management/instances/{instanceId}/cancel
      operations:
      - name: cancelworkflowinstance
        method: POST
        description: Docusign Cancels a running workflow instance.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The account ID.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The instance ID of the workflow to cancel.
          required: true
    - name: v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-confi
      path: /v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/config_instances
      operations:
      - name: getconfiginstances
        method: GET
        description: Docusign Gets a list of configuration instances for a workflow definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The account ID.
          required: true
        - name: workflowDefinitionId
          in: path
          type: string
          description: Workflow definition ID.
          required: true
    - name: v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-insta
      path: /v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/instances
      operations:
      - name: getworkflowinstances
        method: GET
        description: Docusign Get a list of instances of a deployed workflow definition.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The account ID.
          required: true
        - name: workflowDefinitionId
          in: path
          type: string
          description: The ID of the workflow definition to delete.
          required: true
    - name: v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-insta
      path: /v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/instances/{instanceId}
      operations:
      - name: getworkflowinstance
        method: GET
        description: Docusign Gets the details for a specific instance for a deployed workflow definition.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The account ID.
          required: true
        - name: workflowDefinitionId
          in: path
          type: string
          description: Workflow definition ID.
          required: true
        - name: instanceId
          in: path
          type: string
          description: Workflow instance ID. <!-- dacid -->
          required: true
    authentication:
      type: bearer
      token: '{{env.DOCUSIGN_API_KEY}}'
  exposes:
  - type: rest
    namespace: maestro-workflowinstancemanagement-rest
    port: 8080
    description: REST adapter for Docusign Maestro API — WorkflowInstanceManagement. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/accounts/{accountid}/management/instances/{instanceid}/cancel
      name: v1-accounts-accountid-management-instances-instanceid-cancel
      description: REST surface for v1-accounts-accountId-management-instances-instanceId-cancel.
      operations:
      - method: POST
        name: cancelworkflowinstance
        description: Docusign Cancels a running workflow instance.
        call: maestro-workflowinstancemanagement.cancelworkflowinstance
        with:
          accountId: rest.accountId
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/accounts/{accountid}/management/workflow-definitions/{workflowdefinitionid}/config-instances
      name: v1-accounts-accountid-management-workflow-definitions-workflowdefinitionid-confi
      description: REST surface for v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-confi.
      operations:
      - method: GET
        name: getconfiginstances
        description: Docusign Gets a list of configuration instances for a workflow definition
        call: maestro-workflowinstancemanagement.getconfiginstances
        with:
          accountId: rest.accountId
          workflowDefinitionId: rest.workflowDefinitionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/accounts/{accountid}/management/workflow-definitions/{workflowdefinitionid}/instances
      name: v1-accounts-accountid-management-workflow-definitions-workflowdefinitionid-insta
      description: REST surface for v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-insta.
      operations:
      - method: GET
        name: getworkflowinstances
        description: Docusign Get a list of instances of a deployed workflow definition.
        call: maestro-workflowinstancemanagement.getworkflowinstances
        with:
          accountId: rest.accountId
          workflowDefinitionId: rest.workflowDefinitionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/accounts/{accountid}/management/workflow-definitions/{workflowdefinitionid}/instances/{instanceid}
      name: v1-accounts-accountid-management-workflow-definitions-workflowdefinitionid-insta
      description: REST surface for v1-accounts-accountId-management-workflow_definitions-workflowDefinitionId-insta.
      operations:
      - method: GET
        name: getworkflowinstance
        description: Docusign Gets the details for a specific instance for a deployed workflow definition.
        call: maestro-workflowinstancemanagement.getworkflowinstance
        with:
          accountId: rest.accountId
          workflowDefinitionId: rest.workflowDefinitionId
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: maestro-workflowinstancemanagement-mcp
    port: 9090
    transport: http
    description: MCP adapter for Docusign Maestro API — WorkflowInstanceManagement. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: docusign-cancels-running-workflow-instance
      description: Docusign Cancels a running workflow instance.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: maestro-workflowinstancemanagement.cancelworkflowinstance
      with:
        accountId: tools.accountId
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-list-configuration-instances
      description: Docusign Gets a list of configuration instances for a workflow definition
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: maestro-workflowinstancemanagement.getconfiginstances
      with:
        accountId: tools.accountId
        workflowDefinitionId: tools.workflowDefinitionId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-get-list-instances-deployed
      description: Docusign Get a list of instances of a deployed workflow definition.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: maestro-workflowinstancemanagement.getworkflowinstances
      with:
        accountId: tools.accountId
        workflowDefinitionId: tools.workflowDefinitionId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-details-specific-instance
      description: Docusign Gets the details for a specific instance for a deployed workflow definition.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: maestro-workflowinstancemanagement.getworkflowinstance
      with:
        accountId: tools.accountId
        workflowDefinitionId: tools.workflowDefinitionId
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.