datasets

Dataset related operations

List or search all datasets

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

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of Dataset (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

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "acronym": "text",
      "archived": "2024-09-15T09:33:11.915Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-09-15T09:33:11.915Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-09-15T09:33:11.915Z",
            "modified_at": "2024-09-15T09:33:11.915Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:11.915Z",
            "last_modified_internal": "2024-09-15T09:33:11.915Z"
          },
          "last_modified": "2024-09-15T09:33:11.915Z",
          "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-09-15T09:33:11.915Z",
      "deleted": "2024-09-15T09:33:11.915Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-09-15T09:33:11.915Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-09-15T09:33:11.915Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-09-15T09:33:11.915Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-09-15T09:33:11.915Z",
        "modified_at": "2024-09-15T09:33:11.915Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-09-15T09:33:11.915Z",
        "last_modified_internal": "2024-09-15T09:33:11.915Z"
      },
      "last_modified": "2024-09-15T09:33:11.915Z",
      "last_update": "2024-09-15T09:33:11.915Z",
      "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-09-15T09:33:11.915Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-09-15T09:33:11.915Z",
            "modified_at": "2024-09-15T09:33:11.915Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:11.915Z",
            "last_modified_internal": "2024-09-15T09:33:11.915Z"
          },
          "last_modified": "2024-09-15T09:33:11.915Z",
          "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-09-15T09:33:11.915Z",
        "start": "2024-09-15T09:33:11.915Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Create a new dataset

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

Header parameters

Body

application/json

acronymstring

An optional dataset acronym

archivedstring (date-time)

The archival date if archived

badgesarray of Badge (object)

The dataset badges

community_resourcesarray of all of

contact_pointall of

The dataset's contact points

created_at*string (date-time)

This date is computed between harvested creation date if any and site's internal creation date

deletedstring (date-time)

The deletion date if deleted

description*string (markdown)

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency*enum

The update frequency

Example: "unknown"

unknownpunctualcontinuoushourlyfourTimesADaythreeTimesADaysemidailydailyfourTimesAWeekthreeTimesAWeeksemiweeklyweeklybiweeklythreeTimesAMonthsemimonthlymonthlybimonthlyquarterlythreeTimesAYearsemiannualannualbiennialtriennialquinquennialirregular

frequency_datestring (date-time)

Next expected update date, you will be notified once that date is reached.

harvestall of

Dataset harvest metadata attributes

idstring

The dataset identifier

internalall of

Site internal and specific object's data

last_modified*string (date-time)

The dataset last modification date

last_update*string (date-time)

The resources last modification date

licensestring

The dataset license

metricsobject

The dataset metrics

organizationall of

The producer organization

ownerall of

The user information

page*string

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

resourcesarray of all of

schemaall of

Reference to the associated schema

slug*string

The dataset permalink string

spatialall of

The spatial coverage

tagsarray of string

temporal_coverageall of

The temporal coverage

title*string

The dataset title

uri*string

The dataset API URI

Response

201400

Success

Body

application/json

acronymstring

An optional dataset acronym

archivedstring (date-time)

The archival date if archived

badgesarray of Badge (object)

The dataset badges

community_resourcesarray of all of

contact_pointall of

The dataset's contact points

created_at*string (date-time)

This date is computed between harvested creation date if any and site's internal creation date

deletedstring (date-time)

The deletion date if deleted

description*string (markdown)

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency*enum

The update frequency

Example: "unknown"

unknownpunctualcontinuoushourlyfourTimesADaythreeTimesADaysemidailydailyfourTimesAWeekthreeTimesAWeeksemiweeklyweeklybiweeklythreeTimesAMonthsemimonthlymonthlybimonthlyquarterlythreeTimesAYearsemiannualannualbiennialtriennialquinquennialirregular

frequency_datestring (date-time)

Next expected update date, you will be notified once that date is reached.

harvestall of

Dataset harvest metadata attributes

idstring

The dataset identifier

internalall of

Site internal and specific object's data

last_modified*string (date-time)

The dataset last modification date

last_update*string (date-time)

The resources last modification date

licensestring

The dataset license

metricsobject

The dataset metrics

organizationall of

The producer organization

ownerall of

The user information

page*string

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

resourcesarray of all of

schemaall of

Reference to the associated schema

slug*string

The dataset permalink string

spatialall of

The spatial coverage

tagsarray of string

temporal_coverageall of

The temporal coverage

title*string

The dataset title

uri*string

The dataset API URI

Request

JavaScriptCurlPython

const response = await fetch('//www.data.gouv.fr/api/1/datasets/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "created_at": "2024-09-15T09:33:11.915Z",
      "description": "text",
      "frequency": "unknown",
      "last_modified": "2024-09-15T09:33:11.915Z",
      "last_update": "2024-09-15T09:33:11.915Z",
      "page": "text",
      "slug": "text",
      "title": "text",
      "uri": "text"
    }),
});
const data = await response.json();

