harvest

Harvest related operations

List all available harvest backends

GET//www.data.gouv.fr/api/1/harvest/backends

Header parameters

Response

200

Success

Body

application/json

featuresarray of HarvestFeature (object)

The backend optional features

filtersarray of HarvestFilter (object)

The backend supported filters

idstring

The backend identifier

labelstring

The backend display name

Request

JavaScriptCurl

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

Response

{
  "features": [
    {
      "default": "text",
      "description": "text",
      "key": "text",
      "label": "text"
    }
  ],
  "filters": [
    {
      "description": "text",
      "key": "text",
      "label": "text",
      "type": "text"
    }
  ],
  "id": "text",
  "label": "text"
}

List all jobs for a given source

GET//www.data.gouv.fr/api/1/harvest/job/{ident}/

Path parameters

ident*string

Query parameters

Header parameters

Response

200

Success

Body

application/json

created*string (date-time)

The job creation date

endedstring (date-time)

The job end date

errorsarray of HarvestError (object)

The job initialization errors

id*string

The job execution ID

itemsarray of HarvestItem (object)

The job collected items

source*string

The source owning the job

startedstring (date-time)

The job start date

status*enum

The job status

pendinginitializinginitializedprocessingdonedone-errorsfailed

Request

JavaScriptCurl

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

Response

