github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/collection.openapi.yml (about)

     1  openapi: "3.0.3"
     2  info:
     3    version: 0.0.0
     4    title: Cios Resource Owner Openapi
     5  
     6  paths:
     7    /v2/collections/{collection_id}/series:
     8      post:
     9        tags:
    10          - Collection
    11        deprecated: true
    12        description: |-
    13          データの保存、時系列データ存在確認への反映は非同期。
    14  
    15          Supported application type: Web, Native, Client, Device
    16        operationId: postSeries
    17        parameters:
    18          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
    19          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
    20        requestBody:
    21          required: true
    22          content:
    23            application/json:
    24              schema:
    25                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesRequest'
    26        responses:
    27          "201":
    28            description: 追加成功
    29          "400":
    30            $ref: '../components/responses.yml#/components/responses/BadRequest'
    31          "401":
    32            $ref: '../components/responses.yml#/components/responses/InvalidToken'
    33          "403":
    34            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
    35          "404":
    36            $ref: '../components/responses.yml#/components/responses/NotFound'
    37          "409":
    38            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
    39          "500":
    40            $ref: '../components/responses.yml#/components/responses/InternalServerError'
    41        security:
    42          - bearerAuth: [ ]
    43        summary: 時系列データ保存
    44    /v2/collections/{collection_id}/series-bulk:
    45      post:
    46        tags:
    47          - Collection
    48        deprecated: true
    49        description: |-
    50          複数のデータの保存、時系列データ存在確認への反映は非同期
    51  
    52          Supported application type：Web, Native, Client, Device
    53        operationId: postSeriesBulk
    54        parameters:
    55          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
    56          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
    57        requestBody:
    58          required: true
    59          content:
    60            application/json:
    61              schema:
    62                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesBulkRequest'
    63        responses:
    64          "201":
    65            description: 追加成功
    66          "400":
    67            $ref: '../components/responses.yml#/components/responses/BadRequest'
    68          "401":
    69            $ref: '../components/responses.yml#/components/responses/InvalidToken'
    70          "403":
    71            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
    72          "404":
    73            $ref: '../components/responses.yml#/components/responses/NotFound'
    74          "409":
    75            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
    76          "500":
    77            $ref: '../components/responses.yml#/components/responses/InternalServerError'
    78        security:
    79          - bearerAuth: [ ]
    80    /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/data:
    81      put:
    82        description: |-
    83          データの保存、時系列データ存在確認への反映は非同期。
    84  
    85          Supported application type: Web, Native, Client, Device
    86        tags:
    87          - Collection
    88        operationId: putSeries
    89        parameters:
    90          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
    91          - $ref: '../components/parameters.yml#/components/parameters/series_id'
    92          - $ref: '../components/parameters.yml#/components/parameters/timestamp_path'
    93          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
    94        requestBody:
    95          required: true
    96          content:
    97            application/json:
    98              schema:
    99                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesDataRequest'
   100        responses:
   101          "201":
   102            description: 追加成功
   103          "400":
   104            $ref: '../components/responses.yml#/components/responses/BadRequest'
   105          "401":
   106            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   107          "403":
   108            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   109          "404":
   110            $ref: '../components/responses.yml#/components/responses/NotFound'
   111          "409":
   112            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   113          "500":
   114            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   115        security:
   116          - bearerAuth: [ ]
   117    /v2/collections/{collection_id}/series/{series_id}/data-bulk:
   118      put:
   119        description: |-
   120          複数のデータの保存、時系列データ存在確認への反映は非同期
   121  
   122          Supported application type：Web, Native, Client, Device
   123        operationId: createSeriesDataBulk
   124        tags:
   125          - Collection
   126        parameters:
   127          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   128          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   129          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   130        requestBody:
   131          required: true
   132          content:
   133            application/json:
   134              schema:
   135                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesDataBulkRequest'
   136        responses:
   137          "201":
   138            description: 追加成功
   139          "400":
   140            $ref: '../components/responses.yml#/components/responses/BadRequest'
   141          "401":
   142            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   143          "403":
   144            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   145          "404":
   146            $ref: '../components/responses.yml#/components/responses/NotFound'
   147          "409":
   148            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   149          "500":
   150            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   151        security:
   152          - bearerAuth: [ ]
   153    /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/image:
   154      get:
   155        tags:
   156          - Collection
   157        description: |-
   158          シリーズID、時刻を指定してオリジナル画像を取得する。
   159  
   160          Supported application type:Web, Native, Client
   161        operationId: getSeriesImage
   162        parameters:
   163          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   164          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   165          - $ref: '../components/parameters.yml#/components/parameters/timestamp_path'
   166          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   167        requestBody:
   168          required: true
   169          content:
   170            application/json:
   171              schema:
   172                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesDataBulkRequest'
   173        responses:
   174          "200":
   175            content:
   176              image/jpeg:
   177                schema:
   178                  description: JPEG形式の画像。
   179                  format: binary
   180                  type: string
   181              image/png:
   182                schema:
   183                  description: PNG形式の画像。
   184                  format: binary
   185                  type: string
   186            description: 取得成功
   187          "400":
   188            $ref: '../components/responses.yml#/components/responses/BadRequest'
   189          "401":
   190            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   191          "403":
   192            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   193          "404":
   194            $ref: '../components/responses.yml#/components/responses/NotFound'
   195          "409":
   196            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   197          "500":
   198            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   199        security:
   200          - bearerAuth: [ ]
   201      put:
   202        tags:
   203          - Collection
   204        description: |-
   205          画像を保存する。
   206  
   207          レスポンスのhttpステータスが500となった場合、最新オリジナル画像、最新サムネイル画像、
   208          オリジナル画像履歴、サムネイル画像履歴のうち一部だけが保存完了している可能性がある。
   209          その場合は保存が完了した画像だけが画像取得APIで取得される状態となるが、
   210          同じタイムスタンプで再度画像をアップロードすることで、それらの画像を上書きすることができる。
   211  
   212          Supported application type: Web, Native, Client, Device
   213        operationId: createSeriesImage
   214        parameters:
   215          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   216          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   217          - $ref: '../components/parameters.yml#/components/parameters/timestamp_path'
   218          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   219          - $ref: '../components/parameters.yml#/components/parameters/is_latest'
   220        requestBody:
   221          required: true
   222          content:
   223            image/jpeg:
   224              schema:
   225                description: JPEG形式の画像。サイズが1MBを超える場合はリクエスト不正とする。
   226                format: binary
   227                type: string
   228            image/png:
   229              schema:
   230                description: PNG形式の画像。サイズが1MBを超える場合はリクエスト不正とする。
   231                format: binary
   232                type: string
   233        responses:
   234          "201":
   235            description: 保存成功
   236          "400":
   237            $ref: '../components/responses.yml#/components/responses/BadRequest'
   238          "401":
   239            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   240          "403":
   241            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   242          "404":
   243            $ref: '../components/responses.yml#/components/responses/NotFound'
   244          "409":
   245            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   246          "500":
   247            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   248        security:
   249          - bearerAuth: [ ]
   250    /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/thumbnail:
   251      get:
   252        tags:
   253          - Collection
   254        description: |-
   255          シリーズID、時刻を指定してサムネイル画像を取得する。
   256  
   257          Supported application type:Web, Native, Client
   258        operationId: getSeriesThumnbnail
   259        parameters:
   260          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   261          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   262          - $ref: '../components/parameters.yml#/components/parameters/timestamp_path'
   263          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   264        requestBody:
   265          required: true
   266          content:
   267            application/json:
   268              schema:
   269                $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesDataBulkRequest'
   270        responses:
   271          "200":
   272            content:
   273              image/jpeg:
   274                schema:
   275                  description: JPEG形式の画像。
   276                  format: binary
   277                  type: string
   278              image/png:
   279                schema:
   280                  description: PNG形式の画像。
   281                  format: binary
   282                  type: string
   283            description: 取得成功
   284          "400":
   285            $ref: '../components/responses.yml#/components/responses/BadRequest'
   286          "401":
   287            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   288          "403":
   289            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   290          "404":
   291            $ref: '../components/responses.yml#/components/responses/NotFound'
   292          "409":
   293            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   294          "500":
   295            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   296        security:
   297          - bearerAuth: [ ]
   298    /v2/collections/{collection_id}/series/{series_id}/data:
   299      get:
   300        tags:
   301          - Collection
   302        description: |-
   303          シリーズID、時刻を指定してサムネイル画像を取得する。
   304  
   305          Supported application type:Web, Native, Client
   306        operationId: getTimeSeriesData
   307        parameters:
   308          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   309          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   310          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   311          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   312          - $ref: '../components/parameters.yml#/components/parameters/time_range'
   313          - $ref: '../components/parameters.yml#/components/parameters/limit'
   314          - $ref: '../components/parameters.yml#/components/parameters/offset'
   315          - $ref: '../components/parameters.yml#/components/parameters/ascending'
   316        responses:
   317          "200":
   318            content:
   319              application/json:
   320                schema:
   321                  $ref: '../components/collection-component.openapi.yml#/components/schemas/MultipleSeriesDataLocationUnix'
   322            description: 取得成功
   323          "400":
   324            $ref: '../components/responses.yml#/components/responses/BadRequest'
   325          "401":
   326            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   327          "403":
   328            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   329          "404":
   330            $ref: '../components/responses.yml#/components/responses/NotFound'
   331          "409":
   332            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   333          "500":
   334            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   335        security:
   336          - bearerAuth: [ ]
   337    /v2/collections/{collection_id}/series/{series_id}/images:
   338      get:
   339        tags:
   340          - Collection
   341        description: |-
   342          シリーズID、期間等を指定してオリジナル画像の履歴を取得する。
   343  
   344          Supported application type:Web, Native, Client
   345        operationId: getSeriesImages
   346        parameters:
   347          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   348          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   349          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   350          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   351          - $ref: '../components/parameters.yml#/components/parameters/time_range'
   352          - $ref: '../components/parameters.yml#/components/parameters/limit'
   353          - $ref: '../components/parameters.yml#/components/parameters/offset'
   354          - $ref: '../components/parameters.yml#/components/parameters/ascending'
   355        responses:
   356          "200":
   357            content:
   358              application/json:
   359                schema:
   360                  $ref: '../components/collection-component.openapi.yml#/components/schemas/MultipleSeriesImage'
   361            description: 取得成功
   362          "400":
   363            $ref: '../components/responses.yml#/components/responses/BadRequest'
   364          "401":
   365            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   366          "403":
   367            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   368          "404":
   369            $ref: '../components/responses.yml#/components/responses/NotFound'
   370          "409":
   371            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   372          "500":
   373            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   374        security:
   375          - bearerAuth: [ ]
   376    /v2/collections/{collection_id}/series/{series_id}/thumbnails:
   377      get:
   378        tags:
   379          - Collection
   380        description: |-
   381          シリーズID、期間等を指定してサムネイル画像の履歴を取得する。
   382  
   383          Supported application type:Web, Native, Client
   384        operationId: getSeriesThumbnails
   385        parameters:
   386          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   387          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   388          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   389          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   390          - $ref: '../components/parameters.yml#/components/parameters/time_range'
   391          - $ref: '../components/parameters.yml#/components/parameters/limit'
   392          - $ref: '../components/parameters.yml#/components/parameters/offset'
   393          - $ref: '../components/parameters.yml#/components/parameters/ascending'
   394        responses:
   395          "200":
   396            content:
   397              application/json:
   398                schema:
   399                  $ref: '../components/collection-component.openapi.yml#/components/schemas/MultipleSeriesImage'
   400            description: 取得成功
   401          "400":
   402            $ref: '../components/responses.yml#/components/responses/BadRequest'
   403          "401":
   404            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   405          "403":
   406            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   407          "404":
   408            $ref: '../components/responses.yml#/components/responses/NotFound'
   409          "409":
   410            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   411          "500":
   412            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   413        security:
   414          - bearerAuth: [ ]
   415    /v2/collections/{collection_id}/series/{series_id}:
   416      get:
   417        tags:
   418          - Collection
   419        deprecated: true
   420        description: |-
   421          期間・シリーズID等を指定して時系列データを取得する。
   422  
   423          Supported application type:Web, Native, Client
   424        operationId: getSeries
   425        parameters:
   426          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   427          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   428          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   429          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   430          - $ref: '../components/parameters.yml#/components/parameters/time_range'
   431          - $ref: '../components/parameters.yml#/components/parameters/limit'
   432          - $ref: '../components/parameters.yml#/components/parameters/offset'
   433          - $ref: '../components/parameters.yml#/components/parameters/ascending'
   434        responses:
   435          "200":
   436            content:
   437              application/json; charset=utf-8:
   438                schema:
   439                  $ref: '../components/collection-component.openapi.yml#/components/schemas/MultipleSeriesDataLocationUnix'
   440            description: 取得成功
   441            headers:
   442              Content-Encoding:
   443                description: 圧縮形式。リクエストヘッダで圧縮形式を指定した場合のみ。
   444                explode: false
   445                schema:
   446                  pattern: gzip
   447                  type: string
   448                style: simple
   449          "400":
   450            $ref: '../components/responses.yml#/components/responses/BadRequest'
   451          "401":
   452            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   453          "403":
   454            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   455          "404":
   456            $ref: '../components/responses.yml#/components/responses/NotFound'
   457          "409":
   458            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   459          "500":
   460            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   461        security:
   462          - bearerAuth: [ ]
   463    /v2/collections/{collection_id}/search-latest:
   464      post:
   465        tags:
   466          - Collection
   467        description: |-
   468          最新データを取得する。<br>
   469          取得対象データはtimestampが最も新しいデータではなく`最後に送信されたデータ`となる。 <br>
   470          またbulk uploadされたデータは過去データの扱いの為この最新データ取得で取得されるデータには影響しない。 <br>
   471          projection=dataの場合は時系列データ保存API、imageかthumbnailの場合は画像保存APIで最後に保存されたものが取得対象となる。
   472  
   473          Supported application type:Web, Native, Client
   474        operationId: postSearchLatest
   475        parameters:
   476          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   477          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   478          - $ref: '../components/parameters.yml#/components/parameters/limit'
   479          - $ref: '../components/parameters.yml#/components/parameters/offset'
   480          - $ref: '../components/parameters.yml#/components/parameters/projection'
   481          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   482        requestBody:
   483          required: true
   484          content:
   485            application/json:
   486              schema:
   487                $ref: '../components/collection-component.openapi.yml#/components/schemas/CollectionLatestRequest'
   488        responses:
   489          "200":
   490            content:
   491              application/json:
   492                schema:
   493                  $ref: '../components/collection-component.openapi.yml#/components/schemas/MultipleCollectionLatest'
   494            description: 取得成功
   495          "400":
   496            $ref: '../components/responses.yml#/components/responses/BadRequest'
   497          "401":
   498            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   499          "403":
   500            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   501          "404":
   502            $ref: '../components/responses.yml#/components/responses/NotFound'
   503          "409":
   504            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   505          "500":
   506            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   507        security:
   508          - bearerAuth: [ ]
   509    /v2/collections/{collection_id}/archive:
   510      post:
   511        tags:
   512          - Collection
   513        description: |-
   514          指定した現場の時系列データをアーカイブし、アーカイブ・リストア状態をARCHIVEDにする。
   515  
   516          Supported application type：Web, Native
   517        operationId: postCollectionArchive
   518        parameters:
   519          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   520          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   521        responses:
   522          "202":
   523            description: リストア要求受付成功
   524          "400":
   525            $ref: '../components/responses.yml#/components/responses/BadRequest'
   526          "401":
   527            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   528          "403":
   529            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   530          "404":
   531            $ref: '../components/responses.yml#/components/responses/NotFound'
   532          "409":
   533            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   534          "500":
   535            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   536        security:
   537          - bearerAuth: [ ]
   538    /v2/collections/{collection_id}/restore:
   539      post:
   540        tags:
   541          - Collection
   542        description: |-
   543          指定した現場の時系列データをリストアし、アーカイブ・リストア状態をREADYにする。
   544  
   545          Supported application type：Web, Native
   546        operationId: postCollectionRestore
   547        parameters:
   548          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   549          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   550        responses:
   551          "202":
   552            description: アーカイブ要求受付成功
   553          "400":
   554            $ref: '../components/responses.yml#/components/responses/BadRequest'
   555          "401":
   556            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   557          "403":
   558            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   559          "404":
   560            $ref: '../components/responses.yml#/components/responses/NotFound'
   561          "409":
   562            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   563          "500":
   564            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   565        security:
   566          - bearerAuth: [ ]
   567    /v2/collections/{collection_id}/status:
   568      get:
   569        tags:
   570          - Collection
   571        description: |-
   572          アーカイブ・リストア状態を取得する。
   573  
   574          アーカイブ・リストア状態遷移
   575          ![](./images/archive-restore-state-transtition-diagram.png)
   576  
   577          Supported application type：Web, Native
   578        operationId: getCollectionStatus
   579        parameters:
   580          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   581          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   582        responses:
   583          "200":
   584            description: 取得成功
   585            content:
   586              application/json; charset=utf-8:
   587                schema:
   588                  $ref: '../components/collection-component.openapi.yml#/components/schemas/CollectionStatus'
   589          "400":
   590            $ref: '../components/responses.yml#/components/responses/BadRequest'
   591          "401":
   592            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   593          "403":
   594            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   595          "404":
   596            $ref: '../components/responses.yml#/components/responses/NotFound'
   597          "500":
   598            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   599        security:
   600          - bearerAuth: [ ]
   601    /v2/collections/{collection_id}/recorded-dates:
   602      get:
   603        tags:
   604          - Collection
   605        description: |-
   606          指定した年月において、時系列データが存在する日付のリストを取得する。
   607  
   608          時系列データ保存API、または、時系列データ保存(bulk upload)APIで保存された時系列データが存在する日付のみ取得対象であり、画像のみが存在する日付は取得されない。
   609  
   610          Supported application type:Web, Native, Client
   611        operationId: getRecordedDates
   612        parameters:
   613          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   614          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   615          - $ref: '../components/parameters.yml#/components/parameters/month_required'
   616          - $ref: '../components/parameters.yml#/components/parameters/gmt_offset'
   617        responses:
   618          "200":
   619            description: 取得成功
   620            content:
   621              application/json; charset=utf-8:
   622                schema:
   623                  $ref: '../components/collection-component.openapi.yml#/components/schemas/RecordedDates'
   624          "400":
   625            $ref: '../components/responses.yml#/components/responses/BadRequest'
   626          "401":
   627            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   628          "403":
   629            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   630          "404":
   631            $ref: '../components/responses.yml#/components/responses/NotFound'
   632          "409":
   633            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   634          "500":
   635            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   636        security:
   637          - bearerAuth: [ ]
   638    /v2/collections/{collection_id}/series/{series_id}/latest:
   639      delete:
   640        tags:
   641          - Collection
   642        description: |-
   643          シリーズIDを指定して最新データを削除する。削除後は当該シリーズの最新データおよび画像は最新データ取得APIのレスポンスに含まれない。<br>
   644          Responseが500の場合、最新データまたは最新画像のいずれかが残っている可能性がある。<br>
   645          再度APIを実行してResponseが204であれば残ったリソースも削除できた状態となる。
   646  
   647          Supported application type:Web, Native, Client, Device
   648        operationId: deleteSeriesLatest
   649        parameters:
   650          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   651          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   652          - $ref: '../components/parameters.yml#/components/parameters/timestamp_path'
   653          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   654        responses:
   655          "204":
   656            description: 削除成功
   657          "400":
   658            $ref: '../components/responses.yml#/components/responses/BadRequest'
   659          "401":
   660            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   661          "403":
   662            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   663          "404":
   664            $ref: '../components/responses.yml#/components/responses/NotFound'
   665          "409":
   666            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   667          "500":
   668            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   669        security:
   670          - bearerAuth: [ ]
   671    /v2/collections/{collection_id}/series/{series_id}/aggregation:
   672      post:
   673        tags:
   674          - Collection
   675        description: |-
   676          期間・シリーズID等を指定して時系列データの計測値を集計する。
   677  
   678          Supported application type:Web, Native, Client
   679        operationId: getSeriesAggregation
   680        requestBody:
   681          required: true
   682          content:
   683            application/json:
   684              schema:
   685                type: array
   686                items:
   687                  $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesAggregationRequest'
   688  
   689        parameters:
   690          - $ref: '../components/parameters.yml#/components/parameters/collection_id'
   691          - $ref: '../components/parameters.yml#/components/parameters/series_id'
   692          - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id'
   693          - $ref: '../components/parameters.yml#/components/parameters/Accept-Encoding'
   694          - $ref: '../components/parameters.yml#/components/parameters/time_range'
   695          - $ref: '../components/parameters.yml#/components/parameters/interval'
   696          - $ref: '../components/parameters.yml#/components/parameters/ascending'
   697        responses:
   698          "200":
   699            content:
   700              application/json; charset=utf-8:
   701                schema:
   702                  $ref: '../components/collection-component.openapi.yml#/components/schemas/SeriesAggregations'
   703            description: 取得成功
   704            headers:
   705              Content-Encoding:
   706                description: 圧縮形式。リクエストヘッダで圧縮形式を指定した場合のみ。
   707                explode: false
   708                schema:
   709                  pattern: gzip
   710                  type: string
   711                style: simple
   712          "400":
   713            $ref: '../components/responses.yml#/components/responses/BadRequest'
   714          "401":
   715            $ref: '../components/responses.yml#/components/responses/InvalidToken'
   716          "403":
   717            $ref: '../components/responses.yml#/components/responses/InsufficientScopes'
   718          "404":
   719            $ref: '../components/responses.yml#/components/responses/NotFound'
   720          "409":
   721            $ref: '../components/responses.yml#/components/responses/StatusMismatch'
   722          "500":
   723            $ref: '../components/responses.yml#/components/responses/InternalServerError'
   724        security:
   725          - bearerAuth: [ ]
   726  
   727  components:
   728    securitySchemes:
   729      bearerAuth:
   730        type: http
   731        scheme: bearer
   732        bearerFormat: JWT