<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>References :: CURARE API Connector Documentation</title>
    <link>https://curare.inrae.fr/references/index.html</link>
    <description>Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented.&#xA;This chapter for technical references contains the UML diagrams.&#xA;They are inspired from&#xA;DOI manager SICLIMA developments SIDO usage See the Dataverse guide for the API at https://guides.dataverse.org/en/6.0/api/.&#xA;The version of ERDG is displayed on each footer page of ERDG and exposed at https://entrepot.recherche.data.gouv.fr/api/info/version.&#xA;Once instantiated, DataverseClient is the entry point for the API.</description>
    <generator>Hugo</generator>
    <language>en-EN</language>
    <lastBuildDate>Tue, 22 Jul 2025 00:00:00 +0000</lastBuildDate>
    <atom:link href="https://curare.inrae.fr/references/index.xml" rel="self" type="application/rss+xml" />
    <item>
      <title>Instance information</title>
      <link>https://curare.inrae.fr/references/instance/index.html</link>
      <pubDate>Wed, 28 May 2025 10:27:09 +0200</pubDate>
      <guid>https://curare.inrae.fr/references/instance/index.html</guid>
      <description>--- title: Handle Instance --- classDiagram DataverseClient *-- InstanceHandler click DataverseClient href &#34;../index.html&#34; &#34;Open the page&#34; class InstanceVersion { +String version +String build } class InstanceHandler { %% Show Dataverse Version and Build Number. %% See https://guides.dataverse.org/en/5.0/api/native-api.html#info %% /api/info/version %% @return expiration date of token +Result~InstanceVersion, String~ getInfo() %% Detect if the Dataverse instance is up and running. +boolean isUp() }</description>
    </item>
    <item>
      <title>API Token</title>
      <link>https://curare.inrae.fr/references/token/index.html</link>
      <pubDate>Wed, 28 May 2025 10:23:44 +0200</pubDate>
      <guid>https://curare.inrae.fr/references/token/index.html</guid>
      <description>See https://guides.dataverse.org/en/6.0/api/auth.html.&#xA;--- title: Handle Dataverse API token --- classDiagram DataverseClient *-- TokenHandler click DataverseClient href &#34;../index.html&#34; &#34;Open the page&#34; class TokenHandler { %% Find a Token’s Expiration Date. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#find-a-token-s-expiration-date. %% /api/users/token %% @return expiration date of token +Result~LocalDateTime, String~ getExpiration() %% Get User Information in JSON Format. %% https://guides.dataverse.org/en/6.0/api/native-api.html#get-user-information-in-json-format %% GET /api/users/:me +Result~UserInfo, String~ getUserInfo() %% Recreate a Token in order to obtain a new token to use. %% https://guides.dataverse.org/en/6.0/api/native-api.html#recreate-a-token %% @return expiration date of token %% /api/users/token/recreate?returnExpiration=true +Result~LocalDateTime, String~ recreate() }</description>
    </item>
    <item>
      <title>Dataverse</title>
      <link>https://curare.inrae.fr/references/dataverse/index.html</link>
      <pubDate>Wed, 28 May 2025 09:48:57 +0200</pubDate>
      <guid>https://curare.inrae.fr/references/dataverse/index.html</guid>
      <description>Dataverse is a collection of datasets and/or sub-dataverses.&#xA;--- title: Handle a dataset --- classDiagram DataverseClient *-- DataverseHandler click DataverseClient href &#34;../index.html&#34; &#34;Open the page&#34; class DataverseHandler { %% Assign a New Role on a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#assign-a-new-role-on-a-dataverse-collection %% POST /api/dataverses/{DATAVERSE_ID}/assignments +Result~String, String~ assignRole(Integer dataverseId, Assignment assignment) %% Create a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#create-a-dataverse-collection %% POST /api/dataverses/{PARENT} +Result~WsDataverse, String~ create(String json) %% Delete Role Assignment from a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#delete-role-assignment-from-a-dataverse-collection %% DELETE /api/dataverses/{DATAVERSE_ID}/assignments/$ASSIGNMENT_ID +Result~String, String~ deleteAssignment(Integer dataverseId, Integer assignmentId) %% View a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#view-a-dataverse-collection %% GET /api/dataverses/{DATAVERSE} +Result~WsDataverse, String~ get(String dataverse) %% List Role Assignments in a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#list-role-assignments-in-a-dataverse-collection %% GET /api/dataverses/{DATAVERSE}/assignments +Result~List~Assignment~,String~ listAssignments(String id) %% Publish a Dataverse Collection. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#publish-a-dataverse-collection %% POST /api/dataverses/{DATAVERSE}/actions/:publish %% id : alias or id of dataverse +Result~String, String~ publish(String id) %% Validate Dataset JSON File for a Collection %% See https://guides.dataverse.org/en/latest/api/native-api.html#validate-dataset-json-file-for-a-collection %% POST /api/dataverses/{DATAVERSE}/validateDatasetJson %% json : JSON string of dataset +Result~String, String~ validateDatasetJson(String json) }</description>
    </item>
    <item>
      <title>Dataset</title>
      <link>https://curare.inrae.fr/references/dataset/index.html</link>
      <pubDate>Wed, 28 May 2025 09:50:01 +0200</pubDate>
      <guid>https://curare.inrae.fr/references/dataset/index.html</guid>
      <description>A dataset is in a dataset collection (formerly a dataverse) contains files with metadata.&#xA;To create a dataset, metadata must be provided in a JSON format or in an instance of the related class DatasetMetadata. This class is generated from the JSON Schema.&#xA;--- title: Handle a dataset --- classDiagram DataverseClient *-- DatasetHandler click DataverseClient href &#34;../index.html&#34; &#34;Open the page&#34; class WsDataset { %% Database ID. +Integer id %% DOI. +String persistentId } class DatasetMetadata { } note for DatasetMetadata &#34;This class is generated from the JSON Schema.&#34; class DatasetHandler { %% Assign a New Role on a Dataset. %% https://guides.dataverse.org/en/6.0/api/native-api.html#assign-role-on-a-dataverse-api %% POST /api/datasets/{DATASET_ID}/assignments +Result~String, String~ assignRole(Assignment assignment) %% Create a Dataset in the default Dataverse. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#create-dataset-command. %% /api/dataverses/{PARENT}/datasets +Result~WsDataset, String~ create(String json, boolean doNotValidate) %% Create a Dataset in the default Dataverse. +Result~WsDataset, String~ create(DatasetMetadata metadata, boolean doNotValidate) %% Create a Dataset in a Dataverse. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#create-dataset-command. %% /api/dataverses/{PARENT}/datasets +Result~WsDataset, String~ create(String dataverse, String json, boolean doNotValidate) %% Create a Dataset in a Dataverse. +Result~WsDataset, String~ create(String dataverse, DatasetMetadata metadata, boolean doNotValidate) %% Delete Dataset Draft %% See https://guides.dataverse.org/en/6.0/api/native-api.html#delete-dataset-draft %% DELETE /api/datasets/{DATASET_ID}/versions/:draft +Result~String, String~ deleteDraft(Integer id) %% List assigned roles on a Dataset. %% No entry in the guide 6.0. %% GET /api/datasets/{DATASET_ID}/assignments +Result~List~Assignment~,String~ listAssignments(Integer id) %% Get a Dataset using DOI. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#get-json-representation-of-a-dataset. %% /api/datasets/:persistentId/?persistentId={DATASET_DOI} +Result~WsDataset, String~ getDataset(String doi) %% Get a Dataset using ID. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#get-json-representation-of-a-dataset. %% /api/datasets/{DATASET_ID} +Result~WsDataset, String~ getDataset(Integer id) %% Get Version of a Dataset. %% See https://guides.dataverse.org/en/6.0/api/native-api.html#get-version-of-a-dataset %% /api/datasets/{DATASET_ID}/versions/{VERSION}&#34; +Result~WsDataset, String~ getDatasetByVersion(Integer id, String version) %% Publish a Dataset. %% https://guides.dataverse.org/en/6.0/api/native-api.html#publish-a-dataset %% /api/datasets/:persistentId/actions/:publish?persistentId={DATASET_DOI}&amp;type={MAJOR_OR_MINOR}&#34; +Result~Boolean, String~ publish(String doi, DatasetVersion version) %% Release a new empty version with no metadata, and a file warning users that this dataset is no longer existing. %% 1. delete all files %% 2. update a README.md file with a warning message %% 3. publish the dataset +Result~Boolean, String~ publish(String doi, DatasetVersion version) %% Update Metadata For a Dataset. %% https://guides.dataverse.org/en/6.0/api/native-api.html#update-metadata-for-a-dataset %% /api/datasets/:persistentId/versions/:draft?persistentId={DATASET_DOI} +Result~WsDataset, String~ update(String json) }</description>
    </item>
    <item>
      <title>File</title>
      <link>https://curare.inrae.fr/references/file/index.html</link>
      <pubDate>Wed, 28 May 2025 09:50:45 +0200</pubDate>
      <guid>https://curare.inrae.fr/references/file/index.html</guid>
      <description>A file can have some metadata such as a path and keywords.&#xA;--- title: Dataset file handling --- classDiagram DataverseClient *-- FileHandler click DataverseClient href &#34;../index.html&#34; &#34;Open the page&#34; class DatasetFileProperties { +String description +String directoryLabel +List~String~ categories +boolean forceReplace +boolean restrict +boolean tabIngest } class FileHandler { -DataverseConfiguration config %% Replacing Files. %% https://guides.dataverse.org/en/6.0/api/native-api.html#replacing-files %% /api/files/{FILE_ID}/replace +Result~String,String~ replace(Integer id, String filePath, String fileName, DatasetFileProperties properties) %% Replacing Files. %% https://guides.dataverse.org/en/6.0/api/native-api.html#replacing-files %% /api/files/:persistentId/replace?persistentId={PERSISTENT_ID} +Result~String,String~ replace(String id, String filePath, String fileName, DatasetFileProperties properties) %% Add a File to a Dataset. %% https://guides.dataverse.org/en/6.0/api/native-api.html#add-file-api %% /api/datasets/:persistentId/add +Result~String,String~ upload(String datasetDOI, String filePath, String fileName, DatasetFileProperties properties) }</description>
    </item>
    <item>
      <title>Result</title>
      <link>https://curare.inrae.fr/references/result/index.html</link>
      <pubDate>Tue, 22 Jul 2025 00:00:00 +0000</pubDate>
      <guid>https://curare.inrae.fr/references/result/index.html</guid>
      <description>Result&lt;T, ERR&gt; is a generic class to return a result of class T or an error of type ERR. It is inspired by the Rust Result type.&#xA;This class is used for returning and propagating errors without throwing exceptions. Thus, errors are handled in a functional way and considered as a part of the result.&#xA;All methods return results from the API calls using this class.&#xA;--- title: Result --- classDiagram class Result~T,ERR~ { +Result~T~ ok(T)$ +Result~ERR~ err(ERR)$ +T unwrap() +ERR unwrapErr() +boolean isOk() +boolean isErr() } For example:</description>
    </item>
  </channel>
</rss>