{
  "created": "2024-05-09T05:23:43.337Z",
  "ended": "2024-05-09T05:23:43.337Z",
  "errors": [
    {
      "created_at": "2024-05-09T05:23:43.337Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2024-05-09T05:23:43.337Z",
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "ended": "2024-05-09T05:23:43.337Z",
      "errors": [
        {
          "created_at": "2024-05-09T05:23:43.337Z",
          "details": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2024-05-09T05:23:43.337Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2024-05-09T05:23:43.337Z",
  "status": "pending"
}

List all available harvesters

GET//www.data.gouv.fr/api/1/harvest/job_status

Response

200

Success

Body

application/json

itemsstring

Request

JavaScriptCurl

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

Response

[
  "text"
]

Preview an harvesting from a source created with the given payload

POST//www.data.gouv.fr/api/1/harvest/source/preview

Header parameters

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Response

200

Success

Body

application/json

created*string (date-time)

The job creation date

endedstring (date-time)

The job end date

errorsarray of HarvestError (object)

The job initialization errors

id*string

The job execution ID

itemsarray of HarvestItemPreview (object)

The job collected items

source*string

The source owning the job

startedstring (date-time)

The job start date

status*enum

The job status

pendinginitializinginitializedprocessingdonedone-errorsfailed

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/harvest/source/preview', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "autoarchive": true,
      "backend": "csw-dcat",
      "created_at": "2024-05-09T05:23:43.337Z",
      "name": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "created": "2024-05-09T05:23:43.337Z",
  "ended": "2024-05-09T05:23:43.337Z",
  "errors": [
    {
      "created_at": "2024-05-09T05:23:43.337Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2024-05-09T05:23:43.337Z",
      "dataset": {
        "acronym": "text",
        "archived": "2024-05-09T05:23:43.337Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2024-05-09T05:23:43.337Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T05:23:43.337Z",
              "modified_at": "2024-05-09T05:23:43.337Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T05:23:43.337Z",
              "last_modified_internal": "2024-05-09T05:23:43.337Z"
            },
            "last_modified": "2024-05-09T05:23:43.337Z",
            "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-09T05:23:43.337Z",
        "deleted": "2024-05-09T05:23:43.337Z",
        "description": "text",
        "featured": false,
        "frequency": "unknown",
        "frequency_date": "2024-05-09T05:23:43.337Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2024-05-09T05:23:43.337Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2024-05-09T05:23:43.337Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2024-05-09T05:23:43.337Z",
          "modified_at": "2024-05-09T05:23:43.337Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-05-09T05:23:43.337Z",
          "last_modified_internal": "2024-05-09T05:23:43.337Z"
        },
        "last_modified": "2024-05-09T05:23:43.337Z",
        "last_update": "2024-05-09T05:23:43.337Z",
        "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-09T05:23:43.337Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T05:23:43.337Z",
              "modified_at": "2024-05-09T05:23:43.337Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T05:23:43.337Z",
              "last_modified_internal": "2024-05-09T05:23:43.337Z"
            },
            "last_modified": "2024-05-09T05:23:43.337Z",
            "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-09T05:23:43.337Z",
          "start": "2024-05-09T05:23:43.337Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2024-05-09T05:23:43.337Z",
      "errors": [
        {
          "created_at": "2024-05-09T05:23:43.337Z",
          "details": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2024-05-09T05:23:43.337Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2024-05-09T05:23:43.337Z",
  "status": "pending"
}

Get a single source given an ID or a slug

GET//www.data.gouv.fr/api/1/harvest/source/{ident}

Path parameters

ident*string

A source ID or slug

Header parameters

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

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

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

Update a harvest source

PUT//www.data.gouv.fr/api/1/harvest/source/{ident}

Path parameters

ident*string

A source ID or slug

Header parameters

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/harvest/source/{ident}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "autoarchive": true,
      "backend": "csw-dcat",
      "created_at": "2024-05-09T05:23:43.337Z",
      "name": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

DELETE//www.data.gouv.fr/api/1/harvest/source/{ident}

Path parameters

ident*string

A source ID or slug

Header parameters

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

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

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

List all jobs for a given source

GET//www.data.gouv.fr/api/1/harvest/source/{ident}/jobs/

Path parameters

ident*string

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of HarvestJob (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/harvest/source/{ident}/jobs/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "created": "2024-05-09T05:23:43.337Z",
      "ended": "2024-05-09T05:23:43.337Z",
      "errors": [
        {
          "created_at": "2024-05-09T05:23:43.337Z",
          "details": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2024-05-09T05:23:43.337Z",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "ended": "2024-05-09T05:23:43.337Z",
          "errors": [
            {
              "created_at": "2024-05-09T05:23:43.337Z",
              "details": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2024-05-09T05:23:43.337Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2024-05-09T05:23:43.337Z",
      "status": "pending"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Preview a single harvest source given an ID or a slug

GET//www.data.gouv.fr/api/1/harvest/source/{ident}/preview

Path parameters

ident*string

A source ID or slug

Header parameters

Response

200

Success

Body

application/json

created*string (date-time)

The job creation date

endedstring (date-time)

The job end date

errorsarray of HarvestError (object)

The job initialization errors

id*string

The job execution ID

itemsarray of HarvestItemPreview (object)

The job collected items

source*string

The source owning the job

startedstring (date-time)

The job start date

status*enum

The job status

pendinginitializinginitializedprocessingdonedone-errorsfailed

Request

JavaScriptCurl

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

Response

{
  "created": "2024-05-09T05:23:43.337Z",
  "ended": "2024-05-09T05:23:43.337Z",
  "errors": [
    {
      "created_at": "2024-05-09T05:23:43.337Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2024-05-09T05:23:43.337Z",
      "dataset": {
        "acronym": "text",
        "archived": "2024-05-09T05:23:43.337Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2024-05-09T05:23:43.337Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T05:23:43.337Z",
              "modified_at": "2024-05-09T05:23:43.337Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T05:23:43.337Z",
              "last_modified_internal": "2024-05-09T05:23:43.337Z"
            },
            "last_modified": "2024-05-09T05:23:43.337Z",
            "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-09T05:23:43.337Z",
        "deleted": "2024-05-09T05:23:43.337Z",
        "description": "text",
        "featured": false,
        "frequency": "unknown",
        "frequency_date": "2024-05-09T05:23:43.337Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2024-05-09T05:23:43.337Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2024-05-09T05:23:43.337Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2024-05-09T05:23:43.337Z",
          "modified_at": "2024-05-09T05:23:43.337Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-05-09T05:23:43.337Z",
          "last_modified_internal": "2024-05-09T05:23:43.337Z"
        },
        "last_modified": "2024-05-09T05:23:43.337Z",
        "last_update": "2024-05-09T05:23:43.337Z",
        "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-09T05:23:43.337Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T05:23:43.337Z",
              "modified_at": "2024-05-09T05:23:43.337Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T05:23:43.337Z",
              "last_modified_internal": "2024-05-09T05:23:43.337Z"
            },
            "last_modified": "2024-05-09T05:23:43.337Z",
            "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-09T05:23:43.337Z",
          "start": "2024-05-09T05:23:43.337Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2024-05-09T05:23:43.337Z",
      "errors": [
        {
          "created_at": "2024-05-09T05:23:43.337Z",
          "details": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2024-05-09T05:23:43.337Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2024-05-09T05:23:43.337Z",
  "status": "pending"
}

Schedule an harvest source

POST//www.data.gouv.fr/api/1/harvest/source/{ident}/schedule

Path parameters

ident*string

A source ID or slug

Header parameters

Body

application/json

A cron expression

string

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

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

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

Unschedule an harvest source

DELETE//www.data.gouv.fr/api/1/harvest/source/{ident}/schedule

Path parameters

ident*string

A source ID or slug

Header parameters

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

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

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

Validate or reject an harvest source

POST//www.data.gouv.fr/api/1/harvest/source/{ident}/validate

Path parameters

ident*string

A source ID or slug

Header parameters

Body

application/json

byall of

Who performed the validation

commentstring

A comment about the validation. Required on rejection

onstring (date-time)

Date date on which validation was performed

state*enum

Is it validated or not

pendingacceptedrefused

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/harvest/source/{ident}/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "state": "pending"
    }),
});
const data = await response.json();

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}

List all harvest sources

GET//www.data.gouv.fr/api/1/harvest/sources/

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of HarvestSource (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/harvest/sources/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "data": [
      {
        "active": false,
        "autoarchive": true,
        "backend": "csw-dcat",
        "created_at": "2024-05-09T05:23:43.337Z",
        "deleted": "2024-05-09T05:23:43.337Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2024-05-09T05:23:43.337Z",
          "ended": "2024-05-09T05:23:43.337Z",
          "errors": [
            {
              "created_at": "2024-05-09T05:23:43.337Z",
              "details": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": [
            {
              "args": [
                "text"
              ],
              "created": "2024-05-09T05:23:43.337Z",
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "text"
              },
              "ended": "2024-05-09T05:23:43.337Z",
              "errors": [
                {
                  "created_at": "2024-05-09T05:23:43.337Z",
                  "details": "text",
                  "message": "text"
                }
              ],
              "remote_id": "text",
              "started": "2024-05-09T05:23:43.337Z",
              "status": "pending"
            }
          ],
          "source": "text",
          "started": "2024-05-09T05:23:43.337Z",
          "status": "pending"
        },
        "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"
        },
        "schedule": "text",
        "url": "text",
        "validation": {
          "by": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "comment": "text",
          "on": "2024-05-09T05:23:43.337Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "previous_page": "text"
  }
]

Create a new harvest source

POST//www.data.gouv.fr/api/1/harvest/sources/

Header parameters

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Response

200

Success

Body

application/json

active*boolean

Is this source active

autoarchive*boolean

If enabled, datasets not present on the remote source will be automatically archived

backend*enum

The source backend

csw-dcatcsw-iso-19139dcatckandkanmaaf

configobject

The configuration as key-value pairs

created_at*string (date-time)

The source creation date

deletedstring (date-time)

The source deletion date

descriptionstring (markdown)

The source description

idstring

The source unique identifier

last_joball of

The last job for this source

name*string

The source display name

organizationall of

The producer organization

ownerall of

The owner information

schedulestring

The source schedule (interval or cron expression)

url*string

The source base URL

validationall of

Has the source been validated

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/harvest/sources/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "autoarchive": true,
      "backend": "csw-dcat",
      "created_at": "2024-05-09T05:23:43.337Z",
      "name": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "created_at": "2024-05-09T05:23:43.337Z",
  "deleted": "2024-05-09T05:23:43.337Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2024-05-09T05:23:43.337Z",
    "ended": "2024-05-09T05:23:43.337Z",
    "errors": [
      {
        "created_at": "2024-05-09T05:23:43.337Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2024-05-09T05:23:43.337Z",
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2024-05-09T05:23:43.337Z",
        "errors": [
          {
            "created_at": "2024-05-09T05:23:43.337Z",
            "details": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2024-05-09T05:23:43.337Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2024-05-09T05:23:43.337Z",
    "status": "pending"
  },
  "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"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2024-05-09T05:23:43.337Z",
    "state": "pending"
  }
}