harvest

Harvest related operations

List all available harvest backends

get

/harvest/backends

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/backends'

200

200

{
  "id": "text",
  "label": "text",
  "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"
    }
  ]
}

Success

List all jobs for a given source

get

/harvest/job/{ident}//

Path parameters

identstringrequired

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/job/{ident}/'

200

200

{
  "created": "2025-02-20T19:08:10.903Z",
  "ended": "2025-02-20T19:08:10.903Z",
  "id": "text",
  "source": "text",
  "started": "2025-02-20T19:08:10.903Z",
  "status": "pending",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "items": [
    {
      "created": "2025-02-20T19:08:10.903Z",
      "ended": "2025-02-20T19:08:10.903Z",
      "remote_id": "text",
      "started": "2025-02-20T19:08:10.903Z",
      "status": "pending",
      "kwargs": {},
      "args": [],
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "dataservice": {
        "acronym": "text",
        "archived_at": "2025-02-20T19:08:10.903Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "created_at": "2025-02-20T19:08:10.903Z",
        "datasets": {},
        "deleted_at": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "endpoint_description_url": "text",
        "extras": {},
        "has_token": true,
        "id": "text",
        "is_restricted": true,
        "license": "text",
        "metadata_modified_at": "2025-02-20T19:08:10.903Z",
        "metrics": {},
        "private": true,
        "rate_limiting": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "title": "My awesome API",
        "format": "REST",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived_at": "2025-02-20T19:08:10.903Z",
          "backend": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      }
    }
  ]
}

Success

List all available harvesters

get

/harvest/job_status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/job_status'

200

200

[
  "text"
]

Success

Preview an harvesting from a source created with the given payload

post

/harvest/source/preview

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

activebooleanrequired

Is this source active

autoarchiveboolean · default: truerequired

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

configobject

The configuration as key-value pairs

created_atstring · date-timerequired

The source creation date

deletedstring · date-time

The source deletion date

descriptionstring · markdown

The source description

idstring

The source unique identifier

namestringrequired

The source display name

schedulestring

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

last_joball of

The last job for this source

organizationall of

The producer organization

ownerall of

The owner information

