githubModifier

reuses

Reuse related operations

get
Paramètres de requête
pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:
qstringOptionnel
ownerstringOptionnel
organizationstringOptionnel
organization_badgestring · my-custom-formatOptionnel
typestring · enumOptionnelValeurs possibles:
datasetstringOptionnel
dataservicestringOptionnel
tagstringOptionnel
topicstring · enumOptionnelValeurs possibles:
privatebooleanOptionnel
featuredbooleanOptionnel
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
chevron-right
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
/reuses/
200

Success

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

An optional fields mask

Corps
archivedstring · date-timeOptionnel
dataservicesstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deletedstring · date-timeOptionnel
descriptionstring · markdownRequis
extrasobjectOptionnel
organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

privatebooleanOptionnel
tagsstring[]Optionnel
titlestringRequis
topicstring · enumRequisExample: healthValeurs possibles:
typestring · enumRequisExample: apiValeurs possibles:
urlstringRequis

The remote URL (website)

Réponses
post
/reuses/

List all available reuse badges and their labels

get
Réponses
chevron-right
200

Success

Aucun contenu

get
/reuses/badges/
200

Success

Aucun contenu

Reuses 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
chevron-right
200

Success

application/json
idstringLecture seuleOptionnel

The reuse identifier

image_urlstringLecture seuleOptionnel

The reuse thumbnail URL

pagestringLecture seuleOptionnel

The reuse web page URL

slugstringLecture seuleOptionnel

The reuse permalink string

titlestringLecture seuleOptionnel

The reuse title

get
/reuses/suggest/
200

Success

List all reuse topics

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

An optional fields mask

Réponses
chevron-right
200

Success

application/json
idstringOptionnel

The reuse topic identifier

labelstringOptionnel

The reuse topic display name

get
/reuses/topics/
200

Success

List all reuse types

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

An optional fields mask

Réponses
chevron-right
200

Success

application/json
idstringOptionnel

The reuse type identifier

labelstringOptionnel

The reuse type display name

get
/reuses/types/
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
chevron-right
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
/reuses/{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
chevron-right
200

Success

Aucun contenu

post
/reuses/{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
chevron-right
200

Success

Aucun contenu

delete
/reuses/{id}/followers/
200

Success

Aucun contenu

Fetch a given reuse

get
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Réponses
chevron-right
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
/reuses/{reuse}/

Update a given reuse

put
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Corps
archivedstring · date-timeOptionnel
dataservicesstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deletedstring · date-timeOptionnel
descriptionstring · markdownRequis
extrasobjectOptionnel
organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

privatebooleanOptionnel
tagsstring[]Optionnel
titlestringRequis
topicstring · enumRequisExample: healthValeurs possibles:
typestring · enumRequisExample: apiValeurs possibles:
urlstringRequis

The remote URL (website)

Réponses
chevron-right
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)

put
/reuses/{reuse}/

Delete a given reuse

delete
Paramètres de chemin
reusestringRequis

The reuse ID or slug

Paramètres de requête
send_legal_noticebooleanOptionnel

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

Réponses
delete
/reuses/{reuse}/

Aucun contenu

Create a new badge for a given reuse

post
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Corps
kindstringRequis

Kind of badge (certified, etc), specific to each model

Réponses
chevron-right
200

Success

application/json
kindstringRequis

Kind of badge (certified, etc), specific to each model

post
/reuses/{reuse}/badges/
200

Success

Delete a badge for a given reuse

delete
Paramètres de chemin
badge_kindstringRequis
reusestringRequis

The reuse ID or slug

Réponses
chevron-right
200

Success

Aucun contenu

delete
/reuses/{reuse}/badges/{badge_kind}/
200

Success

Aucun contenu

Add a dataset to a given reuse

post
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Corps
Réponses
chevron-right
200

The dataset is already present

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)

post
/reuses/{reuse}/datasets/

Mark a reuse as featured

post
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Réponses
chevron-right
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)

post
/reuses/{reuse}/featured/
200

Success

delete
Paramètres de chemin
reusestringRequis

The reuse ID or slug

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

An optional fields mask

Réponses
chevron-right
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)

delete
/reuses/{reuse}/featured/
200

Success

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