Get training files

Get training files by document class based on the document class ID.

Syntax.

GET /model/documentClass/{documentClassId}/files

Table 1. Getting training files requirements
Property	Data type	Description
apiKey header	String	Required. To authenticate the API call.
documentClassId path	Integer	Required. Unique identifier for each document class. documentClassId can be retrieved with the function `Get /model/documentClass`.

The file IDs are returned in the result for each training file, which can be used to delete the training files later.

Curl

curl -X GET -u 'Functional ID:Password' 'https://requesturl/ca/rest/content/v1/model/documentClass/{documentClassId}/files'  -H 'apiKey: ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ='

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();


    Request request = new Request.Builder()
      .url("https://requesturl/ca/rest/content/v1/model/documentClass/{documentClassId}/files")
      .get()
      .addHeader("apiKey", "ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=")
      .addHeader("Authorization", "Basic " + encoding)
      .build();


    try {
      Response response = client.newCall(request).execute();
      System.out.println(response.body().string());
    } catch (IOException e) {
      // TODO Auto-generated catch block
      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

var request = require("request");
var Base64 = require('js-base64').Base64;


var encoding = Base64.encode('Functional ID:Password');
var options = {
  method: 'GET',
  url: 'https://requesturl/ca/rest/content/v1/model/documentClass/{documentClassId}/files',
  headers:
  {
    'apiKey' : 'ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=',
    'authorization': "Basic " + encoding
  }
};


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/{documentClassId}/files"
headers = {
 "apiKey" : "ZjMzYzg1ZDYtNTk1Nwhi5782NzItYjg3Mzg2ZGQwOGNhO3h5aWJtO2RlZmF1bHQ=",
 "authorization": "Basic " +  encoding.decode("utf-8") 
}


response = requests.request("GET", url, headers=headers)

Example response

{
  "status": {
    "code": 0,
    "messageId": "string",
    "message": "string"
  },
  "data": {
    "DocClassID": 1,
    "DocClass": "Invoice",
    "Comment": "this is a sample class",
    "FileList": [
      {
        "FileID": 123,
        "Name": "test1.pdf",
        "DocClassID": 6,
        "NumPages": 1,
        "UploadDate": "1573521856009",
        "UserUploaded": 1,
        "ErrorInfo": ""
      }
    ]
  }
}