OPA REST API

Document Web APIs made with Django REST Framework.

api

List all datasets. Filter fields : title, url, period, tag, licence, organization, from_date, to_date.

Fields:

  • title: CharField R
  • url: SlugField R
  • description: CharField R
  • tag: ListSerializer Array of objects
    • tag: CharField R
  • period: PeriodSerializer
    • period: CharField R
  • license: LicenseSerializer
    • license: CharField R
    • url: CharField R
  • organization: OrganizationSerializer
    • organization: CharField R
    • url: CharField R
  • date: DateField R
  • nb_resources: IntegerField
  • credential: CredentialSerializer
    • credential: CharField R

Create a dataset (Superuser only). This function does not work through DRF Docs interface.

Fields:

  • title: CharField R
  • url: SlugField R
  • description: CharField R
  • period: CharField R
  • license: CharField R
  • tag: CharField R
  • organization: CharField R
  • date: DateField R
  • expiration_date: DateField
  • nb_resources: IntegerField R
  • credential: CharField R

List all resources. Filter fields : format.

Fields:

  • name: CharField R
  • url: SlugField R
  • description: CharField R
  • format: FormatSerializer R
    • format: CharField R
  • dataset: ShortDatasetSerializer R
    • url: SlugField R
  • credential: CredentialSerializer R
    • credential: CharField R
  • date: DateField R

Returns the data contained in the resource's file. This operation might slow your navigator and not succeed through this interface if file is too big.

No fields.

Creates a new resource. (Superuser only). This function does not work through DRF Docs interface.

Fields:

  • name: CharField R
  • url: SlugField R
  • description: CharField R
  • format: CharField R
  • data: CharField R
  • dataset: CharField R
  • credential: CharField R
  • date: DateField R

Upload a file on the server (Superuser only). This function does not work through DRF Docs interface.

No fields.

Display the credential of the sender.

No fields.

Returns how many users connected since the last date given. If no date given : nb users connect in the last month.

No fields.

Returns how many resources are available on the website.

No fields.

Send a mail to the admin. (Superuser only). This function does not work through DRF Docs interface.

No fields.