From 075363713df39c542000cef54a2d9ac4092186bf Mon Sep 17 00:00:00 2001
From: marcodeltufo <marco.deltufo@exact-lab.it>
Date: Mon, 24 Jul 2023 12:34:42 +0200
Subject: [PATCH] .
---
.../apis/java-javascript-v3-api.md | 38 +++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/docs/software-developer-documentation/apis/java-javascript-v3-api.md b/docs/software-developer-documentation/apis/java-javascript-v3-api.md
index ea450e3e6b6..b63e669d308 100644
--- a/docs/software-developer-documentation/apis/java-javascript-v3-api.md
+++ b/docs/software-developer-documentation/apis/java-javascript-v3-api.md
@@ -119,6 +119,7 @@ property [javax.net](http://javax.net).ssl.trustStore. Example:
Connecting in Java
**V3ConnectionExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.IApplicationServerApi;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
@@ -166,6 +167,7 @@ some things had to be done a bit differently. But even then we tried to
be conceptually consistent.
**V3ConnectionExample.html**
+
```html
<!DOCTYPE html>
<html>
@@ -256,6 +258,7 @@ correct. In case a given user does not exist or the provided password
was incorrect the login methods return null.
#### Example
+
```java
**V3LoginExample.java**
@@ -279,6 +282,7 @@ was incorrect the login methods return null.
}
}
```
+
```html
**V3LoginExample.html**
@@ -312,6 +316,7 @@ PATs please read: [Personal Access
Tokens](/pages/viewpage.action?pageId=122140993).
Example of how to create and use a PAT:
+
```java
import java.util.Arrays;
import java.util.Date;
@@ -355,6 +360,7 @@ OpenBIS provides a method to obtain the session information for an
already log in user:
#### Example
+
```java
**V3CreationExample.java**
@@ -389,6 +395,7 @@ dropboxes are planned but not implemented yet. Please use V2 dropboxes
until V3 version is out.
#### Example
+
```java
**V3CreationExample.java**
@@ -417,6 +424,7 @@ until V3 version is out.
}
}
```
+
```html
**V3CreationExample.html**
@@ -441,6 +449,7 @@ until V3 version is out.
```
#### Properties example
+
```java
**V3CreationWithPropertiesExample.java**
@@ -474,6 +483,7 @@ until V3 version is out.
}
}
```
+
```html
**V3CreationWithPropertiesExample.html**
@@ -506,6 +516,7 @@ until V3 version is out.
```
#### Different ids example
+
```java
**V3CreationWithDifferentIdsExample.java**
@@ -538,6 +549,7 @@ until V3 version is out.
```
**V3CreationWithDifferentIdsExample.html**
+
```html
<script>
require([ "as/dto/sample/create/SampleCreation", "as/dto/entitytype/id/EntityTypePermId", "as/dto/space/id/SpacePermId", "as/dto/experiment/id/ExperimentIdentifier", "as/dto/experiment/id/ExperimentPermId" ],Â
@@ -568,6 +580,7 @@ The following example creates parent and child samples for a sample type
which allow automatic code generation:
**V3CreationParentAndChildExample**
+
```java
import java.util.Arrays;
import java.util.List;
@@ -599,6 +612,7 @@ which allow automatic code generation:
}
```
**V3CreationParentAndChildExample.html**
+
```html
<script>
require([ "openbis", "as/dto/sample/create/SampleCreation", "as/dto/entitytype/id/EntityTypePermId", "as/dto/space/id/SpacePermId", "as/dto/common/id/CreationId" ],
@@ -638,6 +652,7 @@ after creation.
#### Example
**V3UpdateExample.java**
+
```java
import java.util.Arrays;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.experiment.id.ExperimentIdentifier;
@@ -662,6 +677,7 @@ after creation.
}
```
**V3UpdateExample.html**
+
```html
<script>
require([ "as/dto/sample/update/SampleUpdate", "as/dto/sample/id/SampleIdentifier", "as/dto/experiment/id/ExperimentIdentifier" ],Â
@@ -684,6 +700,7 @@ after creation.
#### Properties example
**V3UpdateWithPropertiesExample.java**
+
```java
import java.util.Arrays;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.id.SampleIdentifier;
@@ -713,6 +730,7 @@ after creation.
}
```
**V3UpdateWithPropertiesExample.html**
+
```html
<script>
require([ "as/dto/sample/update/SampleUpdate", "as/dto/sample/id/SampleIdentifier" ], function(SampleUpdate, SampleIdentifier) {
@@ -739,6 +757,7 @@ after creation.
#### Parents example
**V3UpdateWithParentsExample.java**
+
```java
import java.util.Arrays;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.id.SampleIdentifier;
@@ -775,6 +794,7 @@ after creation.
}
```
**V3UpdateWithParentsExample.html**
+
```html
<script>
require([ "as/dto/sample/update/SampleUpdate", "as/dto/sample/id/SampleIdentifier" ],Â
@@ -949,6 +969,7 @@ identifier). A code example on how to use sorting is presented below.
#### Example
**V3SearchExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample;
@@ -981,6 +1002,7 @@ identifier). A code example on how to use sorting is presented below.
}
```
**V3SearchExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleSearchCriteria", "as/dto/sample/fetchoptions/SampleFetchOptions" ],Â
@@ -1009,6 +1031,7 @@ identifier). A code example on how to use sorting is presented below.
#### Example with pagination and sorting
**V3SearchWithPaginationAndSortingExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample;
@@ -1043,6 +1066,7 @@ identifier). A code example on how to use sorting is presented below.
}
```
**V3SearchWithPaginationAndSortingExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleSearchCriteria", "as/dto/sample/fetchoptions/SampleFetchOptions" ],
@@ -1078,6 +1102,7 @@ one criteria needs to be fulfilled use `criteria.withOrOperator()` as in
the following example:
**V3SearchWithOrOperatorExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample;
@@ -1110,6 +1135,7 @@ the following example:
}
```
**V3SearchWithOrOperatorExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleSearchCriteria", "as/dto/sample/fetchoptions/SampleFetchOptions" ],Â
@@ -1142,6 +1168,7 @@ The following code finds samples with perm ID that ends with "6" AND
experiment OR of type whose code starts with "MASTER").
**V3SearchWithNestedLogicalOperatorsExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample;
@@ -1176,6 +1203,7 @@ experiment OR of type whose code starts with "MASTER").
}
```
**V3SearchWithNestedLogicalOperatorsExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleSearchCriteria", "as/dto/sample/fetchoptions/SampleFetchOptions" ],Â
@@ -1212,6 +1240,7 @@ using `fetchOptions.withChildrenUsing(fetchOptions) `as in the following
example:
**V3SearchWithRecursiveFetchOptionsExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.Sample;
@@ -1259,6 +1288,7 @@ example:
}
```
**V3SearchWithRecursiveFetchOptionsExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleSearchCriteria", "as/dto/sample/fetchoptions/SampleFetchOptions" ],Â
@@ -1313,6 +1343,7 @@ by specifying a text snippet (or complete words) to be found in any type
of meta data (entity attribute or property). Example:
**V3GlobalSearchExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.global.GlobalSearchObject;
@@ -1349,6 +1380,7 @@ of meta data (entity attribute or property). Example:
**V3GlobalSearchExample.html**
+
```html
<script>
require([ "as/dto/global/search/GlobalSearchCriteria", "as/dto/global/search/GlobalSearchObjectKind", "as/dto/global/fetchoptions/GlobalSearchObjectFetchOptions" ],Â
@@ -1392,6 +1424,7 @@ returned map.
#### Example
**V3GetExample.java**
+
```java
import java.util.Arrays;
import java.util.Map;
@@ -1427,6 +1460,7 @@ returned map.
}
```
**V3GetExample.html**
+
```html
<script>
require([ "as/dto/sample/id/SampleIdentifier", "as/dto/sample/id/SamplePermId", "as/dto/sample/fetchoptions/SampleFetchOptions" ],
@@ -1471,6 +1505,7 @@ can.
#### Example
**V3DeleteExample.java**
+
```java
import java.util.Arrays;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.deletion.id.IDeletionId;
@@ -1503,6 +1538,7 @@ can.
```
**V3DeleteExample.html**
+
```html
<script>
require([ "as/dto/sample/id/SampleIdentifier", "as/dto/sample/delete/SampleDeletionOptions" ],Â
@@ -1537,6 +1573,7 @@ and `searchSampleTypes`. Here is an example which will search for all
sample types and assigned property types:
**V3SearchTypesExample.java**
+
```java
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.SearchResult;
import ch.ethz.sis.openbis.generic.asapi.v3.dto.property.PropertyAssignment;
@@ -1568,6 +1605,7 @@ sample types and assigned property types:
}
```
**V3SearchTypesExample.html**
+
```html
<script>
require([ "as/dto/sample/search/SampleTypeSearchCriteria", "as/dto/sample/fetchoptions/SampleTypeFetchOptions" ],Â
--
GitLab