reuses

Reuse related operations

GET//www.data.gouv.fr/api/1/reuses/

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of Reuse (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "badges": [
        {
          "kind": "text"
        }
      ],
      "created_at": "2024-05-09T15:04:42.582Z",
      "datasets": [
        {
          "acronym": "text",
          "archived": "2024-05-09T15:04:42.582Z",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "community_resources": [
            {
              "checksum": {
                "type": "sha1",
                "value": "text"
              },
              "created_at": "2024-05-09T15:04:42.582Z",
              "description": "text",
              "filetype": "file",
              "format": "text",
              "harvest": {
                "created_at": "2024-05-09T15:04:42.582Z",
                "modified_at": "2024-05-09T15:04:42.582Z",
                "uri": "text"
              },
              "id": "text",
              "internal": {
                "created_at_internal": "2024-05-09T15:04:42.582Z",
                "last_modified_internal": "2024-05-09T15:04:42.582Z"
              },
              "last_modified": "2024-05-09T15:04:42.582Z",
              "latest": "text",
              "mime": "text",
              "preview_url": "text",
              "schema": {
                "name": "text",
                "url": "text",
                "version": "text"
              },
              "title": "text",
              "type": "main",
              "url": "text",
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "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"
              }
            }
          ],
          "contact_point": {
            "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"
            }
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "deleted": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "featured": false,
          "frequency": "unknown",
          "frequency_date": "2024-05-09T15:04:42.582Z",
          "harvest": {
            "archived": "text",
            "archived_at": "2024-05-09T15:04:42.582Z",
            "backend": "text",
            "ckan_name": "text",
            "ckan_source": "text",
            "created_at": "2024-05-09T15:04:42.582Z",
            "dct_identifier": "text",
            "domain": "text",
            "last_update": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "last_update": "2024-05-09T15:04:42.582Z",
          "license": "notspecified",
          "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"
          },
          "page": "text",
          "private": false,
          "resources": [
            {
              "checksum": {
                "type": "sha1",
                "value": "text"
              },
              "created_at": "2024-05-09T15:04:42.582Z",
              "description": "text",
              "filetype": "file",
              "format": "text",
              "harvest": {
                "created_at": "2024-05-09T15:04:42.582Z",
                "modified_at": "2024-05-09T15:04:42.582Z",
                "uri": "text"
              },
              "id": "text",
              "internal": {
                "created_at_internal": "2024-05-09T15:04:42.582Z",
                "last_modified_internal": "2024-05-09T15:04:42.582Z"
              },
              "last_modified": "2024-05-09T15:04:42.582Z",
              "latest": "text",
              "mime": "text",
              "preview_url": "text",
              "schema": {
                "name": "text",
                "url": "text",
                "version": "text"
              },
              "title": "text",
              "type": "main",
              "url": "text"
            }
          ],
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "slug": "text",
          "spatial": {
            "geom": {
              "coordinates": [],
              "type": "Point"
            },
            "granularity": "other",
            "zones": [
              "text"
            ]
          },
          "tags": [
            "text"
          ],
          "temporal_coverage": {
            "end": "2024-05-09T15:04:42.582Z",
            "start": "2024-05-09T15:04:42.582Z"
          },
          "title": "text",
          "uri": "text"
        }
      ],
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "id": "text",
      "image": "text",
      "image_thumbnail": "text",
      "last_modified": "2024-05-09T15:04:42.582Z",
      "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"
      },
      "page": "text",
      "private": false,
      "slug": "text",
      "tags": [
        "text"
      ],
      "title": "text",
      "topic": "health",
      "type": "api",
      "uri": "text",
      "url": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Create a new object

POST//www.data.gouv.fr/api/1/reuses/

Header parameters

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Response

200400

Success

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "title": "text",
      "topic": "health",
      "type": "api",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

List all available reuse badges and their labels

GET//www.data.gouv.fr/api/1/reuses/badges/

Response

200

Success

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/badges/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Reuses suggest endpoint using mongoDB contains

GET//www.data.gouv.fr/api/1/reuses/suggest/

Query parameters

Header parameters

Response

200

Success

Body

application/json

idstring

The reuse identifier

image_urlstring

The reuse thumbnail URL

pagestring

The reuse page URL

slugstring

The reuse permalink string

titlestring

The reuse title

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/suggest/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "image_url": "text",
    "page": "text",
    "slug": "text",
    "title": "text"
  }
]

List all reuse topics

GET//www.data.gouv.fr/api/1/reuses/topics/