Response

201

{
  "acronym": "text",
  "archived": "2024-09-15T09:33:11.915Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2024-09-15T09:33:11.915Z",
      "description": "text",
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2024-09-15T09:33:11.915Z",
        "modified_at": "2024-09-15T09:33:11.915Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-09-15T09:33:11.915Z",
        "last_modified_internal": "2024-09-15T09:33:11.915Z"
      },
      "last_modified": "2024-09-15T09:33:11.915Z",
      "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-09-15T09:33:11.915Z",
  "deleted": "2024-09-15T09:33:11.915Z",
  "description": "text",
  "featured": false,
  "frequency": "unknown",
  "frequency_date": "2024-09-15T09:33:11.915Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2024-09-15T09:33:11.915Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2024-09-15T09:33:11.915Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2024-09-15T09:33:11.915Z",
    "modified_at": "2024-09-15T09:33:11.915Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2024-09-15T09:33:11.915Z",
    "last_modified_internal": "2024-09-15T09:33:11.915Z"
  },
  "last_modified": "2024-09-15T09:33:11.915Z",
  "last_update": "2024-09-15T09:33:11.915Z",
  "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-09-15T09:33:11.915Z",
      "description": "text",
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2024-09-15T09:33:11.915Z",
        "modified_at": "2024-09-15T09:33:11.915Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-09-15T09:33:11.915Z",
        "last_modified_internal": "2024-09-15T09:33:11.915Z"
      },
      "last_modified": "2024-09-15T09:33:11.915Z",
      "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-09-15T09:33:11.915Z",
    "start": "2024-09-15T09:33:11.915Z"
  },
  "title": "text",
  "uri": "text"
}

List all available dataset badges and their labels

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

Response

200

Success

Request

JavaScriptCurlPython

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

List all community resources

GET//www.data.gouv.fr/api/1/datasets/community_resources/

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of CommunityResource (all of)

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

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2024-09-15T09:33:11.915Z",
      "description": "text",
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2024-09-15T09:33:11.915Z",
        "modified_at": "2024-09-15T09:33:11.915Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-09-15T09:33:11.915Z",
        "last_modified_internal": "2024-09-15T09:33:11.915Z"
      },
      "last_modified": "2024-09-15T09:33:11.915Z",
      "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"
      }
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Create a new community resource

POST//www.data.gouv.fr/api/1/datasets/community_resources/

Header parameters

Body

application/json

checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"

fileremote

format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall of

Reference to the associated schema

title*string

The resource title

type*enum

Resource type (documentation, API...)

Example: "main"

maindocumentationupdateapicodeother

url*string

The resource URL

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Response

201400

Success

Body

application/json

checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"

fileremote

format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall of

Reference to the associated schema

title*string

The resource title

type*enum

Resource type (documentation, API...)

Example: "main"

maindocumentationupdateapicodeother

url*string

The resource URL

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Request

JavaScriptCurlPython

const response = await fetch('//www.data.gouv.fr/api/1/datasets/community_resources/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filetype": "file",
      "format": "text",
      "title": "text",
      "type": "main",
      "url": "text"
    }),
});
const data = await response.json();

Response

201

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2024-09-15T09:33:11.915Z",
  "description": "text",
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2024-09-15T09:33:11.915Z",
    "modified_at": "2024-09-15T09:33:11.915Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2024-09-15T09:33:11.915Z",
    "last_modified_internal": "2024-09-15T09:33:11.915Z"
  },
  "last_modified": "2024-09-15T09:33:11.915Z",
  "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"
  }
}

Retrieve a community resource given its identifier

GET//www.data.gouv.fr/api/1/datasets/community_resources/{community}/

Path parameters

community*string

The community resource unique identifier

Query parameters

Header parameters

Response

200

Success

Body

application/json

checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"

fileremote

format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall of

Reference to the associated schema

title*string

The resource title

type*enum

Resource type (documentation, API...)

Example: "main"

maindocumentationupdateapicodeother

url*string

The resource URL

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Request

JavaScriptCurlPython

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

Response

200

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2024-09-15T09:33:11.915Z",
  "description": "text",
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2024-09-15T09:33:11.915Z",
    "modified_at": "2024-09-15T09:33:11.915Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2024-09-15T09:33:11.915Z",
    "last_modified_internal": "2024-09-15T09:33:11.915Z"
  },
  "last_modified": "2024-09-15T09:33:11.915Z",
  "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"
  }
}

Update a given community resource

PUT//www.data.gouv.fr/api/1/datasets/community_resources/{community}/

Path parameters

community*string

The community resource unique identifier

Query parameters

Header parameters

Body

application/json

checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"

fileremote

format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall of

Reference to the associated schema

title*string

The resource title

type*enum

Resource type (documentation, API...)

Example: "main"

maindocumentationupdateapicodeother

url*string

The resource URL

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Response

200400

Success

Body

application/json

checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"

fileremote

format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics