For the complete documentation index, see llms.txt. This page is also available as Markdown.

organizations

Organization related operations

List or search all organizations

get
Paramètres de requête
qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:
pageintegerOptionnel

The page to fetch

Default: 1
page_sizeintegerOptionnel

The page size to fetch

Default: 20
badgestring · enumOptionnelValeurs possibles:
namestringOptionnel
business_number_idstringOptionnel
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/organizations/
200

Success

Create a new organization

post
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
acronymstring · max: 128Optionnel
business_number_idstring · max: 14Optionnel
descriptionstring · markdownRequis
extrasobjectOptionnel
image_urlstringOptionnel
namestringRequis
presentation_blocsobject[]Optionnel
presentation_blocs_published_atstring · date-timeOptionnel

Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.

urlstringOptionnel
Réponses
201

Success

application/json
acronymstring · max: 128Optionnel
business_number_idstring · max: 14Optionnel
created_atstring · date-timeLecture seuleRequis
deletedstring · date-timeLecture seuleOptionnel
descriptionstring · markdownRequis
extobjectLecture seuleOptionnel
extrasobjectOptionnel
idstringLecture seuleRequis
image_urlstringOptionnel
last_modifiedstring · date-timeLecture seuleRequis
logostringLecture seuleOptionnel

URL of the image

logo_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

metricsobjectLecture seuleOptionnel
namestringRequis
pagestringLecture seuleOptionnel

Link to the udata web page for this organization

presentation_blocsobject[]Optionnel
presentation_blocs_published_atstring · date-timeOptionnel

Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.

slugstring · max: 255Lecture seuleRequis
teamsobject · Team (read)Optionnel
uristringLecture seuleOptionnel

Link to the API endpoint for this organization

urlstringOptionnel
zonestringLecture seuleOptionnel
post/organizations/

List all available organization badges and their labels

get
Réponses
200

Success

Aucun contenu

get/organizations/badges/
200

Success

Aucun contenu

List all possible organization roles

get
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
idstringOptionnel

The role identifier

labelstringOptionnel

The role label

get/organizations/roles/
200

Success

Organizations suggest endpoint using mongoDB contains

get
Paramètres de requête
qstringRequis

The string to autocomplete/suggest

sizeintegerOptionnel

The amount of suggestion to fetch

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
acronymstringLecture seuleOptionnel

The organization acronym

idstringLecture seuleOptionnel

The organization identifier

image_urlstringLecture seuleOptionnel

The organization logo URL

namestringLecture seuleOptionnel

The organization name

pagestringLecture seuleOptionnel

The organization web page URL

slugstringLecture seuleOptionnel

The organization permalink string

get/organizations/suggest/
200

Success

List all followers for a given object

get
Paramètres de chemin
idstringRequis
Paramètres de requête
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

userstringOptionnel

Filter follower by user, it allows to check if a user is following the object

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/organizations/{id}/followers/
200

Success

Follow an object given its ID

post

Returns the number of followers left after the operation

Paramètres de chemin
idstringRequis
Réponses
200

Success

Aucun contenu

post/organizations/{id}/followers/
200

Success

Aucun contenu

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin
idstringRequis
Réponses
200

Success

Aucun contenu

delete/organizations/{id}/followers/
200

Success

Aucun contenu

Get a organization given its identifier

get
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
acronymstring · max: 128Optionnel
business_number_idstring · max: 14Optionnel
created_atstring · date-timeLecture seuleRequis
deletedstring · date-timeLecture seuleOptionnel
descriptionstring · markdownRequis
extobjectLecture seuleOptionnel
extrasobjectOptionnel
idstringLecture seuleRequis
image_urlstringOptionnel
last_modifiedstring · date-timeLecture seuleRequis
logostringLecture seuleOptionnel

URL of the image

logo_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

metricsobjectLecture seuleOptionnel
namestringRequis
pagestringLecture seuleOptionnel

Link to the udata web page for this organization

presentation_blocsobject[]Optionnel
presentation_blocs_published_atstring · date-timeOptionnel

Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.

slugstring · max: 255Lecture seuleRequis
teamsobject · Team (read)Optionnel
uristringLecture seuleOptionnel

Link to the API endpoint for this organization

urlstringOptionnel
zonestringLecture seuleOptionnel
get/organizations/{org}/

Update a organization given its identifier

