Inserting document class(es)

Insert the details of one or more document class(es).

Syntax: POST/model/documentClass

Table 1. Inserting document class(es) requirements
Property Data type Description
apiKey header (required) String To authenticate API call.
classList body (required) Array An array of document class objects which are inserted.
  • Curl
    curl -X POST -u 'Functional ID:Password' 'https://requesturl/ca/rest/content/v1/model/documentClass'  -H 'apiKey: ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "classList": [{"docClass": "Invoice", "comment": ""}, {"docClass": "Letter", "comment": ""}]}'
  • Java
    import java.io.IOException;
    import okhttp3.OkHttpClient;
    import okhttp3.Request;
    import okhttp3.Response;
    import okhttp3.RequestBody;
    import java.util.Base64;
    import okhttp3.MediaType;
    
    
    public class testcode {
      public static void main(String[] args) {
        String encoding = Base64.getEncoder().encodeToString(("Functional ID:Password").getBytes());
        OkHttpClient client = new OkHttpClient();
        MediaType mediaType = MediaType.parse("application/json;");
        RequestBody body = RequestBody.create(mediaType, "{'classList': [{'docClass': 'Invoice', 'comment': 'invoice doc'}, {'docClass': 'Letter', 'comment': ''}]}");
        Request request = new Request.Builder()
          .url("https://requesturl/ca/rest/content/v1/model/documentClass")
          .post(body)
          .addHeader("apiKey", "ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=")
          .addHeader("Authorization", "Basic " + encoding)
          .build();
    
    
        try {
          Response response = client.newCall(request).execute();
          System.out.println(response.body().string());
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
    }
    
    
    /*
     * The JAR files in Referenced Libraries could be found in the Download section with the following link:
     * 1. okhttp.jar - https://github.com/square/okhttp
     * 2. okio.jar - https://github.com/square/okio
     */
  • JavaScript
    let request = require("request");
    let Base64 = require('js-base64').Base64;
    
    
    let encoding = Base64.encode('Functional ID:Password');
    let options = {
      method: 'POST',
      url: 'https://requesturl/ca/rest/content/v1/model/documentClass',
      headers:
      {
        'apiKey' : 'ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=',
        'authorization': "Basic " + encoding
      },
      body: {
          "classList": [{"docClass": "Invoice", "comment": ""}, {"docClass": "Letter", "comment": ""}]
      }
    };
    
    
    request(options, function (error, response, body) {
      console.log(body)
      if (error) throw new Error(error);
    });
  • Python
    import requests
    import base64
    
    
    encoding = base64.b64encode(b'Functional ID:Password')
    
    
    url = "https://requesturl/ca/rest/content/v1/model/documentClass"
    headers = {
     "apiKey" : "ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=",
     "authorization": "Basic " +  encoding.decode("utf-8")
    }
    data= {
      "classList": [{"docClass": "Invoice", "comment": ""}, {"docClass": "Letter", "comment": ""}]
    }
    response = requests.request("POST", url,data=data, headers=headers)
Example response
{
  "status": {
    "code": 200,
    "messageId": "CIWCA11141",
    "message": "Successfully inserted the document class."
  },
  "data": [
    {
      "DocClassID": 20,
      "DocClass": "Invoice",
      "comment": "invoice doc"
    }
  ]}