API docs by Redocly

Announcement Service (1.0.0)

Download OpenAPI specification:

Announcements

AnnouncementsV1_list

query Parameters
sortByDate
string (FoundationV1.SortDirection)
Default: "asc"
Enum: "asc" "desc"

日時ソート

昇順ソートの場合はascを指定、降順ソートの場合はdescを指定

filterIsActive
boolean
Default: false

公開状態で絞り込むか

公開状態のみを抽出する場合はtrueを指定

Responses

Response samples

Content type
application/json
{
  • "announcements": [
    ]
}

AnnouncementsV1_create

おしらせを作成する

Request Body schema: application/json
required

作成するおしらせの情報

title
required
string
availableFrom
required
string <date-time>
availableUntil
string <date-time>
url
required
string <uri>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "availableFrom": "2019-08-24T14:15:22Z",
  • "availableUntil": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "announcement": {
    }
}

AnnouncementsV1_detail

おしらせを詳細取得する

path Parameters
id
required
string

おしらせID

Responses

Response samples

Content type
application/json
{
  • "announcement": {
    }
}

AnnouncementsV1_update

おしらせを更新する

path Parameters
id
required
string

おしらせID

Request Body schema: application/json
required

更新するおしらせの情報

title
required
string
availableFrom
required
string <date-time>
availableUntil
string <date-time>
url
required
string <uri>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "availableFrom": "2019-08-24T14:15:22Z",
  • "availableUntil": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "announcement": {
    }
}

AnnouncementsV1_delete

おしらせを削除する

path Parameters
id
required
string

おしらせID

Responses