Download OpenAPI specification:Download
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://auth.fit.cvut.cz/oauth/authorize Token URL: https://auth.fit.cvut.cz/oauth/token Scopes:
|
clientCredentials OAuth Flow | Token URL: https://auth.fit.cvut.cz/oauth/token Scopes:
|
Returns news messages aggregated from all the course pages. This resource supports path extensions as an alternative to the Accept header to select the response format: /cpages/news.json
and /cpages/news.xml
.
cvut:cpages:common:read
) type | any Default: "default" Enum: "default" "grouped" "jsonfeed" Specify type of the JSON representation:
|
courses | Array of strings Example: courses=BI-LIN,MI-RUB Return messages only from the specified course pages. |
deleted | boolean Default: false Whether to return even deleted messages. |
limit | integer Maximum number of messages to return. If |
offset | integer Default: 0 Offset of the first message to return. This parameter is ignored when |
since | string <ISO 8601> Example: since=2019-06-01 Return messages published since this date. |
until | string <ISO 8601> Example: until=2019-06-01 Return messages published until this date. |
OK
id required | integer Unique ID of the message. |
title required | string Title of the message (may be empty). |
content required | string <html> HTML content of the message. |
createdAt required | string <ISO 8601 DateTime> ISO 8601 date and time when the message was created. |
createdBy required | object Person who created the message. |
modifiedAt | string <ISO 8601 DateTime> ISO 8601 date and time when the message was last modified. |
modifiedBy | object The last person who modified the message. |
publishedAt required | string <ISO 8601 DateTime> ISO 8601 date and time when the message should be published. |
ref required | string <SHA-1> Hash of the last commit that created/modified the message. |
deleted required | boolean Whether this message was removed from the source file. |
audience required | Array of strings KOS codes of the courses for which the message is intended. |
Error
JSON response for type=default
.
[- {
- "id": "BI-XYZ:1559148108-1063cff",
- "title": "2nd Message",
- "content": "<p>Ut enim ad minim veniam,\nquis nostrud exercitation.</p>",
- "createdAt": "2019-05-29T18:41:48+02:00",
- "createdBy": {
- "name": "Jakub Jirutka",
- "uri": "mailto:jakub@jirutka.cz"
}, - "publishedAt": "2019-05-29T18:41:48+02:00",
- "ref": "7683c61b0775a0f45cdf4911a4e65a634b257ecd",
- "deleted": false,
- "audience": [
- "BI-XYZ.16",
- "BIE-XYZ.16"
]
}, - {
- "id": "BI-XYZ:1559148568-1f9252e",
- "title": "3rd Message",
- "content": "<p>Duis aute irure dolor,\nin reprehenderit.</p>",
- "createdAt": "2019-05-29T18:49:28+02:00",
- "createdBy": {
- "name": "Kevin Flynn",
- "uri": "mailto:flynn@encom.com"
}, - "modifiedAt": "2019-05-29T18:55:05+02:00",
- "modifiedBy": {
- "name": "Jakub Jirutka",
- "uri": "mailto:jakub@jirutka.cz"
}, - "publishedAt": "2019-05-13T00:00:00.000Z",
- "ref": "1909e1c15d22d02f85f8e17109068353d6c0d6fc",
- "deleted": false,
- "audience": [
- "BI-XYZ.16"
]
}
]
Returns information about the specified GitLab project.
cvut:cpages:common:read
) proj-path required | string Example: /MI-RUB/mi-rub |
OK
issues required | object The project’s issues. |
pipeline required | null or object Status of the latest pipeline in the project (if there’s any) |
Error
{- "issues": {
- "unassigned": {
- "latest": [
- {
- "createdAt": "2019-04-25T14:32:09.697+02:00",
- "iid": 3,
- "title": "Špatné upřesnění v závorce pojmu \"řádků v opačném pořadí\"",
}, - {
- "createdAt": "2019-04-02T14:52:15.819+02:00",
- "iid": 2,
- "title": "poladit harmonogram pro b192",
}
], - "total": 2
}
}, - "pipeline": {
- "status": "success",
}
}
cvut:kosapi:read
) OK
username required | string <= 8 characters |
firstName required | string |
lastName required | string |
titlesPre | string Titles before the person's name. |
titlesPost | string Titles after the person's name. |
Error
{- "username": "flynnkev",
- "firstName": "Kevin",
- "lastName": "Flynn",
- "titlesPre": "Ing.",
- "titlesPost": "CSc."
}
Returns list of courses the current user was/is studying and teaching in the specified semester.
cvut:kosapi:read
) semester | string Default: "current" Example: semester=B192 |
OK
studying required | Array of strings List of course codes the user is studying. |
teaching required | Array of strings List of course codes the user is teaching. |
Error
{- "studying": [
- "BI-CDC",
- "BI-DAD",
- "BI-DDE"
], - "teaching": [
- "BI-BCF",
- "BI-DAB"
]
}