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 ?

Revision created il y a 1 an

Update faq-cadastre.md

Get a discussion given its ID

get

Paramètres de chemin

idanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/discussions/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "class": "text",
  "closed": "2025-05-30T22:38:46.890Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "closed_by_organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-05-30T22:38:46.890Z",
  "discussion": {
    "content": "text",
    "last_modified_at": "2025-05-30T22:38:46.890Z",
    "permissions": {
      "delete": true,
      "edit": true
    },
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_by_organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-05-30T22:38:46.890Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "close": true,
    "delete": true,
    "edit": true
  },
  "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"
  }
}

Delete a discussion given its ID

delete

Paramètres de chemin

idanyRequis

Réponses

403

Not allowed to delete this discussion

delete

DELETE /api/1/discussions/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

403

Not allowed to delete this discussion

Aucun contenu

Delete a comment given its index

delete

Paramètres de chemin

idanyRequis

cidxanyRequis

Réponses

403

Not allowed to delete this comment

delete

DELETE /api/1/discussions/{id}/comments/{cidx} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

403

Not allowed to delete this comment

Aucun contenu

List all Discussions

get

Paramètres de requête

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

closedbooleanOptionnel

Filters discussions on their closed status if specified

forstring[]Optionnel

Filter discussions for a given subject

orgstringOptionnel

Filter discussions for a given organization

userstringOptionnel

Filter discussions created by a user

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

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

200

Success

{
  "data": [
    {
      "class": "text",
      "closed": "2025-05-30T22:38:46.890Z",
      "closed_by": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "closed_by_organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "created": "2025-05-30T22:38:46.890Z",
      "discussion": {
        "content": "text",
        "last_modified_at": "2025-05-30T22:38:46.890Z",
        "permissions": {
          "delete": true,
          "edit": true
        },
        "posted_by": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "posted_by_organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "posted_on": "2025-05-30T22:38:46.890Z",
        "spam": {
          "status": "not_checked"
        }
      },
      "extras": {},
      "id": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "permissions": {
        "close": true,
        "delete": true,
        "edit": true
      },
      "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
}

Create a new Discussion

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

commentstringRequis

The content of the initial comment

extrasobjectOptionnel

Extras attributes as key-value pairs

organizationall ofOptionnel

Publish in the name of this organization

subjectall ofRequis

The discussion target object

titlestringRequis

The title of the discussion to open

Réponses

200

Success

application/json

post

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

{
  "comment": "text",
  "extras": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  },
  "title": "text"
}

200

Success

{
  "class": "text",
  "closed": "2025-05-30T22:38:46.890Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "closed_by_organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-05-30T22:38:46.890Z",
  "discussion": {
    "content": "text",
    "last_modified_at": "2025-05-30T22:38:46.890Z",
    "permissions": {
      "delete": true,
      "edit": true
    },
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_by_organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-05-30T22:38:46.890Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "close": true,
    "delete": true,
    "edit": true
  },
  "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"
  }
}

Add comment and optionally close a discussion given its ID

post

Paramètres de chemin

idanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

closebooleanOptionnel

Is this a closing response. Only subject owner can close

commentstringRequis

The comment to submit

Réponses

200

Success

application/json

403

Not allowed to close this discussion OR can't add comments on a closed discussion

post

POST /api/1/discussions/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "close": true,
  "comment": "text"
}

{
  "class": "text",
  "closed": "2025-05-30T22:38:46.890Z",
  "closed_by": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "closed_by_organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "created": "2025-05-30T22:38:46.890Z",
  "discussion": {
    "content": "text",
    "last_modified_at": "2025-05-30T22:38:46.890Z",
    "permissions": {
      "delete": true,
      "edit": true
    },
    "posted_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_by_organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "posted_on": "2025-05-30T22:38:46.890Z",
    "spam": {
      "status": "not_checked"
    }
  },
  "extras": {},
  "id": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "permissions": {
    "close": true,
    "delete": true,
    "edit": true
  },
  "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"
  }
}