harvest
Harvest related operations
The page to fetch
The page size to fetch
An optional fields mask
Success
GET /api/1/harvest/job/{ident}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
Success
{
"created": "2025-08-12T20:52:31.142Z",
"ended": "2025-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-08-12T20:52:31.142Z",
"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-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-08-12T20:52:31.142Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-08-12T20:52:31.142Z",
"status": "pending"
}
The page to fetch
The page size to fetch
The organization or user ID to filter on
Include sources flaggued as deleted
The search query
An optional fields mask
Success
GET /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
Success
[
{
"data": [
{
"active": false,
"autoarchive": true,
"backend": "ckan",
"config": {},
"created_at": "2025-08-12T20:52:31.142Z",
"deleted": "2025-08-12T20:52:31.142Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-08-12T20:52:31.142Z",
"ended": "2025-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-08-12T20:52:31.142Z",
"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-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-08-12T20:52:31.142Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-08-12T20:52:31.142Z",
"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-08-12T20:52:31.142Z",
"state": "pending"
}
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}
]
An optional fields mask
Is this source active
false
If enabled, datasets not present on the remote source will be automatically archived
true
The source backend
ckan
Valeurs possibles: The configuration as key-value pairs
The source creation date
The source deletion date
The source description
The source unique identifier
The last job for this source
The source display name
The producer organization
The owner information
The source schedule (interval or cron expression)
The source base URL
Has the source been validated
Success
POST /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 318
{
"active": false,
"autoarchive": true,
"backend": "ckan",
"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"
}
Success
{
"active": false,
"autoarchive": true,
"backend": "ckan",
"config": {},
"created_at": "2025-08-12T20:52:31.142Z",
"deleted": "2025-08-12T20:52:31.142Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-08-12T20:52:31.142Z",
"ended": "2025-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-08-12T20:52:31.142Z",
"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-08-12T20:52:31.142Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-08-12T20:52:31.142Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-08-12T20:52:31.142Z",
"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-08-12T20:52:31.142Z",
"state": "pending"
}
}
Mis à jour
Ce contenu vous a-t-il été utile ?