Rust API client for datacite-client

The REST API is used for all API interactions with DataCite services.

For more information, please visit https://support.datacite.org

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 2.3.0
• Package version: 2.3.0
• Generator version: 7.17.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named datacite-client and add the following to Cargo.toml under [dependencies]:

datacite-client = { path = "./datacite-client" }

Documentation for API Endpoints

All URIs are relative to https://api.test.datacite.org

Class	Method	HTTP request	Description
ActivitiesApi	activities_get	GET /activities	Get a JSON API result of activities.
ActivitiesApi	activities_id_get	GET /activities/{id}	Get a JSON API result of a specific activity.
ActivitiesApi	dois_id_activities_get	GET /dois/{id}/activities	Return activities for a specific DOI.
ClientPrefixesApi	client_prefixes_get	GET /client-prefixes	Return a list of client-prefixes.
ClientsApi	clients_get	GET /clients	Return a list of clients (repositories).
ClientsApi	clients_id_get	GET /clients/{id}	Return a client.
ClientsApi	clients_totals_get	GET /clients/totals	Return clients DOI production statistics.
DoisApi	dois_get	GET /dois	Return a list of DOIs.
DoisApi	dois_id_activities_get	GET /dois/{id}/activities	Return activities for a specific DOI.
DoisApi	dois_id_delete	DELETE /dois/{id}	Delete a DOI (for DOIs in draft state only).
DoisApi	dois_id_get	GET /dois/{id}	Return a DOI.
DoisApi	dois_id_put	PUT /dois/{id}	Update a DOI.
DoisApi	dois_post	POST /dois	Add a new DOI.
EventsApi	events_get	GET /events	Return a list of events.
EventsApi	events_id_get	GET /events/{id}	Return an event.
HeartbeatApi	heartbeat_get	GET /heartbeat	Return the current status of the REST API.
PrefixesApi	prefixes_get	GET /prefixes	Return a list of prefixes.
PrefixesApi	prefixes_id_get	GET /prefixes/{id}	Return a prefix.
PrefixesApi	prefixes_totals_get	GET /prefixes/totals	Return prefixes DOI production statistics.
ProviderPrefixesApi	provider_prefixes_get	GET /provider-prefixes	Return a list of provider-prefixes.
ProvidersApi	providers_get	GET /providers	Return a list of providers (including members and consortium organizations).
ProvidersApi	providers_id_get	GET /providers/{id}	Return a provider.
ProvidersApi	providers_totals_get	GET /providers/totals	Return providers DOI production statistics.
ReportsApi	reports_get	GET /reports	A JSON array of reports.
ReportsApi	reports_id_get	GET /reports/{id}	Return a report.
ReportsApi	reports_id_put	PUT /reports/{id}	Update a report.
ReportsApi	reports_post	POST /reports	Add a new report.
RepositoriesApi	repositories_id_delete	DELETE /repositories/{id}	Delete a repository. Only possible if no DOIs are in the repository.
RepositoriesApi	repositories_id_put	PUT /repositories/{id}	Update a repository.
RepositoriesApi	repositories_post	POST /repositories	Add a new repository.

Documentation For Models

• ActivitiesGet200Response
• ActivitiesIdGet200Response
• Activity
• ActivityAttributes
• Certificate
• Client
• ClientAttributes
• ClientAttributesIssn
• ClientPrefix
• ClientPrefixAttributes
• ClientPrefixRelationships
• ClientPrefixesGet200Response
• ClientPrefixesGet200ResponseMeta
• ClientRelationships
• ClientRelationshipsConsortium
• ClientRelationshipsPrefixes
• ClientRelationshipsProvider
• ClientType
• ClientsGet200Response
• ClientsGet200ResponseMeta
• ClientsIdGet200Response
• ContributorType
• DataObject
• DoiDetailItem
• DoiDetailItemData
• DoiDetailItemDataAttributes
• DoiDetailItemDataAttributesAllOfAlternateIdentifiersInner
• DoiDetailItemDataAttributesAllOfIdentifiersInner
• DoiDetailItemDataAttributesAllOfLandingPage
• DoiDetailItemDataAttributesAllOfViewsOverTimeInner
• DoiDetailItemDataRelationships
• DoiDetailItemDataRelationshipsCitations
• DoiDetailItemDataRelationshipsClient
• DoiDetailItemDataRelationshipsMedia
• DoiDetailItemDataRelationshipsPartOf
• DoiDetailItemDataRelationshipsParts
• DoiDetailItemDataRelationshipsProvider
• DoiDetailItemDataRelationshipsReferences
• DoiDetailItemDataRelationshipsVersionOf
• DoiDetailItemDataRelationshipsVersions
• DoiListItem
• DoiListItemAttributes
• DoiListItemRelationships
• DoiPropertiesDates
• DoiPropertiesMetadata
• DoiPropertiesMetadataContainer
• DoiPropertiesMetadataContributorsInner
• DoiPropertiesMetadataCreatorsInner
• DoiPropertiesMetadataCreatorsInnerAffiliationInner
• DoiPropertiesMetadataCreatorsInnerNameIdentifiersInner
• DoiPropertiesMetadataDatesInner
• DoiPropertiesMetadataDescriptionsInner
• DoiPropertiesMetadataFundingReferencesInner
• DoiPropertiesMetadataGeoLocationsInner
• DoiPropertiesMetadataGeoLocationsInnerGeoLocationBox
• DoiPropertiesMetadataGeoLocationsInnerGeoLocationPoint
• DoiPropertiesMetadataPublisher
• DoiPropertiesMetadataPublisherOneOf
• DoiPropertiesMetadataRelatedIdentifiersInner
• DoiPropertiesMetadataRelatedItemsInner
• DoiPropertiesMetadataRelatedItemsInnerContributorsInner
• DoiPropertiesMetadataRelatedItemsInnerCreatorsInner
• DoiPropertiesMetadataRelatedItemsInnerRelatedItemIdentifier
• DoiPropertiesMetadataRelatedItemsInnerTitlesInner
• DoiPropertiesMetadataRightsListInner
• DoiPropertiesMetadataTitlesInner
• DoiPropertiesMetadataTypes
• DoiPropertiesOther
• DoisGet200Response
• DoisGet200ResponseMeta
• Event
• EventAttributes
• EventAttributesRelationships
• EventsGet200Response
• EventsGet200ResponseMeta
• EventsIdGet200Response
• FocusArea
• Links
• MemberType
• MetaCore
• MetaObject
• NameType
• OrganizationType
• Prefix
• PrefixAttributes
• PrefixRelationships
• PrefixesGet200Response
• PrefixesGet200ResponseMeta
• Provider
• ProviderAttributes
• ProviderContact
• ProviderPrefix
• ProviderPrefixRelationships
• ProviderPrefixesGet200Response
• ProviderPrefixesGet200ResponseMeta
• ProviderRelationships
• ProviderRelationshipsConsortium
• ProviderRelationshipsConsortiumOrganizations
• ProviderRelationshipsContacts
• ProvidersGet200Response
• ProvidersGet200ResponseMeta
• ProvidersIdGet200Response
• ProvidersIdGet200ResponseMeta
• Region
• RelatedIdentifierType
• RelationType
• RelationTypeId
• Report
• ReportReportDatasetsInner
• ReportReportDatasetsInnerDatasetContributorsInner
• ReportReportDatasetsInnerDatasetDatesInner
• ReportReportDatasetsInnerDatasetIdInner
• ReportReportDatasetsInnerPerformanceInner
• ReportReportDatasetsInnerPerformanceInnerInstanceInner
• ReportReportDatasetsInnerPerformanceInnerPeriod
• ReportReportDatasetsInnerPublisherIdInner
• ReportReportHeader
• ReportReportHeaderExceptionsInner
• ReportReportHeaderReportingPeriod
• ReportReportSubsetsInner
• ReportsGet200Response
• ReportsGet200ResponseMeta
• ReportsIdGet200Response
• RepositoriesIdPutRequest
• RepositoriesIdPutRequestData
• RepositoriesIdPutRequestDataAttributes
• RepositoriesPostRequest
• RepositoriesPostRequestData
• RepositoriesPostRequestDataAttributes
• RepositoriesPostRequestDataAttributesIssn
• RepositoriesPostRequestDataAttributesServiceContact
• RepositoriesPostRequestDataRelationships
• RepositoriesPostRequestDataRelationshipsProvider
• RepositoriesPostRequestDataRelationshipsProviderData
• RepositoryResponse
• RepositoryResponseAttributes
• RepositoryResponseAttributesServiceContact
• RepositoryType
• ResourceTypeGeneral
• Software
• Source
• SourceId
• State
• Subject
• TitleType
• TotalsObject
• TotalsObjectTemporal

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@datacite.org