put
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
acronymstring · max: 128Optionnel
business_number_idstring · max: 14Optionnel
descriptionstring · markdownRequis
extrasobjectOptionnel
image_urlstringOptionnel
namestringRequis
presentation_blocsobject[]Optionnel
presentation_blocs_published_atstring · date-timeOptionnel

Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.

urlstringOptionnel
Réponses
200

Success

application/json
acronymstring · max: 128Optionnel
business_number_idstring · max: 14Optionnel
created_atstring · date-timeLecture seuleRequis
deletedstring · date-timeLecture seuleOptionnel
descriptionstring · markdownRequis
extobjectLecture seuleOptionnel
extrasobjectOptionnel
idstringLecture seuleRequis
image_urlstringOptionnel
last_modifiedstring · date-timeLecture seuleRequis
logostringLecture seuleOptionnel

URL of the image

logo_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (100x100)

metricsobjectLecture seuleOptionnel
namestringRequis
pagestringLecture seuleOptionnel

Link to the udata web page for this organization

presentation_blocsobject[]Optionnel
presentation_blocs_published_atstring · date-timeOptionnel

Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.

slugstring · max: 255Lecture seuleRequis
teamsobject · Team (read)Optionnel
uristringLecture seuleOptionnel

Link to the API endpoint for this organization

urlstringOptionnel
zonestringLecture seuleOptionnel
put/organizations/{org}/

Delete a organization given its identifier

delete
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres de requête
send_legal_noticebooleanOptionnel

Send formal legal notice with appeal information to owner (admin only)

Réponses
204

Organization deleted

Aucun contenu

delete/organizations/{org}/

Aucun contenu

Create a new badge for a given organization

post
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
kindstringRequis
Réponses
200

Success

application/json
kindstringRequis
post/organizations/{org}/badges/
200

Success

Delete a badge for a given organization

delete
Paramètres de chemin
badge_kindstringRequis
orgstringRequis

The organization ID or slug

Réponses
200

Success

Aucun contenu

delete/organizations/{org}/badges/{badge_kind}/
200

Success

Aucun contenu

get
Paramètres de chemin
orgstringRequis

The organization ID or slug

Réponses
404

Organization not found

Aucun contenu

get/organizations/{org}/catalog

Aucun contenu

List organization datasets (including private ones when member)

get
Paramètres de chemin
orgstringRequis
Paramètres de requête
qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

tagstring[]Optionnel
licensestringOptionnel
featuredbooleanOptionnel

If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.

geozonestringOptionnel
granularitystringOptionnel
temporal_coveragestringOptionnel
access_typestring · enumOptionnelValeurs possibles:
organizationstringOptionnel
badgestring · enumOptionnelValeurs possibles:
organization_badgestring · enumOptionnelValeurs possibles:
ownerstringOptionnel
followed_bystringOptionnel

(beta, subject to change/be removed)

formatstringOptionnel
schemastringOptionnel
schema_versionstringOptionnel
topicstringOptionnel
creditstringOptionnel
dataservicestringOptionnel
reusestringOptionnel
archivedbooleanOptionnel

If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility

deletedbooleanOptionnel

If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility

privatebooleanOptionnel

If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/organizations/{org}/datasets/
200

Success

List organization discussions

get
Paramètres de chemin
orgstringRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
classstringRequis

The object class

closedstring · date-timeOptionnel

The discussion closing date

createdstring · date-timeOptionnel

The discussion creation date

extrasobjectOptionnel

Extra attributes as key-value pairs

idstringOptionnel

The discussion identifier

self_web_urlstringOptionnel

The discussion web URL

titlestringOptionnel

The discussion title

urlstringOptionnel

The discussion API URI

get/organizations/{org}/discussions/
200

Success

List membership requests for a given organization

get
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres de requête
statusstringOptionnel

If provided, only return requests in a given status

userstringOptionnel

If provided, only return requests for this user

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
commentstringOptionnel

A request comment from the user

createdstring · date-timeLecture seuleOptionnel

The request creation date

emailstringOptionnel

Email for non-registered user invitations

idstringLecture seuleOptionnel
kindstring · enumOptionnel

The request kind (request or invitation)

Default: requestExample: requestValeurs possibles:
rolestring · enumOptionnel

The role to assign

Default: editorExample: adminValeurs possibles:
statusstring · enumRequis

The current request status

Example: pendingValeurs possibles:
get/organizations/{org}/membership/

List assignments for this organization