validationall of

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/harvest/source/preview' \
  --header 'Content-Type: application/json' \
  --data '{"active":false,"autoarchive":true,"config":{},"created_at":"2025-02-20T19:08:10.903Z","name":"text","url":"text","backend":"csw-dcat","last_job":{"created":"2025-02-20T19:08:10.903Z","id":"text","source":"text","status":"pending","errors":[{"level":"text","message":"text"}],"items":[{"created":"2025-02-20T19:08:10.903Z","ended":"2025-02-20T19:08:10.903Z","remote_id":"text","started":"2025-02-20T19:08:10.903Z","status":"pending","kwargs":{},"args":[],"errors":[{"level":"text","message":"text"}],"logs":[{"level":"text","message":"text"}],"dataservice":{"acronym":"text","archived_at":"2025-02-20T19:08:10.903Z","authorization_request_url":"text","availability":"99.99","base_api_url":"text","business_documentation_url":"text","created_at":"2025-02-20T19:08:10.903Z","datasets":{},"deleted_at":"2025-02-20T19:08:10.903Z","description":"text","endpoint_description_url":"text","extras":{},"has_token":true,"id":"text","is_restricted":true,"license":"text","metadata_modified_at":"2025-02-20T19:08:10.903Z","metrics":{},"private":true,"rate_limiting":"text","self_api_url":"text","self_web_url":"text","slug":"text","title":"My awesome API","format":"REST","contact_points":[{"contact_form":"text","email":"text","id":"text","name":"text","role":"text","organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}],"tags":["text"],"harvest":{"archived_at":"2025-02-20T19:08:10.903Z","backend":"text","created_at":"2025-02-20T19:08:10.903Z","domain":"text","id":"text","last_update":"2025-02-20T19:08:10.903Z","remote_id":"text","remote_url":"text","source_id":"text","source_url":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"}}]},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"},"validation":{"state":"pending","by":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}}'

200

200

{
  "created": "2025-02-20T19:08:10.903Z",
  "ended": "2025-02-20T19:08:10.903Z",
  "id": "text",
  "source": "text",
  "started": "2025-02-20T19:08:10.903Z",
  "status": "pending",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "items": [
    {
      "created": "2025-02-20T19:08:10.903Z",
      "ended": "2025-02-20T19:08:10.903Z",
      "remote_id": "text",
      "started": "2025-02-20T19:08:10.903Z",
      "status": "pending",
      "kwargs": {},
      "args": [],
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "dataservice": {
        "acronym": "text",
        "archived_at": "2025-02-20T19:08:10.903Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "created_at": "2025-02-20T19:08:10.903Z",
        "datasets": {},
        "deleted_at": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "endpoint_description_url": "text",
        "extras": {},
        "has_token": true,
        "id": "text",
        "is_restricted": true,
        "license": "text",
        "metadata_modified_at": "2025-02-20T19:08:10.903Z",
        "metrics": {},
        "private": true,
        "rate_limiting": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "title": "My awesome API",
        "format": "REST",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived_at": "2025-02-20T19:08:10.903Z",
          "backend": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-02-20T19:08:10.903Z",
        "created_at": "2025-02-20T19:08:10.903Z",
        "deleted": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency_date": "2025-02-20T19:08:10.903Z",
        "id": "text",
        "last_modified": "2025-02-20T19:08:10.903Z",
        "last_update": "2025-02-20T19:08:10.903Z",
        "license": "notspecified",
        "metrics": {},
        "page": "text",
        "private": true,
        "quality": {},
        "slug": "text",
        "title": "text",
        "uri": "text",
        "frequency": "unknown",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-02-20T19:08:10.903Z",
          "modified_at": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "internal": {
          "created_at_internal": "2025-02-20T19:08:10.903Z",
          "last_modified_internal": "2025-02-20T19:08:10.903Z"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "spatial": {
          "granularity": "other",
          "zones": [
            "text"
          ],
          "geom": {
            "type": "Point",
            "coordinates": [
              {}
            ]
          }
        },
        "temporal_coverage": {
          "end": "2025-02-20T19:08:10.903Z",
          "start": "2025-02-20T19:08:10.903Z"
        },
        "community_resources": [
          {
            "created_at": "2025-02-20T19:08:10.903Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:08:10.903Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:08:10.903Z",
              "modified_at": "2025-02-20T19:08:10.903Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:08:10.903Z",
              "last_modified_internal": "2025-02-20T19:08:10.903Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "resources": [
          {
            "created_at": "2025-02-20T19:08:10.903Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:08:10.903Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:08:10.903Z",
              "modified_at": "2025-02-20T19:08:10.903Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:08:10.903Z",
              "last_modified_internal": "2025-02-20T19:08:10.903Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            }
          }
        ]
      }
    }
  ]
}

Success

Get a single source given an ID or a slug

get

/harvest/source/{ident}

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

Update a harvest source

put

/harvest/source/{ident}

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

activebooleanrequired

Is this source active

autoarchiveboolean · default: truerequired

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

configobject

The configuration as key-value pairs

created_atstring · date-timerequired

The source creation date

deletedstring · date-time

The source deletion date

descriptionstring · markdown

The source description

idstring

The source unique identifier

namestringrequired

The source display name

schedulestring

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

last_joball of

The last job for this source

organizationall of

The producer organization

ownerall of

The owner information

validationall of

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}' \
  --header 'Content-Type: application/json' \
  --data '{"active":false,"autoarchive":true,"config":{},"created_at":"2025-02-20T19:08:10.903Z","name":"text","url":"text","backend":"csw-dcat","last_job":{"created":"2025-02-20T19:08:10.903Z","id":"text","source":"text","status":"pending","errors":[{"level":"text","message":"text"}],"items":[{"created":"2025-02-20T19:08:10.903Z","ended":"2025-02-20T19:08:10.903Z","remote_id":"text","started":"2025-02-20T19:08:10.903Z","status":"pending","kwargs":{},"args":[],"errors":[{"level":"text","message":"text"}],"logs":[{"level":"text","message":"text"}],"dataservice":{"acronym":"text","archived_at":"2025-02-20T19:08:10.903Z","authorization_request_url":"text","availability":"99.99","base_api_url":"text","business_documentation_url":"text","created_at":"2025-02-20T19:08:10.903Z","datasets":{},"deleted_at":"2025-02-20T19:08:10.903Z","description":"text","endpoint_description_url":"text","extras":{},"has_token":true,"id":"text","is_restricted":true,"license":"text","metadata_modified_at":"2025-02-20T19:08:10.903Z","metrics":{},"private":true,"rate_limiting":"text","self_api_url":"text","self_web_url":"text","slug":"text","title":"My awesome API","format":"REST","contact_points":[{"contact_form":"text","email":"text","id":"text","name":"text","role":"text","organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}],"tags":["text"],"harvest":{"archived_at":"2025-02-20T19:08:10.903Z","backend":"text","created_at":"2025-02-20T19:08:10.903Z","domain":"text","id":"text","last_update":"2025-02-20T19:08:10.903Z","remote_id":"text","remote_url":"text","source_id":"text","source_url":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"}}]},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"},"validation":{"state":"pending","by":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}}'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

delete

/harvest/source/{ident}

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

List all jobs for a given source

get

/harvest/source/{ident}/jobs/

Path parameters

identstringrequired

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}/jobs/'

200

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "created": "2025-02-20T19:08:10.903Z",
      "ended": "2025-02-20T19:08:10.903Z",
      "id": "text",
      "source": "text",
      "started": "2025-02-20T19:08:10.903Z",
      "status": "pending",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "items": [
        {
          "created": "2025-02-20T19:08:10.903Z",
          "ended": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "started": "2025-02-20T19:08:10.903Z",
          "status": "pending",
          "kwargs": {},
          "args": [],
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "dataservice": {
            "acronym": "text",
            "archived_at": "2025-02-20T19:08:10.903Z",
            "authorization_request_url": "text",
            "availability": "99.99",
            "base_api_url": "text",
            "business_documentation_url": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "datasets": {},
            "deleted_at": "2025-02-20T19:08:10.903Z",
            "description": "text",
            "endpoint_description_url": "text",
            "extras": {},
            "has_token": true,
            "id": "text",
            "is_restricted": true,
            "license": "text",
            "metadata_modified_at": "2025-02-20T19:08:10.903Z",
            "metrics": {},
            "private": true,
            "rate_limiting": "text",
            "self_api_url": "text",
            "self_web_url": "text",
            "slug": "text",
            "title": "My awesome API",
            "format": "REST",
            "contact_points": [
              {
                "contact_form": "text",
                "email": "text",
                "id": "text",
                "name": "text",
                "role": "text",
                "organization": {
                  "class": "text",
                  "id": "text",
                  "acronym": "text",
                  "logo": "text",
                  "logo_thumbnail": "text",
                  "name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text",
                  "badges": [
                    {
                      "kind": "text"
                    }
                  ]
                },
                "owner": {
                  "class": "text",
                  "id": "text",
                  "avatar": "text",
                  "avatar_thumbnail": "text",
                  "first_name": "text",
                  "last_name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                }
              }
            ],
            "tags": [
              "text"
            ],
            "harvest": {
              "archived_at": "2025-02-20T19:08:10.903Z",
              "backend": "text",
              "created_at": "2025-02-20T19:08:10.903Z",
              "domain": "text",
              "id": "text",
              "last_update": "2025-02-20T19:08:10.903Z",
              "remote_id": "text",
              "remote_url": "text",
              "source_id": "text",
              "source_url": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          },
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          }
        }
      ]
    }
  ]
}

Success

Preview a single harvest source given an ID or a slug

get

/harvest/source/{ident}/preview

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}/preview'

200

200

{
  "created": "2025-02-20T19:08:10.903Z",
  "ended": "2025-02-20T19:08:10.903Z",
  "id": "text",
  "source": "text",
  "started": "2025-02-20T19:08:10.903Z",
  "status": "pending",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "items": [
    {
      "created": "2025-02-20T19:08:10.903Z",
      "ended": "2025-02-20T19:08:10.903Z",
      "remote_id": "text",
      "started": "2025-02-20T19:08:10.903Z",
      "status": "pending",
      "kwargs": {},
      "args": [],
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "dataservice": {
        "acronym": "text",
        "archived_at": "2025-02-20T19:08:10.903Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "created_at": "2025-02-20T19:08:10.903Z",
        "datasets": {},
        "deleted_at": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "endpoint_description_url": "text",
        "extras": {},
        "has_token": true,
        "id": "text",
        "is_restricted": true,
        "license": "text",
        "metadata_modified_at": "2025-02-20T19:08:10.903Z",
        "metrics": {},
        "private": true,
        "rate_limiting": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "title": "My awesome API",
        "format": "REST",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived_at": "2025-02-20T19:08:10.903Z",
          "backend": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-02-20T19:08:10.903Z",
        "created_at": "2025-02-20T19:08:10.903Z",
        "deleted": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency_date": "2025-02-20T19:08:10.903Z",
        "id": "text",
        "last_modified": "2025-02-20T19:08:10.903Z",
        "last_update": "2025-02-20T19:08:10.903Z",
        "license": "notspecified",
        "metrics": {},
        "page": "text",
        "private": true,
        "quality": {},
        "slug": "text",
        "title": "text",
        "uri": "text",
        "frequency": "unknown",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-02-20T19:08:10.903Z",
          "modified_at": "2025-02-20T19:08:10.903Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "internal": {
          "created_at_internal": "2025-02-20T19:08:10.903Z",
          "last_modified_internal": "2025-02-20T19:08:10.903Z"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "spatial": {
          "granularity": "other",
          "zones": [
            "text"
          ],
          "geom": {
            "type": "Point",
            "coordinates": [
              {}
            ]
          }
        },
        "temporal_coverage": {
          "end": "2025-02-20T19:08:10.903Z",
          "start": "2025-02-20T19:08:10.903Z"
        },
        "community_resources": [
          {
            "created_at": "2025-02-20T19:08:10.903Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:08:10.903Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:08:10.903Z",
              "modified_at": "2025-02-20T19:08:10.903Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:08:10.903Z",
              "last_modified_internal": "2025-02-20T19:08:10.903Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "resources": [
          {
            "created_at": "2025-02-20T19:08:10.903Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:08:10.903Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:08:10.903Z",
              "modified_at": "2025-02-20T19:08:10.903Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:08:10.903Z",
              "last_modified_internal": "2025-02-20T19:08:10.903Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            }
          }
        ]
      }
    }
  ]
}

Success

Schedule an harvest source

post

/harvest/source/{ident}/schedule

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

string

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}/schedule' \
  --header 'Content-Type: application/json'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

Unschedule an harvest source

delete

/harvest/source/{ident}/schedule

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}/schedule'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

Validate or reject an harvest source

post

/harvest/source/{ident}/validate

Path parameters

identstringrequired

A source ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

commentstring

A comment about the validation. Required on rejection

onstring · date-time

Date date on which validation was performed

statestring · enumrequired

Is it validated or not

Example: pending

Options: pending, accepted, refused

byall of

Who performed the validation

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/harvest/source/{ident}/validate' \
  --header 'Content-Type: application/json' \
  --data '{"state":"pending","by":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success

List all harvest sources

get

/harvest/sources/

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

ownerstring

The organization or user ID to filter on

deletedboolean

Include sources flaggued as deleted

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/harvest/sources/'

200

200

[
  {
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1,
    "data": [
      {
        "active": false,
        "autoarchive": true,
        "config": {},
        "created_at": "2025-02-20T19:08:10.903Z",
        "deleted": "2025-02-20T19:08:10.903Z",
        "description": "text",
        "id": "text",
        "name": "text",
        "schedule": "text",
        "url": "text",
        "backend": "csw-dcat",
        "last_job": {
          "created": "2025-02-20T19:08:10.903Z",
          "id": "text",
          "source": "text",
          "status": "pending",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "items": [
            {
              "created": "2025-02-20T19:08:10.903Z",
              "ended": "2025-02-20T19:08:10.903Z",
              "remote_id": "text",
              "started": "2025-02-20T19:08:10.903Z",
              "status": "pending",
              "kwargs": {},
              "args": [],
              "errors": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "logs": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "dataservice": {
                "acronym": "text",
                "archived_at": "2025-02-20T19:08:10.903Z",
                "authorization_request_url": "text",
                "availability": "99.99",
                "base_api_url": "text",
                "business_documentation_url": "text",
                "created_at": "2025-02-20T19:08:10.903Z",
                "datasets": {},
                "deleted_at": "2025-02-20T19:08:10.903Z",
                "description": "text",
                "endpoint_description_url": "text",
                "extras": {},
                "has_token": true,
                "id": "text",
                "is_restricted": true,
                "license": "text",
                "metadata_modified_at": "2025-02-20T19:08:10.903Z",
                "metrics": {},
                "private": true,
                "rate_limiting": "text",
                "self_api_url": "text",
                "self_web_url": "text",
                "slug": "text",
                "title": "My awesome API",
                "format": "REST",
                "contact_points": [
                  {
                    "contact_form": "text",
                    "email": "text",
                    "id": "text",
                    "name": "text",
                    "role": "text",
                    "organization": {
                      "class": "text",
                      "id": "text",
                      "acronym": "text",
                      "logo": "text",
                      "logo_thumbnail": "text",
                      "name": "text",
                      "page": "text",
                      "slug": "text",
                      "uri": "text",
                      "badges": [
                        {
                          "kind": "text"
                        }
                      ]
                    },
                    "owner": {
                      "class": "text",
                      "id": "text",
                      "avatar": "text",
                      "avatar_thumbnail": "text",
                      "first_name": "text",
                      "last_name": "text",
                      "page": "text",
                      "slug": "text",
                      "uri": "text"
                    }
                  }
                ],
                "tags": [
                  "text"
                ],
                "harvest": {
                  "archived_at": "2025-02-20T19:08:10.903Z",
                  "backend": "text",
                  "created_at": "2025-02-20T19:08:10.903Z",
                  "domain": "text",
                  "id": "text",
                  "last_update": "2025-02-20T19:08:10.903Z",
                  "remote_id": "text",
                  "remote_url": "text",
                  "source_id": "text",
                  "source_url": "text",
                  "uri": "text"
                },
                "organization": {
                  "class": "text",
                  "id": "text",
                  "acronym": "text",
                  "logo": "text",
                  "logo_thumbnail": "text",
                  "name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text",
                  "badges": [
                    {
                      "kind": "text"
                    }
                  ]
                },
                "owner": {
                  "class": "text",
                  "id": "text",
                  "avatar": "text",
                  "avatar_thumbnail": "text",
                  "first_name": "text",
                  "last_name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                }
              },
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "text"
              }
            }
          ]
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "validation": {
          "state": "pending",
          "by": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      }
    ]
  }
]

Success

Create a new harvest source

post

/harvest/sources/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

activebooleanrequired

Is this source active

autoarchiveboolean · default: truerequired

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

configobject

The configuration as key-value pairs

created_atstring · date-timerequired

The source creation date

deletedstring · date-time

The source deletion date

descriptionstring · markdown

The source description

idstring

The source unique identifier

namestringrequired

The source display name

schedulestring

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

last_joball of

The last job for this source

organizationall of

The producer organization

ownerall of

The owner information

validationall of

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/harvest/sources/' \
  --header 'Content-Type: application/json' \
  --data '{"active":false,"autoarchive":true,"config":{},"created_at":"2025-02-20T19:08:10.903Z","name":"text","url":"text","backend":"csw-dcat","last_job":{"created":"2025-02-20T19:08:10.903Z","id":"text","source":"text","status":"pending","errors":[{"level":"text","message":"text"}],"items":[{"created":"2025-02-20T19:08:10.903Z","ended":"2025-02-20T19:08:10.903Z","remote_id":"text","started":"2025-02-20T19:08:10.903Z","status":"pending","kwargs":{},"args":[],"errors":[{"level":"text","message":"text"}],"logs":[{"level":"text","message":"text"}],"dataservice":{"acronym":"text","archived_at":"2025-02-20T19:08:10.903Z","authorization_request_url":"text","availability":"99.99","base_api_url":"text","business_documentation_url":"text","created_at":"2025-02-20T19:08:10.903Z","datasets":{},"deleted_at":"2025-02-20T19:08:10.903Z","description":"text","endpoint_description_url":"text","extras":{},"has_token":true,"id":"text","is_restricted":true,"license":"text","metadata_modified_at":"2025-02-20T19:08:10.903Z","metrics":{},"private":true,"rate_limiting":"text","self_api_url":"text","self_web_url":"text","slug":"text","title":"My awesome API","format":"REST","contact_points":[{"contact_form":"text","email":"text","id":"text","name":"text","role":"text","organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}],"tags":["text"],"harvest":{"archived_at":"2025-02-20T19:08:10.903Z","backend":"text","created_at":"2025-02-20T19:08:10.903Z","domain":"text","id":"text","last_update":"2025-02-20T19:08:10.903Z","remote_id":"text","remote_url":"text","source_id":"text","source_url":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"}}]},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"},"validation":{"state":"pending","by":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}}'

200

200

{
  "active": false,
  "autoarchive": true,
  "config": {},
  "created_at": "2025-02-20T19:08:10.903Z",
  "deleted": "2025-02-20T19:08:10.903Z",
  "description": "text",
  "id": "text",
  "name": "text",
  "schedule": "text",
  "url": "text",
  "backend": "csw-dcat",
  "last_job": {
    "created": "2025-02-20T19:08:10.903Z",
    "id": "text",
    "source": "text",
    "status": "pending",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "items": [
      {
        "created": "2025-02-20T19:08:10.903Z",
        "ended": "2025-02-20T19:08:10.903Z",
        "remote_id": "text",
        "started": "2025-02-20T19:08:10.903Z",
        "status": "pending",
        "kwargs": {},
        "args": [],
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "dataservice": {
          "acronym": "text",
          "archived_at": "2025-02-20T19:08:10.903Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "created_at": "2025-02-20T19:08:10.903Z",
          "datasets": {},
          "deleted_at": "2025-02-20T19:08:10.903Z",
          "description": "text",
          "endpoint_description_url": "text",
          "extras": {},
          "has_token": true,
          "id": "text",
          "is_restricted": true,
          "license": "text",
          "metadata_modified_at": "2025-02-20T19:08:10.903Z",
          "metrics": {},
          "private": true,
          "rate_limiting": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "title": "My awesome API",
          "format": "REST",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "role": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ]
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "harvest": {
            "archived_at": "2025-02-20T19:08:10.903Z",
            "backend": "text",
            "created_at": "2025-02-20T19:08:10.903Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-02-20T19:08:10.903Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        }
      }
    ]
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "validation": {
    "state": "pending",
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
}

Success