class

RightDocuments::WorkflowsApi

Inherits Reference < Object

Constructors

new(api_client : RightDocuments::ApiClient = ApiClient.default)
Source

Instance methods

api_client
Source
api_client=(api_client : ApiClient)
Source
api_v1_matters_matter_id_workflows_get(matter_id : String)

List a matter's workflows and the playbooks that fit it The workflow runs, and the chooser: each startable playbook (latest version, placeholders left out) with its fit on the matter (fits, unknown, running, does_not_fit) and the reasons. The fit is advice. @param matter_id [String] Matter UUID or number (e.g. 0004-001) @return [ApiV1MattersMatterIdWorkflowsGet200Response]

Source
api_v1_matters_matter_id_workflows_get_with_http_info(matter_id : String)

List a matter's workflows and the playbooks that fit it The workflow runs, and the chooser: each startable playbook (latest version, placeholders left out) with its fit on the matter (fits, unknown, running, does_not_fit) and the reasons. The fit is advice. @param matter_id [String] Matter UUID or number (e.g. 0004-001) @return [Array<(ApiV1MattersMatterIdWorkflowsGet200Response, Integer, Hash)>] ApiV1MattersMatterIdWorkflowsGet200Response data, response status code and response headers

Source
api_v1_matters_matter_id_workflows_post(matter_id : String, api_v1_matters_matter_id_workflows_post_request : ApiV1MattersMatterIdWorkflowsPostRequest | Nil)

Start a workflow on a matter Starts a playbook version on the matter, as the web confirm page does. The fit is advice: a playbook that does not fit can still be started. Refused (422, with the fit and its reasons) for a placeholder, a closed matter, a playbook that belongs to a court case when the matter has none (or several and none is given), and a playbook already running on the matter (and court case). @param matter_id [String] Matter UUID or number (e.g. 0004-001) @return [ApiV1MattersMatterIdWorkflowsPost201Response]

Source
api_v1_matters_matter_id_workflows_post_with_http_info(matter_id : String, api_v1_matters_matter_id_workflows_post_request : ApiV1MattersMatterIdWorkflowsPostRequest | Nil)

Start a workflow on a matter Starts a playbook version on the matter, as the web confirm page does. The fit is advice: a playbook that does not fit can still be started. Refused (422, with the fit and its reasons) for a placeholder, a closed matter, a playbook that belongs to a court case when the matter has none (or several and none is given), and a playbook already running on the matter (and court case). @param matter_id [String] Matter UUID or number (e.g. 0004-001) @return [Array<(ApiV1MattersMatterIdWorkflowsPost201Response, Integer, Hash)>] ApiV1MattersMatterIdWorkflowsPost201Response data, response status code and response headers

Source
api_v1_playbooks_get

List the litigation playbooks Repository data, the same for every organization: the latest version of each playbook and every version. @return [ApiV1PlaybooksGet200Response]

Source
api_v1_playbooks_get_with_http_info

List the litigation playbooks Repository data, the same for every organization: the latest version of each playbook and every version. @return [Array<(ApiV1PlaybooksGet200Response, Integer, Hash)>] ApiV1PlaybooksGet200Response data, response status code and response headers

Source