harvest

Harvest related operations

List all available harvest backends

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

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

200

Success

{
  "extra_configs": [
    {
      "default": "text",
      "description": "text",
      "key": "text",
      "label": "text"
    }
  ],
  "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

Paramètres de chemin

identanyRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/harvest/job/{ident}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "created": "2025-07-20T22:32:02.157Z",
  "ended": "2025-07-20T22:32:02.157Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-07-20T22:32:02.157Z",
      "dataservice": {
        "class": "text",
        "id": "text",
        "self_web_url": "text",
        "title": "My awesome API"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-07-20T22:32:02.157Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-07-20T22:32:02.157Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-07-20T22:32:02.157Z",
  "status": "pending"
}

List all available harvesters

get

Réponses

200

Success

application/json

Réponsestring[]

get

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

200

Success

[
  "text"
]

Preview an harvesting from a source created with the given payload

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

activebooleanRequis

Is this source active

Default: false

autoarchivebooleanRequis

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

Default: true

backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:

configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses

200

Success

application/json

post

POST /api/1/harvest/source/preview HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text"
  },
  "url": "text"
}

200

Success

{
  "created": "2025-07-20T22:32:02.157Z",
  "ended": "2025-07-20T22:32:02.157Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-07-20T22:32:02.157Z",
      "dataservice": {
        "self_api_url": {},
        "self_web_url": {},
        "title": "My awesome API"
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-07-20T22:32:02.157Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-07-20T22:32:02.157Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-07-20T22:32:02.157Z",
              "modified_at": "2025-07-20T22:32:02.157Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-07-20T22:32:02.157Z",
              "last_modified_internal": "2025-07-20T22:32:02.157Z"
            },
            "last_modified": "2025-07-20T22:32:02.157Z",
            "latest": "text",
            "metrics": {},
            "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"
            },
            "permissions": {
              "delete": true,
              "edit": true,
              "edit_resources": true
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-07-20T22:32:02.157Z",
        "deleted": "2025-07-20T22:32:02.157Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-07-20T22:32:02.157Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-07-20T22:32:02.157Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-07-20T22:32:02.157Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-07-20T22:32:02.157Z",
          "modified_at": "2025-07-20T22:32:02.157Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-07-20T22:32:02.157Z",
          "last_modified_internal": "2025-07-20T22:32:02.157Z"
        },
        "last_modified": "2025-07-20T22:32:02.157Z",
        "last_update": "2025-07-20T22:32:02.157Z",
        "license": "notspecified",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "page": {},
        "permissions": {
          "delete": true,
          "edit": true,
          "edit_resources": true
        },
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-07-20T22:32:02.157Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-07-20T22:32:02.157Z",
              "modified_at": "2025-07-20T22:32:02.157Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-07-20T22:32:02.157Z",
              "last_modified_internal": "2025-07-20T22:32:02.157Z"
            },
            "last_modified": "2025-07-20T22:32:02.157Z",
            "latest": "text",
            "metrics": {},
            "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": {}
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-07-20T22:32:02.157Z",
          "start": "2025-07-20T22:32:02.157Z"
        },
        "title": "text",
        "uri": {}
      },
      "ended": "2025-07-20T22:32:02.157Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-07-20T22:32:02.157Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-07-20T22:32:02.157Z",
  "status": "pending"
}

Get a single source given an ID or a slug

get

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

Update a harvest source

put

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

activebooleanRequis

Is this source active

Default: false

autoarchivebooleanRequis

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

Default: true

backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:

configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses

200

Success

application/json

put

PUT /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text"
  },
  "url": "text"
}

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

delete

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

delete

DELETE /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

List all jobs for a given source

get

Paramètres de chemin

identanyRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/harvest/source/{ident}/jobs/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "created": "2025-07-20T22:32:02.157Z",
      "ended": "2025-07-20T22:32:02.157Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2025-07-20T22:32:02.157Z",
          "dataservice": {
            "class": "text",
            "id": "text",
            "self_web_url": "text",
            "title": "My awesome API"
          },
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "ended": "2025-07-20T22:32:02.157Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "kwargs": {},
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2025-07-20T22:32:02.157Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2025-07-20T22:32:02.157Z",
      "status": "pending"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Preview a single harvest source given an ID or a slug

