dataservices

Dataservices related operations

List or search all dataservices

get

Paramètres de requête

pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

qstringOptionnel

ownerstringOptionnel

organizationstringOptionnel

organization_badgestring · my-custom-formatOptionnel

access_typestring · enumOptionnelValeurs possibles:

tagstringOptionnel

contact_pointstringOptionnel

datasetstringOptionnel

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/dataservices/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "access_audiences": [
        {
          "condition": "yes",
          "id": "text",
          "role": "local_authority_and_administration"
        }
      ],
      "access_type": "open",
      "acronym": "text",
      "archived_at": "2025-08-09T15:11:28.084Z",
      "authorization_request_url": "text",
      "availability": "99.99",
      "availability_url": "text",
      "base_api_url": "text",
      "business_documentation_url": "text",
      "contact_points": [
        {
          "contact_form": "text",
          "email": "text",
          "id": "text",
          "name": "text",
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "role": "text"
        }
      ],
      "created_at": "2025-08-09T15:11:28.084Z",
      "datasets": {},
      "deleted_at": "2025-08-09T15:11:28.084Z",
      "description": "text",
      "extras": {},
      "format": "REST",
      "harvest": {
        "archived_at": "2025-08-09T15:11:28.084Z",
        "archived_reason": "text",
        "backend": "text",
        "created_at": "2025-08-09T15:11:28.084Z",
        "domain": "text",
        "id": "text",
        "last_update": "2025-08-09T15:11:28.084Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "source_url": "text",
        "uri": "text"
      },
      "id": "text",
      "license": "text",
      "machine_documentation_url": "text",
      "metadata_modified_at": "2025-08-09T15:11:28.084Z",
      "metrics": {},
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "permissions": {
        "delete": true,
        "edit": true
      },
      "private": true,
      "rate_limiting": "text",
      "rate_limiting_url": "text",
      "self_api_url": "text",
      "self_web_url": "text",
      "slug": "text",
      "tags": [
        "text"
      ],
      "technical_documentation_url": "text",
      "title": "My awesome API"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

access_typestring · enumOptionnelExample: openValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumber · max: 100OptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

contact_pointsstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deleted_atstring · date-timeOptionnel

descriptionstringOptionnel

In markdown

extrasobjectOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

Réponses

201

Success

application/json

400

Validation error

post

POST /api/1/dataservices/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 674

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    "text"
  ],
  "datasets": [
    "text"
  ],
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "license": "text",
  "machine_documentation_url": "text",
  "organization": "text",
  "owner": "text",
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

{
  "access_audiences": [
    {
      "condition": "yes",
      "id": "text",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "created_at": "2025-08-09T15:11:28.084Z",
  "datasets": {},
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "harvest": {
    "archived_at": "2025-08-09T15:11:28.084Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2025-08-09T15:11:28.084Z",
    "domain": "text",
    "id": "text",
    "last_update": "2025-08-09T15:11:28.084Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2025-08-09T15:11:28.084Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

post

Paramètres de chemin

dataserviceanyRequis

The dataservice ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corpsobject[]

idstringRequis

Id of the dataset to add

Réponses

200

Success

application/json

400

Malformed object id(s) in request

403

Forbidden

404

Dataservice not found

410

Dataservice has been deleted

post

POST /api/1/dataservices/{dataservice}/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 15

[
  {
    "id": "text"
  }
]

{
  "access_audiences": [
    {
      "condition": "yes",
      "id": "text",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "created_at": "2025-08-09T15:11:28.084Z",
  "datasets": {},
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "harvest": {
    "archived_at": "2025-08-09T15:11:28.084Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2025-08-09T15:11:28.084Z",
    "domain": "text",
    "id": "text",
    "last_update": "2025-08-09T15:11:28.084Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2025-08-09T15:11:28.084Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

get

Paramètres de chemin

dataserviceanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/dataservices/{dataservice}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "access_audiences": [
    {
      "condition": "yes",
      "id": "text",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "created_at": "2025-08-09T15:11:28.084Z",
  "datasets": {},
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "harvest": {
    "archived_at": "2025-08-09T15:11:28.084Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2025-08-09T15:11:28.084Z",
    "domain": "text",
    "id": "text",
    "last_update": "2025-08-09T15:11:28.084Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2025-08-09T15:11:28.084Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

get

Paramètres de chemin

dataserviceanyRequis

The dataservice ID or slug

Réponses

404

Dataservice not found

410

Dataservice has been deleted

get

GET /api/1/dataservices/{dataservice}/rdf HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

get

Paramètres de chemin

dataserviceanyRequis

The dataservice ID or slug

formatanyRequis

Réponses

404

Dataservice not found

410

Dataservice has been deleted

get

GET /api/1/dataservices/{dataservice}/rdf.{format} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

List all followers for a given object

get

Paramètres de chemin

idanyRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

userstringOptionnel

Filter follower by user, it allows to check if a user is following the object

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/dataservices/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2025-08-09T15:11:28.084Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

delete

Paramètres de chemin

dataserviceanyRequis

Réponses

204

dataservice deleted

delete

DELETE /api/1/dataservices/{dataservice}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

204

dataservice deleted

Aucun contenu

patch

Paramètres de chemin

dataserviceanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

access_typestring · enumOptionnelExample: openValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumber · max: 100OptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

contact_pointsstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deleted_atstring · date-timeOptionnel

descriptionstringOptionnel

In markdown

extrasobjectOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

Réponses

200

Success

application/json

400

Validation error

patch

PATCH /api/1/dataservices/{dataservice}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 674

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    "text"
  ],
  "datasets": [
    "text"
  ],
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "license": "text",
  "machine_documentation_url": "text",
  "organization": "text",
  "owner": "text",
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

{
  "access_audiences": [
    {
      "condition": "yes",
      "id": "text",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "acronym": "text",
  "archived_at": "2025-08-09T15:11:28.084Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "created_at": "2025-08-09T15:11:28.084Z",
  "datasets": {},
  "deleted_at": "2025-08-09T15:11:28.084Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "harvest": {
    "archived_at": "2025-08-09T15:11:28.084Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2025-08-09T15:11:28.084Z",
    "domain": "text",
    "id": "text",
    "last_update": "2025-08-09T15:11:28.084Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2025-08-09T15:11:28.084Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

delete

Paramètres de chemin

dataserviceanyRequis

The dataservice ID or slug

datasetanyRequis

Réponses

404

Dataservice not found

delete

DELETE /api/1/dataservices/{dataservice}/datasets/{dataset}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

404

Dataservice not found

Aucun contenu

Follow an object given its ID

post

Returns the number of followers left after the operation

Paramètres de chemin

idanyRequis

Réponses

200

Success

post

POST /api/1/dataservices/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin

idanyRequis

Réponses

200

Success

delete

DELETE /api/1/dataservices/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

Précédentdatasets Suivantreuses

Mis à jour il y a 16 jours

Ce contenu vous a-t-il été utile ?