get
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
created_atstring · date-timeLecture seuleOptionnel
idstringLecture seuleRequis
subjectobjectRequis
get/organizations/{org}/assignments/
200

Success

Delete member from an organization

delete
Paramètres de chemin
orgstringRequis

The organization ID or slug

userstringRequis
Réponses
403

Not Authorized

Aucun contenu

delete/organizations/{org}/member/{user}/
403

Not Authorized

Aucun contenu

Sync assignments for a partial_editor member

put

Replaces all current assignments with the provided list.

Paramètres de chemin
orgstringRequis

The organization ID or slug

userstringRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
created_atstring · date-timeLecture seuleOptionnel
idstringLecture seuleRequis
subjectobjectRequis
put/organizations/{org}/member/{user}/assignments/

Update member status into a given organization

put
Paramètres de chemin
orgstringRequis

The organization ID or slug

userstringRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
rolestring · enumOptionnelExample: adminValeurs possibles:
Réponses
200

Success

application/json
labelstringLecture seuleOptionnel
rolestring · enumOptionnelExample: adminValeurs possibles:
sincestring · date-timeLecture seuleRequis
put/organizations/{org}/member/{user}/

Invite a user or email to join the organization

post
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
commentstringOptionnel

Invitation message

emailstringOptionnel

Email to invite (if user not registered)

rolestring · enumOptionnel

The role to assign

Default: editorExample: adminValeurs possibles:
userstringOptionnel

User ID to invite

Réponses
201

Success

application/json
commentstringOptionnel

A request comment from the user

createdstring · date-timeLecture seuleOptionnel

The request creation date

emailstringOptionnel

Email for non-registered user invitations

idstringLecture seuleOptionnel
kindstring · enumOptionnel

The request kind (request or invitation)

Default: requestExample: requestValeurs possibles:
rolestring · enumOptionnel

The role to assign

Default: editorExample: adminValeurs possibles:
statusstring · enumRequis

The current request status

Example: pendingValeurs possibles:
post/organizations/{org}/member/

Apply for membership to a given organization

post
Paramètres de chemin
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
commentstringOptionnel
Réponses
200

Success

application/json
commentstringOptionnel

A request comment from the user

createdstring · date-timeLecture seuleOptionnel

The request creation date

emailstringOptionnel

Email for non-registered user invitations

idstringLecture seuleOptionnel
kindstring · enumOptionnel

The request kind (request or invitation)

Default: requestExample: requestValeurs possibles:
rolestring · enumOptionnel

The role to assign

Default: editorExample: adminValeurs possibles:
statusstring · enumRequis

The current request status

Example: pendingValeurs possibles:
post/organizations/{org}/membership/
200

Success

Accept user membership to a given organization

post
Paramètres de chemin
idstringRequis
orgstringRequis

The organization ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
labelstringLecture seuleOptionnel
rolestring · enumOptionnelExample: adminValeurs possibles:
sincestring · date-timeLecture seuleRequis
post/organizations/{org}/membership/{id}/accept/
200

Success

Refuse user membership to a given organization

post
Paramètres de chemin
idstringRequis
orgstringRequis

The organization ID or slug

Corps
commentstringOptionnel

The refusal comment.

Réponses
200

Success

Aucun contenu

post/organizations/{org}/membership/{id}/refuse/
200

Success

Aucun contenu

List organization reuses (including private ones when member)

get
Paramètres de chemin
orgstringRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200

Success

application/json
archivedstring · date-timeOptionnel
created_atstring · date-timeLecture seuleRequis
deletedstring · date-timeOptionnel
descriptionstring · markdownRequis
extrasobjectOptionnel
featuredbooleanLecture seuleOptionnel
idstringLecture seuleRequis
imagestringLecture seuleOptionnel

URL of the image

image_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (500x500)

last_modifiedstring · date-timeLecture seuleRequis
metricsobjectLecture seuleOptionnel
pagestringLecture seuleOptionnel

Link to the udata web page for this reuse

privatebooleanOptionnel
slugstring · max: 255Lecture seuleRequis
tagsstring[]Optionnel
titlestringRequis
topicstring · enumRequisExample: healthValeurs possibles:
typestring · enumRequisExample: apiValeurs possibles:
uristringLecture seuleOptionnel

Link to the API endpoint for this reuse

urlstringRequis

The remote URL (website)

get/organizations/{org}/reuses/
200

Success

Mis à jour

Ce contenu vous a-t-il été utile ?