Update a document

Update the fields in a document.

Overview

Updating a document via code is a common operation that is relatively straightforward, but it is also pretty different because of Kuali's configurable forms. The fields in each form are completely different so you need to understand how to reference the unique id of each field you want to update.

Update a document

The previous article explains how to get the schema of a form. That schema includes the formKey of each field in the form.

For this example, let's assume that we have a form that has a field with a formKey of data.nYMA37CRlj and we want to update data in that field.

Note: You need the id of the specific document you want to update and you pass that as a variable. You can get that from the list of documents.

Query

      
        mutation ($id: ID!, $data: JSON!) {
  updateDocument(args: {id: $id, data: $data}) {
    id
    data
  }
}

      
        curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"mutation ($id: ID!, $data: JSON!) { updateDocument(args: {id: $id, data: $data}) { id data }}","variables":{
  "id": "640266d76f0562f58f9197c6",
  "data": {
    "nYMA37CRlj": "History 201"
  }
}}' --compressed

      
        import fetch from 'node-fetch'

const subdomain = 'subdomain'
const apikey = 'apikey'

const query = `mutation ($id: ID!, $data: JSON!) {
                 updateDocument(args: {id: $id, data: $data}) {
                   id
                   data
                 }
               }`

const variables = {
  "id": "640266d76f0562f58f9197c6",
  "data": {
    "nYMA37CRlj": "History 201"
  }
}


fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
  method:'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${apikey}`
  },
  body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))

      
        <?php

$subdomain = "subdomain";
$apikey = "apikey";

$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$data= '{"query":"mutation ($id: ID!, $data: JSON!) { updateDocument(args: {id: $id, data: $data}) { id data }}","variables":{
  "id": "640266d76f0562f58f9197c6",
  "data": {
    "nYMA37CRlj": "History 201"
  }
}}';

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

          
          require 'net/http'
require 'uri'
require 'json'

subdomain = "subdomain"
apikey = "apikey"

uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
  "query" => "mutation ($id: ID!, $data: JSON!) {
                updateDocument(args: {id: $id, data: $data}) {
                  id
                  data
                }
              }",
  "variables" => {
    "id": "640266d76f0562f58f9197c6",
    "data": {
      "nYMA37CRlj": "History 201"
    }
  }
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

puts response.code
puts response.body

          
          import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;

public class exampleCreate {
  public static void main(String[] args) throws IOException {
    String subdomain = "subdomain";
    String apikey = "apikey";

    URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
    HttpURLConnection http = (HttpURLConnection)url.openConnection();
    http.setRequestMethod("POST");
    http.setDoOutput(true);
    http.setRequestProperty("Content-Type", "application/json");
    http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
    http.setRequestProperty("Authorization", "Bearer " + apikey);

    String data = "{\"query\":\"mutation ($id: ID!, $data: JSON!) { updateDocument(args: {id: $id, data: $data}) { id data }}\",\"variables\":{\"id\":\"640266d76f0562f58f9197c6\",\"data\":{\"nYMA37CRlj\":\"History201\"}}}";

    byte[] out = data.getBytes(Charset.forName("UTF-8"));

    OutputStream stream = http.getOutputStream();
    stream.write(out);
    System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
    BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    //print in String
    System.out.println(response.toString());
    http.disconnect();
  }
}

Variables

      
{
  "id": "640266d76f0562f58f9197c6",
  "data": {
    "nYMA37CRlj": "History 201"
  }
}

Results

      
        {
          "data": {
            "updateDocument": {
              "id": "640266d76f0562f58f9197c6",
              "data": {
                "nYMA37CRlj": "History 201"
              }
            }
          }
        }