Crate collaboflow_rs

A Collaboflow REST API client for Rust language. This is not an official crate, just a hobby project.

Installation

Requirements

• Rust 1.63+

Importing

The driver is available on crates.io.

To use the driver in your application, simply add it to your project’s Cargo.toml.

[dependencies]
collaboflow-rs = "1.0.1"

Example Usage

[dependencies]
collaboflow-rs = "1.0.1"
tokio = "1.40.0"

use collaboflow_rs::{Authorization, CollaboflowClient, Query};

#[tokio::main]
async fn main() -> Result<(), ()> {
    let authorization = Authorization::with_api_key("User id", "API key");

    let client = CollaboflowClient::new("https://{Collaboflow url}/{Instance name}/api/index.cfm", authorization);

    let query = Query::builder().app_cd(1); // Your app cd

    let document_id: i32 = 1; // Your document id
    let result = client.document.get(document_id, query).await;
    match result {
        Ok(resp) => {
            println!("{:?}", resp);
            Ok(())
        },
        Err(err) => {
            println!("{:?}", err);
            Err(())
        }
    }
}

Support APIs

Document

• getDocumentOverview
• requestDocument
• putDocumentStatus
• deleteDocument
• getDeterms
• getDocumentContents
• simulateDeterms
• searchDocument

MyStatus

• getMyDeterms
• getMyRequests
• getMyDrafts
• getMyProcesses

Form

• getForms
• getFormParts
• getFormSettingsPrints

User

• getUsers
• postUser
• getUser
• putUser
• deleteUser

Group

• getGroups
• postGroup
• getGroup
• putGroup
• deleteGroup

Title

• getTitles
• postTitle
• getTitle
• putTitle
• deleteTitle

Re-exports

pub use authorization::Authorization;

pub use client::CollaboflowClient;

pub use query::Query;

pub use ::bytes;

Modules

authorization

client

query

record

request

response