COconductorone
Task

Close

Changed on

Close a task, ending its workflow. Async — returns a ticketActionId on accept and queues the close; the task's state field is not updated synchronously. Poll task_service_get to observe the transition to TASK_STATE_CLOSED. When the task has an active provision step, close may no-op — finish or cancel the provision step first (mark_provision_complete / _errored / _cancelled) before closing.

post/api/v1/tasks/{task_id}/action/close

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/tasks/{task_id}/action/close
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

task_idstring required

The ID of the task to close.

Request body

commentstring

An optional comment attached to the close action.

Response

The TaskActionsServiceCloseResponse returns a task view with paths indicating the location of expanded items in the array.

taskActionIdstring

The ID of the task close action created by this request.

Changes

  • fe943bedf41bRevision changes
    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 918a4e749f56Revision changes
    • warning

      added the new OPERATION_ISSUE_CREDENTIAL enum value to the //////////// response property for the response status

    • warning

      added the new TYPE_CREDENTIAL_ISSUE enum value to the //////// response property for the response status

    • warning

      added the new TYPE_SPEND_REMEDY enum value to the //////// response property for the response status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////////// to the response with the status