ReusesApi

public interface ReusesApi implements WithApiKey

Reuse related operations

Functions

deleteReuse

abstract Flow<DgfrCallState<Boolean>> deleteReuse(String reuse)

Delete a given reuse

deleteReuseBadge

abstract Flow<DgfrCallState<Boolean>> deleteReuseBadge(String badgeKind, String reuse)

Delete a badge for a given reuse

deleteUnfeatureReuse

abstract Flow<DgfrCallState<Reuse>> deleteUnfeatureReuse(String reuse)

Unmark a reuse as featured

deleteUnfollowReuse

abstract Flow<DgfrCallState<Boolean>> deleteUnfollowReuse(String id)

Unfollow an object given its ID Returns the number of followers left after the operation

getAvailableReuseBadges

abstract Flow<DgfrCallState<Boolean>> getAvailableReuseBadges()

List all available reuse badges and their labels TODO : check the return content

getListReuseFollowers

abstract Flow<DgfrCallState<FollowPage>> getListReuseFollowers(String id, Integer page, Integer pageSize)

List all followers for a given object

getListReuses

abstract Flow<DgfrCallState<ReusePage>> getListReuses(String q, List<String> facets, String tag, String organization, String owner, String dataset, String type, String datasets, String followers, String badge, Boolean featured, String sort, Integer page, Integer pageSize)

getReuse

abstract Flow<DgfrCallState<Reuse>> getReuse(String reuse)

Fetch a given reuse

getReuseTypes

abstract Flow<DgfrCallState<List<ReuseType>>> getReuseTypes()

List all reuse types

getSuggestReuses

abstract Flow<DgfrCallState<List<ReuseSuggestion>>> getSuggestReuses(String q, Integer size)

Suggest reuses

postAddReuseBadge

abstract Flow<DgfrCallState<Badge>> postAddReuseBadge(String reuse, Badge payload)

Create a new badge for a given reuse

postCreateReuse

abstract Flow<DgfrCallState<Reuse>> postCreateReuse(Reuse payload)

Create a new object

postFeatureReuse

abstract Flow<DgfrCallState<Reuse>> postFeatureReuse(String reuse)

Mark a reuse as featured

postFollowReuse

abstract Flow<DgfrCallState<Boolean>> postFollowReuse(String id)

Follow an object given its ID Returns the number of followers left after the operation

postReuseAddDataset

abstract Flow<DgfrCallState<Reuse>> postReuseAddDataset(String reuse, DatasetReference payload)

Add a dataset to a given reuse

postReuseImage

abstract Flow<DgfrCallState<UploadedImage>> postReuseImage(String reuse, ByteArray file, String fileName, String contentType)

Upload a new reuse image

putUpdateReuse

abstract Flow<DgfrCallState<Reuse>> putUpdateReuse(String reuse, Reuse payload)

Update a given reuse

setApiKey

abstract Unit setApiKey(String apiKey)

Inheritors

DgfrService