discussions

Discussion related operations

Précédentreuses Suivantorganizations

Dernière mise à jour il y a 1 an

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

Get a discussion given its ID

get

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/discussions/{id}/'

200

{
  "class": "text",
  "closed": "2025-03-25T03:55:34.971Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-03-25T03:55:34.971Z",
  "discussion": {
    "content": "text",
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-03-25T03:55:34.971Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "spam": {
    "status": "not_checked"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "title": "text",
  "url": "text",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Delete a discussion given its ID

delete

Path parameters

idanyrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/discussions/{id}/'

403

No body

Not allowed to delete this discussion

Delete a comment given its index

delete

Path parameters

idanyrequired

cidxanyrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/discussions/{id}/comments/{cidx}'

403

No body

Not allowed to delete this comment

List all Discussions

get

Query parameters

sortanyoptional

The field (and direction) on which sorting apply

closedanyoptional

Filters discussions on their closed status if specified

foranyoptional

Filter discussions for a given subject

organyoptional

Filter discussions for a given organization

useranyoptional

Filter discussions created by a user

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/discussions/'

200

{
  "data": [
    {
      "class": "text",
      "closed": "2025-03-25T03:55:34.971Z",
      "closed_by": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "created": "2025-03-25T03:55:34.971Z",
      "discussion": {
        "content": "text",
        "posted_by": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "posted_on": "2025-03-25T03:55:34.971Z",
        "spam": {
          "status": "not_checked"
        }
      },
      "extras": {},
      "id": "text",
      "spam": {
        "status": "not_checked"
      },
      "subject": {
        "class": "text",
        "id": "text"
      },
      "title": "text",
      "url": "text",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Create a new Discussion

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

commentstringrequired

The content of the initial comment

extrasobjectoptional

Extras attributes as key-value pairs

subjectall ofrequired

The discussion target object

titlestringrequired

The title of the discussion to open

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/discussions/' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "text",
    "extras": {},
    "subject": {
      "class": "text",
      "id": "text"
    },
    "title": "text"
  }'

200

{
  "class": "text",
  "closed": "2025-03-25T03:55:34.971Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-03-25T03:55:34.971Z",
  "discussion": {
    "content": "text",
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-03-25T03:55:34.971Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "spam": {
    "status": "not_checked"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "title": "text",
  "url": "text",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Add comment and optionally close a discussion given its ID

post

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

closebooleanoptional

Is this a closing response. Only subject owner can close

commentstringrequired

The comment to submit

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/discussions/{id}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "close": true,
    "comment": "text"
  }'

200

403

{
  "class": "text",
  "closed": "2025-03-25T03:55:34.971Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-03-25T03:55:34.971Z",
  "discussion": {
    "content": "text",
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-03-25T03:55:34.971Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "spam": {
    "status": "not_checked"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "title": "text",
  "url": "text",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Get a discussion given its ID

Delete a discussion given its ID

Delete a comment given its index

List all Discussions

Create a new Discussion

Show child attributes

Add comment and optionally close a discussion given its ID