get

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/harvest/source/{ident}/preview HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "created": "2025-07-20T22:32:02.157Z",
  "ended": "2025-07-20T22:32:02.157Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-07-20T22:32:02.157Z",
      "dataservice": {
        "self_api_url": {},
        "self_web_url": {},
        "title": "My awesome API"
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-07-20T22:32:02.157Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-07-20T22:32:02.157Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-07-20T22:32:02.157Z",
              "modified_at": "2025-07-20T22:32:02.157Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-07-20T22:32:02.157Z",
              "last_modified_internal": "2025-07-20T22:32:02.157Z"
            },
            "last_modified": "2025-07-20T22:32:02.157Z",
            "latest": "text",
            "metrics": {},
            "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"
            },
            "permissions": {
              "delete": true,
              "edit": true,
              "edit_resources": true
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-07-20T22:32:02.157Z",
        "deleted": "2025-07-20T22:32:02.157Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-07-20T22:32:02.157Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-07-20T22:32:02.157Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-07-20T22:32:02.157Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-07-20T22:32:02.157Z",
          "modified_at": "2025-07-20T22:32:02.157Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-07-20T22:32:02.157Z",
          "last_modified_internal": "2025-07-20T22:32:02.157Z"
        },
        "last_modified": "2025-07-20T22:32:02.157Z",
        "last_update": "2025-07-20T22:32:02.157Z",
        "license": "notspecified",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "page": {},
        "permissions": {
          "delete": true,
          "edit": true,
          "edit_resources": true
        },
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-07-20T22:32:02.157Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-07-20T22:32:02.157Z",
              "modified_at": "2025-07-20T22:32:02.157Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-07-20T22:32:02.157Z",
              "last_modified_internal": "2025-07-20T22:32:02.157Z"
            },
            "last_modified": "2025-07-20T22:32:02.157Z",
            "latest": "text",
            "metrics": {},
            "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": {}
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-07-20T22:32:02.157Z",
          "start": "2025-07-20T22:32:02.157Z"
        },
        "title": "text",
        "uri": {}
      },
      "ended": "2025-07-20T22:32:02.157Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-07-20T22:32:02.157Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-07-20T22:32:02.157Z",
  "status": "pending"
}

Schedule an harvest source

post

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

stringOptionnel

Réponses

200

Success

application/json

post

POST /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

Unschedule an harvest source

delete

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

delete

DELETE /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

Validate or reject an harvest source

post

Paramètres de chemin

identanyRequis

A source ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

byall ofLecture seuleOptionnel

Who performed the validation

commentstringOptionnel

A comment about the validation. Required on rejection

onstring · date-timeLecture seuleOptionnel

Date date on which validation was performed

statestring · enumRequis

Is it validated or not

Example: pendingValeurs possibles:

Réponses

200

Success

application/json

post

POST /api/1/harvest/source/{ident}/validate HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "comment": "text",
  "state": "pending"
}

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

List all harvest sources

get

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

ownerstringOptionnel

The organization or user ID to filter on

deletedbooleanOptionnel

Include sources flaggued as deleted

qstringOptionnel

The search query

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

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

200

Success

[
  {
    "data": [
      {
        "active": false,
        "autoarchive": true,
        "backend": "csw-dcat",
        "config": {},
        "created_at": "2025-07-20T22:32:02.157Z",
        "deleted": "2025-07-20T22:32:02.157Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2025-07-20T22:32:02.157Z",
          "ended": "2025-07-20T22:32:02.157Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": [
            {
              "args": [
                "text"
              ],
              "created": "2025-07-20T22:32:02.157Z",
              "dataservice": {
                "class": "text",
                "id": "text",
                "self_web_url": "text",
                "title": "My awesome API"
              },
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "text"
              },
              "ended": "2025-07-20T22:32:02.157Z",
              "errors": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "kwargs": {},
              "logs": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "remote_id": "text",
              "started": "2025-07-20T22:32:02.157Z",
              "status": "pending"
            }
          ],
          "source": "text",
          "started": "2025-07-20T22:32:02.157Z",
          "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": "2025-07-20T22:32:02.157Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1
  }
]

Create a new harvest source

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

activebooleanRequis

Is this source active

Default: false

autoarchivebooleanRequis

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

Default: true

backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:

configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses

200

Success

application/json

post

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

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text"
  },
  "url": "text"
}

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-07-20T22:32:02.157Z",
  "deleted": "2025-07-20T22:32:02.157Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-07-20T22:32:02.157Z",
    "ended": "2025-07-20T22:32:02.157Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-07-20T22:32:02.157Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-07-20T22:32:02.157Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-07-20T22:32:02.157Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-07-20T22:32:02.157Z",
    "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": "2025-07-20T22:32:02.157Z",
    "state": "pending"
  }
}

Précédentavatars SuivantGuides open data

Dernière mise à jour il y a 2 ans

Cet article vous a-t-il été utile ?