Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourBlue
title2.0

Page Properties
hiddentrue


Status

Status
colourGreen
titleDONE

Priority1
Noteand subpages

Ressources

Remarks


Excerpt
This tutorial shows how documents can be imported into a yuuvis® API system via the Core API. During this tutorial, a short Java application will be developed that implements the HTTP requests for importing documents. A JavaScript version of this tutorial can be found here


Section
bordertrue


Column

Table of Contents

Table of Contents
exclude(Table of Contents|More Tutorials|Updating Documents|Retrieving Documents|Deleting Documents)


Requirements

To work through this tutorial, the following is required:

...

Table of Contents

...

Maven Configuration

Our Java client will submit its requests to the Core API using OkHttp 3.12 by Square, Inc. Therefore, the following block must be added to the Maven dependencies in the pom.xml of the project:

...

We use a Request.Builder() to create a request object with the multipart body, headers, and the URL. The following headers are necessary for the import because they contain user information of the user accessing the endpoint: Authorization header that contains the Base64-coded credentials of the user and an X-ID-TENANT-NAME header that contains the tenant name of the user. If the used OkHttp client supports cookie handling, the Authorization header can be omitted after the client's first request, since the logon information is stored in a session cookie (see alsoLogin Tutorial).

Code Block
languagejava
titleBuilding a POST Request for an Import
linenumberstrue
Request request = new Request.Builder()
        .header("Authorization", "Basic "+ auth)
        .header("X-ID-TENANT-NAME", tenant)
        .url(baseUrl + "/api/dms/objects") //baseUrl: "http://<host>:<port>"
        .post(requestBody)
        .build();

...