Nous avons récemment déplacé une partie de la documentation de l’API REST. Si vous ne trouvez pas ce que vous recherchez, vous pouvez essayer la page d’API REST Actions.
Annonce
Utilisez l’API REST pour gérer la bannière d’annonce globale dans votre entreprise.
À propos des annonces
Vous pouvez utiliser l’API REST pour gérer la bannière d’annonce globale dans votre entreprise. Pour plus d’informations, consultez « Personnalisation des messages utilisateur pour votre entreprise ».
Get the global announcement banner
Gets the current message and expiration date of the global announcement banner in your enterprise.
Codes d’état de la réponse HTTP pour « Get the global announcement banner »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Get the global announcement banner »
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcementAnnouncement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Set the global announcement banner
Sets the message and expiration time for the global announcement banner in your enterprise.
Paramètres pour « Set the global announcement banner »
| En-têtes |
|---|
| Nom, Type, Description |
accept string Setting to |
| Paramètres du corps |
| Nom, Type, Description |
announcement string or null ObligatoireThe announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax." |
expires_at string or null The time at which the announcement expires. This is a timestamp in ISO 8601 format: |
Codes d’état de la réponse HTTP pour « Set the global announcement banner »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Set the global announcement banner »
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcement \
-d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00"}'Announcement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Remove the global announcement banner
Removes the global announcement banner in your enterprise.
Codes d’état de la réponse HTTP pour « Remove the global announcement banner »
| Code d’état | Description |
|---|---|
204 | No Content |
Exemples de code pour « Remove the global announcement banner »
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcementResponse
Status: 204