OrganizationsApi

public interface OrganizationsApi implements WithApiKey

Organization related operations

Functions

deleteOrganization

abstract Flow<DgfrCallState<Boolean>> deleteOrganization(String org)

Delete a organization given its identifier

deleteOrganizationBadge

abstract Flow<DgfrCallState<Boolean>> deleteOrganizationBadge(String badgeKind, String org)

Delete a badge for a given organization

deleteOrganizationMember

abstract Flow<DgfrCallState<Boolean>> deleteOrganizationMember(String org, String user)

Delete member from an organization

deleteUnfollowOrganization

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

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

getAvailableOrganizationBadges

abstract Flow<DgfrCallState<Map<String, String>>> getAvailableOrganizationBadges()

List all available organization badges and their labels

getListMembershipRequests

abstract Flow<DgfrCallState<List<MembershipRequest>>> getListMembershipRequests(String org, String status)

List membership requests for a given organization

getListOrganizationDatasets

abstract Flow<DgfrCallState<DatasetPage>> getListOrganizationDatasets(String org, Integer page, Integer pageSize, String sort)

List organization datasets (including private ones when member)

getListOrganizationDiscussions

abstract Flow<DgfrCallState<List<Discussion>>> getListOrganizationDiscussions(String org)

List organization discussions

getListOrganizationFollowers

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

List all followers for a given object

getListOrganizationIssues

abstract Flow<DgfrCallState<List<Issue>>> getListOrganizationIssues(String org)

List organization issues

getListOrganizationReuses

abstract Flow<DgfrCallState<List<Reuse>>> getListOrganizationReuses(String org)

List organization reuses (including private ones when member)

getListOrganizations

abstract Flow<DgfrCallState<OrganizationPage>> getListOrganizations(String q, List<String> facets, String reuses, String badge, String datasets, String followers, String sort, Integer page, Integer pageSize)

List or search all organizations

getOrganization

abstract Flow<DgfrCallState<Organization>> getOrganization(String org)

Get a organization given its identifier

getOrgRoles

abstract Flow<DgfrCallState<List<OrganizationRole>>> getOrgRoles()

List all possible organization roles

getRdfOrganization

abstract Flow<DgfrCallState<String>> getRdfOrganization(String org)

getRdfOrganizationFormat

abstract Flow<DgfrCallState<String>> getRdfOrganizationFormat(String org, String format)

getSuggestOrganizations

abstract Flow<DgfrCallState<List<OrganizationSuggestion>>> getSuggestOrganizations(String q, Integer size)

Suggest organizations

postAcceptMembership

abstract Flow<DgfrCallState<Member>> postAcceptMembership(String id, String org)

Accept user membership to a given organization

postAddOrganizationBadge

abstract Flow<DgfrCallState<Badge>> postAddOrganizationBadge(String org, Badge payload)

Create a new badge for a given organization

postCreateOrganization

abstract Flow<DgfrCallState<Organization>> postCreateOrganization(Organization payload)

Create a new organization

postCreateOrganizationMember

abstract Flow<DgfrCallState<Member>> postCreateOrganizationMember(String org, String user, Member payload)

Add a member into a given organization

postFollowOrganization

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

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

postMembershipRequest

abstract Flow<DgfrCallState<MembershipRequest>> postMembershipRequest(String org)

Apply for membership to a given organization

postOrganizationLogo

abstract Flow<DgfrCallState<UploadedImage>> postOrganizationLogo(String org, ByteArray file, String fileName, String contentType)

Upload a new logo

postRefuseMembership

abstract Flow<DgfrCallState<Boolean>> postRefuseMembership(String id, String org, RefuseMembership payload)

Refuse user membership to a given organization

putResizeOrganizationLogo

abstract Flow<DgfrCallState<UploadedImage>> putResizeOrganizationLogo(String org, ByteArray file, String fileName, String contentType)

Set the logo BBox

putUpdateOrganization

abstract Flow<DgfrCallState<Organization>> putUpdateOrganization(String org, Organization payload)

Update a organization given its identifier

putUpdateOrganizationMember

abstract Flow<DgfrCallState<Member>> putUpdateOrganizationMember(String org, String user, Member payload)

Update member status into a given organization

setApiKey

abstract Unit setApiKey(String apiKey)

Inheritors

DgfrService