Header parameters

Response

200

Success

Body

application/json

idstring

The reuse topic identifier

labelstring

The reuse topic display name

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/topics/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "label": "text"
  }
]

List all reuse types

GET//www.data.gouv.fr/api/1/reuses/types/

Header parameters

Response

200

Success

Body

application/json

idstring

The reuse type identifier

labelstring

The reuse type display name

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/types/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "label": "text"
  }
]

List all followers for a given object

GET//www.data.gouv.fr/api/1/reuses/{id}/followers/

Path parameters

id*string

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of Follow (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{id}/followers/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "2024-05-09T15:04:42.582Z"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Follow an object given its ID

Returns the number of followers left after the operation

POST//www.data.gouv.fr/api/1/reuses/{id}/followers/

Path parameters

id*string

Response

200

Success

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{id}/followers/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Unfollow an object given its ID

Returns the number of followers left after the operation

DELETE//www.data.gouv.fr/api/1/reuses/{id}/followers/

Path parameters

id*string

Response

200

Success

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{id}/followers/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Fetch a given reuse

GET//www.data.gouv.fr/api/1/reuses/{reuse}/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Response

200404410

Success

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

Update a given reuse

PUT//www.data.gouv.fr/api/1/reuses/{reuse}/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Response

200400404410

Success

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "title": "text",
      "topic": "health",
      "type": "api",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

Delete a given reuse

DELETE//www.data.gouv.fr/api/1/reuses/{reuse}/

Path parameters

reuse*string

The reuse ID or slug

Response

204404410

Reuse deleted

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create a new badge for a given reuse

POST//www.data.gouv.fr/api/1/reuses/{reuse}/badges/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Body

application/json

kind*string

Kind of badge (certified, etc), specific to each model

Response

200

Success

Body

application/json

kind*string

Kind of badge (certified, etc), specific to each model

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/badges/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "kind": "text"
    }),
});
const data = await response.json();

Response

{
  "kind": "text"
}

Delete a badge for a given reuse

DELETE//www.data.gouv.fr/api/1/reuses/{reuse}/badges/{badge_kind}/

Path parameters

badge_kind*string

reuse*string

The reuse ID or slug

Response

200

Success

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/badges/{badge_kind}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add a dataset to a given reuse

POST//www.data.gouv.fr/api/1/reuses/{reuse}/datasets/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Body

application/json

class*string

The object class

id*string

The object unique identifier

acronymstring

An optional dataset acronym

pagestring

The web page URL for this dataset

titlestring

The dataset title

uristring

The API URI for this dataset

Response

200201

The dataset is already present

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/datasets/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "class": "text",
      "id": "text"
    }),
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

Mark a reuse as featured

POST//www.data.gouv.fr/api/1/reuses/{reuse}/featured/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Response

200

Success

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/featured/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

Unmark a reuse as featured

DELETE//www.data.gouv.fr/api/1/reuses/{reuse}/featured/

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Response

200

Success

Body

application/json

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/featured/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-05-09T15:04:42.582Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-05-09T15:04:42.582Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "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"
          }
        }
      ],
      "contact_point": {
        "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"
        }
      },
      "created_at": "2024-05-09T15:04:42.582Z",
      "deleted": "2024-05-09T15:04:42.582Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T15:04:42.582Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T15:04:42.582Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T15:04:42.582Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T15:04:42.582Z",
        "modified_at": "2024-05-09T15:04:42.582Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T15:04:42.582Z",
        "last_modified_internal": "2024-05-09T15:04:42.582Z"
      },
      "last_modified": "2024-05-09T15:04:42.582Z",
      "last_update": "2024-05-09T15:04:42.582Z",
      "license": "notspecified",
      "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"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T15:04:42.582Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T15:04:42.582Z",
            "modified_at": "2024-05-09T15:04:42.582Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T15:04:42.582Z",
            "last_modified_internal": "2024-05-09T15:04:42.582Z"
          },
          "last_modified": "2024-05-09T15:04:42.582Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T15:04:42.582Z",
        "start": "2024-05-09T15:04:42.582Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-05-09T15:04:42.582Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-05-09T15:04:42.582Z",
  "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"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

Upload a new reuse image

POST//www.data.gouv.fr/api/1/reuses/{reuse}/image

Path parameters

reuse*string

The reuse ID or slug

Header parameters

Body

multipart/form-data

filestring (binary)

bboxstring

Response

200

Success

Body

application/json

imagestring

successboolean

Whether the upload succeeded or not.

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/image', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "image": "text",
  "success": true
}