API docs by Redocly

intdash API specification (v2.7.0)

Download OpenAPI specification:Download

株式会社アプトポッド: VM2M-support@aptpod.co.jp URL: https://www.aptpod.co.jp/

ベースURL

ベースURLは以下のとおりです。APIエンドポイントはこのベースURLから始まります。

https://<host>/api

エンドポイント例:

https://example.intdash.jp/api/v1/measurements
https://example.intdash.jp/api/media/videos

レスポンスのステータスコード

サーバーからクライアントに返却されるHTTPレスポンスのステータスコードは以下のとおりです。

コード 説明
101 Switching Protocols サーバーはプロトコルを切り替えます。
200 OK リクエストは成功しました。
201 Created 新しいリソースが作成されました。
204 No Content リクエストは成功しました。返却するコンテンツはありません。
400 Bad Request 構文が正しくないなどの理由により、リクエストは処理できませんでした。
401 Unauthorized リクエストには認証が必要です。
403 Forbidden アクセス権がないなどの理由により、リクエストは拒否されました。
404 Not Found APIまたはリソースが見つかりません。
405 Method Not Allowed 指定されたメソッドは許可されていません。
409 Conflict 既存のリソースとのコンフリクトのため、リクエストは失敗しました。
500 Internal Server Error サーバーで予期しないエラーが発生したため、リクエストは失敗しました。

注意

リクエストボディのJSONでは、キーの大文字と小文字は区別されません。 従って、以下の2つのリクエストは同じものと見なされます。


{
  "username" : "username",
  "password" : "password"
}


{
  "Username" : "username",
  "Password" : "password"
}

Authorization

Check HTTP Authorization

アクセス制御可能かどうかを判定します。

サブジェクト指定なしの場合

リクエストのスコープのみでアクセス判定を行います。

サブジェクト指定ありの場合

パスの構造から指定したリソースがプロジェクトやグループのリソースかどうか分類し、分類した結果によって処理が決まります。

プロジェクト配下のリソースであると判定した場合

サブジェクトがプロジェクトに所属しているかを確認し、所属している場合は、サブジェクトがメンバーの場合そのプロジェクトにおけるスコープからアクセス判定を行います。 サブジェクトがエッジの場合はリクエストのスコープからアクセス判定を行います。

グループ配下のリソースであると判定した場合

サブジェクトがグループに所属しているかを確認し、所属している場合は、そのグループにおけるスコープからアクセス判定を行います。

パスがその他の場合

リクエストのスコープからアクセス判定を行います。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
subject
string

認証主体を指定します。通常アクセスユーザーのUUIDかアクセスエッジのUUIDを指定します。

scopes
required
Array of strings

スコープを指定します。前述の説明を参照ください。

path
required
string

パス

method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"

メソッド

Responses

Request samples

Content type
application/json
{
  • "subject": "eb0398f0-3631-470a-abed-0ac3763cf90d",
  • "scopes": [
    ],
  • "path": "/resource/path",
  • "method": "POST"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": true
}

Check Me HTTP Authorization

認証ユーザー自身が指定されたパスとメソッドに対してアクセス可能かどうかを判定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
path
required
string

パス

method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"

メソッド

Responses

Request samples

Content type
application/json
{
  • "path": "/resource/path",
  • "method": "POST"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": true
}

List Roles

ロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

name
Array of strings
Example: name=member

ロールの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Get Role

ロールを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "member",
  • "scopes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List Scopes

スコープのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=4688a07a-0cbc-4597-8c87-538e744bc90d

スコープのUUID

name
Array of strings
Example: name=meas:r

スコープの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Get Scope

スコープを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
scope_uuid
required
string
Example: 4688a07a-0cbc-4597-8c87-538e744bc90d

The Scope UUID.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "4688a07a-0cbc-4597-8c87-538e744bc90d",
  • "name": "meas:r",
  • "allowed_endpoints": [
    ],
  • "allowed_iscp_messages": [
    ],
  • "denied_endpoints": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

OAuth2

Authorization Endpoint

OAuth2認可エンドポイント。 RFC6749:The OAuth 2.0 Authorization Framework

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
client_id
required
string
Example: client_id=client_id

OAuth2クライアントID

response_type
required
string
Value: "code"
Example: response_type=code

OAuth2のresponse_type。 code のみサポートされています。

redirect_uri
required
string
Example: redirect_uri=http://localhost:8080/

認可後のリダイレクト先URI

state
required
string
Example: state=05d54c58385046dd822d233c6adfb9e9

CSRF対策のためのstate

code_challenge
string
Example: code_challenge=ZtNPunH49FD35FWYhT5Tv8I7vRKQJ8uxMaL0_9eHjNA

PKCEコードチャレンジ。 code_verifier から計算したSHA-256ハッシュを、Base64 URLエンコードしたもの。

code_challenge_method
string
Value: "S256"
Example: code_challenge_method=S256

PKCEコードチャレンジの方式。 S256 （SHA-256）のみサポートされます。

Responses

Revoke Token

トークンを無効化します。 このエンドポイントをコールしてからトークンが無効化されるまで、通常数秒程度かかります。 RFC7009:OAuth 2.0 Token Revocation

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/x-www-form-urlencoded
client_id
required
string

OAuth2クライアントID

token_type_hint
any
Default: "refresh_token"
Enum: "access_token" "refresh_token"

OAuth2トークンタイプについてのヒント

token
string

無効化したいリフレッシュトークンまたはアクセストークン。 指定を省略した場合、サーバーは、cookieの _bearer_token に指定されたアクセストークン、または、Authorizationヘッダーに指定されたアクセストークン（ Bearer トークン）を無効化します。

Responses

Request samples

Content type
application/x-www-form-urlencoded
client_id=99dcf67c_default.aptpod.co.jp&token=eyJhbGciOiJSUzI1NiIsImtpZCI6ImNkY2M4NjAxZGNiMTY2ODg5MTAyNjY5OWY2MmQ5ZDEyNGIxMTcwZmQ4OWU2YTgxNTkyNGIwNDIwZWQ2MDM0NWYiLCJ0eXAiOiJKV1QifQ.eyJleHAiOjE1ODA5NTQ5NzgsImlhdCI6MTU4MDk1MTM3OCwiaXNzIjoibWljcm8tYXV0aCJ9.Xmi5TgHRiXIaVZXtfCxPNEIWrJMusmlqImA2d7uTZDtnUh6Cv_RvbLgChVsyl5hPFNDXU-Bm4-Nh8ppQVJpHQhVYPeVlycMXhKXdlx_kNJoBA8tJ4BgZlQObt16ZzakZIoYJBH8ffWkWxDYGVswVFRaB4e4EfsaOa3jGP15jK9g&token_type_hint=refresh_token

List JSON Web Keys

JSON Web Keysのリストを取得します。 RFC7517:JSON Web Key

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/jwk-set+json; charset=utf-8
{
  • "keys": [
    ]
}

Token Endpoint

OAuth2のアクセストークンを取得します。 RFC6749:The OAuth 2.0 Authorization Framework

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/x-www-form-urlencoded
grant_type
any
Enum: "password" "authorization_code" "refresh_token" "client_credentials"

グラントタイプ

refresh_token
string

認可時に発行されたリフレッシュトークン。grant_typeが refresh_token の場合にだけ指定します。

tenant_uuid
string
Default: "00000000-0000-0000-0000-000000000000"

テナントのUUID。grant_typeが password の場合にだけ指定します。 grant_typeが password で、テナントUUIDを省略した場合は、デフォルトのテナントが使用されます。

username
string

ユーザーの名前。grant_typeが password の場合にだけ指定します。

password
string

パスワード。grant_typeが password の場合にだけ指定します。

client_id
string

OAuth2クライアントのID

client_secret
string

OAuth2のクライアントシークレット。 OAuth2クライアントの token_endpoint_auth_method が client_secret_post の場合にだけ指定します。

client_certification
string

OAuth2のクライアント証明書。 OAuth2クライアントの token_endpoint_auth_method が tls_client_auth の場合にだけ指定します。

redirect_uri
string

認可後のリダイレクト先URI。 grant_typeが authorization_code の場合にだけ必要です。

code_verifier
string

PKCE code verifier.

  • 使用可能な文字: [a-Z] / [0-9] / "-" / "." / "_" / "~"
  • 長さ: 43文字以上、128文字以下
code
string

認可コード

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=password&username=username%40example.com&password=password&client_id=99dcf67c_default.aptpod.co.jp

Response samples

Content type
application/json; charset=utf-8
{
  • "token_type": "bearer",
  • "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImNkY2M4NjAxZGNiMTY2ODg5MTAyNjY5OWY2MmQ5ZDEyNGIxMTcwZmQ4OWU2YTgxNTkyNGIwNDIwZWQ2MDM0NWYiLCJ0eXAiOiJKV1QifQ.eyJleHAiOjE1ODA5NTQ5NzgsImlhdCI6MTU4MDk1MTM3OCwiaXNzIjoibWljcm8tYXV0aCJ9.Xmi5TgHRiXIaVZXtfCxPNEIWrJMusmlqImA2d7uTZDtnUh6Cv_RvbLgChVsyl5hPFNDXU-Bm4-Nh8ppQVJpHQhVYPeVlycMXhKXdlx_kNJoBA8tJ4BgZlQObt16ZzakZIoYJBH8ffWkWxDYGVswVFRaB4e4EfsaOa3jGP15jK9g",
  • "expires_in": 3600,
  • "refresh_token": "lv70VlZ92fLAKiNT5qzOi684K0R5ZVcPjtAhCo_A_0I.iUIeiUrBVR9OoM9y_QBzSVzAgXvJ-8AYANCA1WEx_Lw",
  • "refresh_token_expires_in": 2592000,
  • "scope": ""
}

OAuth2 Clients

List OAuth2Clients

OAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
id
Array of strings
Example: id=039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

name
Array of strings
Example: name=client_name

名前による部分一致検索

sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get OAuth2Client

OAuth2クライアントを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update OAuth2Client

OAuth2クライアントを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters

名前

redirect_uris
Array of strings <= 10 items [ items <= 256 characters ]

認可後のリダイレクト先URI

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete OAuth2Client

OAuth2クライアントを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

List User's OAuth2Clients

ユーザーのOAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Authenticated User's OAuth2 Clients

List My OAuth2Clients

自分（ユーザー）のOAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My OAuth2Client

自分（ユーザー）のOAuth2クライアントを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

名前

grant_type
required
string

グラントタイプ

redirect_uris
required
Array of strings <= 10 items [ items <= 256 characters ]
token_endpoint_auth_method
required
string
Default: "client_secret_post"
Enum: "client_secret_post" "tls_client_auth" "client_secret_basic" "none"

トークンエンドポイントの認証方式

tls_client_auth_subject_dn
string <= 512 characters

TLSクライアント認証のサブジェクトDN

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-authorization-code-client",
  • "grant_type": "authorization_code",
  • "token_endpoint_auth_method": "client_secret_basic",
  • "redirect_uris": []
}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "string",
  • "name": "string",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "string",
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z",
  • "client_secret": "string"
}

Get My OAuth2Client

自分（ユーザー）のOAuth2クライアントを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My OAuth2Client

自分（ユーザー）のOAuth2クライアントを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters

名前

redirect_uris
Array of strings <= 10 items [ items <= 256 characters ]

認可後のリダイレクト先URI

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My OAuth2Client

自分（ユーザー）のOAuth2クライアントを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Create My OAuth2Client Secret

OAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete My OAuth2Client Secret

OAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Users

List Users

ユーザーのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
Array of strings
Example: role_uuid=af22c56b-6b3e-4807-a165-07e9dbd7e25b

ロールのUUID

name
Array of strings
Example: name=intdash

ユーザーの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

nickname
Array of strings
Example: nickname=intdash-nickname

ユーザーの表示名による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

email
Array of strings
Example: email=intdash@example.com

メールアドレスによる部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

disabled
boolean
  • true を指定した場合、無効化されているユーザーのみを取得します。
  • false を指定した場合、有効なユーザーのみを取得します。
  • 指定を省略した場合、有効／無効にかかわらずユーザーを取得します。
is_super
boolean
  • true を指定した場合、スーパーユーザーのみを取得します。
  • false を指定した場合、スーパーユーザー以外を取得します。
  • 指定を省略した場合、スーパーユーザーであるかにかかわらずユーザーを取得します。
is_temporary
boolean
  • true を指定した場合、一時パスワードを使用しているユーザーのみを取得します。
  • false を指定した場合、パスワードを設定済みのユーザーのみを取得します。
  • 指定を省略した場合、一時パスワードを使用しているかにかかわらずユーザーを取得します。
min_sign_in_attempt_count
integer >= 0
Example: min_sign_in_attempt_count=1

ログイン失敗回数の最小値。ログイン失敗回数がこの数値以上のユーザーを取得します。

max_sign_in_attempt_count
integer >= 0
Example: max_sign_in_attempt_count=10

ログイン失敗回数の最大値。ログイン失敗回数がこの数値以下のユーザーを取得します。

sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
  • last_sign_in_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create User

ユーザーを作成します。新しいユーザーには自動生成された一時パスワードが設定されます。 ユーザー作成のリクエストにメールアドレス（ email ）が含まれていた場合は、 そのメールアドレスに確認メールが送信されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

role_uuids
required
Array of strings

ロールのUUID。指定したロールがユーザーに割り当てられます。

email
string [ 1 .. 256 ] characters

ユーザーのメールアドレス

Responses

Request samples

Content type
application/json
{
  • "name": "intdash",
  • "nickname": "nickname",
  • "description": "description",
  • "role_uuids": [
    ],
  • "email": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "password": {
    },
  • "roles": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get User

ユーザーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update User

ユーザーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

Responses

Request samples

Content type
application/json
{
  • "name": "username",
  • "nickname": "nickname",
  • "description": "user description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete User

ユーザーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "error message"
}

Enable User

ユーザーを有効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Disable User

ユーザーを無効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List User's Roles

ユーザーのロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Assign Role

ユーザーにロールを割り当てます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "member",
  • "scopes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Unassign Role

ユーザーへのロールの割り当てを解除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

User's Emails

Set Email as Verified

メールアドレスを確認済みにします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
verification_token
required
string [ 1 .. 4096 ] characters

メールアドレス確認用トークン

Responses

Request samples

Content type
application/json
{
  • "verification_token": "verification.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create Email

ユーザーのメールアドレスを設定します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Email

ユーザーのメールアドレスを更新します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Email

ユーザーのメールアドレスを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Send Verification Email

メールアドレスを確認するため確認メールを送信します。メールアドレス確認用トークンを使用します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "email_id": "1",
  • "expired_at": "2100-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Set Email as Verified

ユーザーのメールアドレスを確認済みにします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
verification_token
required
string [ 1 .. 4096 ] characters

メールアドレス確認用トークン

Responses

Request samples

Content type
application/json
{
  • "verification_token": "verification.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

User's Password

Create Temporary Password

ユーザーのパスワードを、ランダムな一時パスワードに変更します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 0,
  • "is_temporary": true,
  • "temporary_password": "password",
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Unlock Password

ユーザーのパスワードのロックを解除します。このユーザーのログイン失敗回数は0にリセットされます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 0,
  • "is_temporary": false,
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

User's API Tokens

Introspect API Token

APIトークンの検証を行います。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset=utf-8
token
required
string

APIトークン

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "token": "message.signature"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "active": false
}

List API Tokens

ユーザーのAPIトークンのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create API Token

ユーザーのAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

APIトークンの名前

expired_at
string <date-time>

有効期限

Responses

Request samples

Content type
application/json
{
  • "name": "for test",
  • "expired_at": "2000-01-02T03:04:05.00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "craeted",
  • "token": "token.signature",
  • "scopes": [
    ],
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update API Token

ユーザーのAPIトークンを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Request Body schema: application/json; charset=utf-8
name
required
string <= 256 characters

APIトークンの名前

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "for test"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "for test",
  • "token": "token",
  • "scopes": [
    ],
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete API Token

ユーザーのAPIトークンを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Responses

Authenticated User

Get Me

自分（ユーザー）を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Me

自分（ユーザー）を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

Responses

Request samples

Content type
application/json
{
  • "name": "username",
  • "nickname": "nickname",
  • "description": "user description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List My Roles

自分（ユーザー）に割り当てられたロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Authenticated User's Emails

Create My Email

自分（ユーザー）のメールアドレスを設定します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My Email

自分（ユーザー）のメールアドレスを更新します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My Email

自分（ユーザー）のメールアドレスを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Send Verification Email to Me

メールアドレスを確認するための確認メールを送信します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "email_id": "1",
  • "expired_at": "2100-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Authenticated User's Password

Change Password

パスワードを変更します。 現在のパスワード old_password または recovery_token が必要です。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
password
required
string [ 8 .. 512 ] characters [a-zA-Z0-9!"#$%&'()*+,-./:;<=>?@\{\}|\[\]]*

新しいパスワード

old_password
string <= 512 characters

現在のパスワード

recovery_token
string

リカバリートークン。パスワード再設定用の確認メールに含まれています。

Responses

Request samples

Content type
application/json
{
  • "password": "new-password",
  • "old_password": "old-password",
  • "recovery_token": "recovery.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 1,
  • "is_temporary": false,
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Check Password

パスワードがポリシーに適合しているかをチェックします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset=utf-8
password
required
string <= 512 characters

チェックしたいパスワード

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "password": "password"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "valid": false,
  • "errors": [
    ]
}

Authenticated User's API Tokens

List My API Tokens

自分（ユーザー）のAPIトークンのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My API Token

自分（ユーザー）のAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

APIトークンの名前

expired_at
string <date-time>

有効期限

Responses

Request samples

Content type
application/json
{
  • "name": "for test",
  • "expired_at": "2000-01-02T03:04:05.00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "craeted",
  • "token": "token.signature",
  • "scopes": [
    ],
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My API Token

自分（ユーザー）のAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Request Body schema: application/json; charset=utf-8
name
required
string <= 256 characters

APIトークンの名前

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "for test"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "for test",
  • "token": "token",
  • "scopes": [
    ],
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My API Token

自分（ユーザー）のAPIトークンを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Responses

Edges

List Edges

エッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=0932ff17-567c-4ac8-a40d-136357890f7b

エッジのUUID

name
Array of strings
Example: name=edge_name

名前による部分一致検索

nickname
Array of strings
Example: nickname=edge_nickname

表示名による部分一致検索

owner_uuid
Array of strings
Example: owner_uuid=d30267f0-bdd4-4d53-b072-45d3cc29c7de

所有者ユーザーのUUID

has_owner
string
Enum: "true" "false"
Example: has_owner=true

所有者の有無。

  • true : 所有者が設定されているエッジを取得します。
  • false : 所有者が設定されていないエッジを取得します。
sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Edge

所有者がない状態でエッジを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Edge having the same UUID as Me

自分のUUIDと同じエッジUUIDを持つエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Edge

エッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Edge

エッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Edge

エッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Assign Owner

エッジに所有者を割り当てます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
user_uuid
required
string

所有者とするユーザーのUUID

Responses

Request samples

Content type
application/json
{
  • "user_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "84693d9e-0f1a-457b-b417-a7c697cffdce"
}

Unassign Owner

エッジに所有者がない状態にします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

List User's Edges

指定されたユーザーが所有するエッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create User's Edge

指定されたユーザーを所有者とするエッジを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get User's Edge

ユーザーが所有するエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update User's Edge

ユーザーが所有するエッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete User's Edge

ユーザーが所有するエッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Edge's Secrets

Create Edge's Secret

EdgeのOAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete Edge's Secret

EdgeのOAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Authenticated User's Edges

List My Edges

自分（ユーザー）が所有するエッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My Edge

新しいエッジを作成し、自分（ユーザー）を所有者に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get My Edge

自分（ユーザー）が所有するエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create My Edge with UUID

指定したUUIDを持つ新しいエッジを作成し、自分を所有者に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge-with-uuid",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My Edge

自分（ユーザー）が所有するエッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My Edge

自分（ユーザー）が所有するエッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Secrets of Authenticated User's Edge

Create My Edge Secret

EdgeのOAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete My Edge Secret

EdgeのOAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Groups

List My Groups

自分（ユーザー）が所属するグループのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

List Groups

グループのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create Group

グループを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-group",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Group

グループを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "parent_group_uuid": "76b35658-9d77-40d0-8ef8-5c3f520db30d",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Group

グループを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
name
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "parent_group_uuid": "76b35658-9d77-40d0-8ef8-5c3f520db30d",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Group

グループを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Responses

List Sub-groups

サブグループを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create Sub-group

サブグループを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
name
required
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-group",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Group Members

List Group Members

グループメンバーリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

query Parameters
is_owner
boolean
  • true を指定した場合、オーナーのみを取得します。
  • false を指定した場合、オーナー以外を取得します。
  • 指定を省略した場合、オーナーであるかにかかわらずメンバーを取得します。
user_uuid
Array of strings
Example: user_uuid=b7f5f259-6a63-4a26-bfa3-e15240cbc0b7

ユーザーのUUID

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Add Group Member

グループメンバーを追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
user_email_address
string <= 512 characters

ユーザーのメールアドレス。user_uuid といずれか必須です。user_uuid を優先します。

user_uuid
string <= 36 characters

ユーザーのUUID。user_email_address といずれか必須です。user_uuid を優先します。

role_uuids
required
Array of strings (RoleUUIDs) [ items <= 36 characters ]

ユーザーに割り当てるロールのUUID。オーナーのロールUUIDは変更できません。

Responses

Request samples

Content type
application/json
{
  • "user_email_address": "intdash@example.com",
  • "user_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "role_uuids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Group Member

グループメンバーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Group Member

グループメンバーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
role_uuids
Array of strings (RoleUUIDs) [ items <= 36 characters ]

ユーザーに割り当てるロールのUUID。オーナーのロールUUIDは変更できません。

Responses

Request samples

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

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Remove Group Member

グループメンバーを除名します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "unremovable owner member"
}

Add Group Owner Attribute

オーナー属性を追加します。オーナー属性を追加したメンバーは自動的にそのグループにおける全ての権限が付与されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Remove Group Owner Attribute

オーナー属性を取り除きます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "project must have at least one owner."
}

Projects

List My Projects

自分（ユーザー）が所属するプロジェクトのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

List Group Projects

プロジェクトのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create Project

プロジェクトを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
name
required
string (ProjectName) [ 1 .. 255 ] characters

プロジェクトの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-project"
}

Response samples

Content type
application/json; charset=utf-8

Created API Token

{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "parent_group_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "my-project",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List Projects

プロジェクトのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
since_created_at
string <date-time>
Example: since_created_at=2006-01-02T15:04:05.999999999Z

指定した時刻より後に作成されたリソースを取得します。

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Project

プロジェクトを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "parent_group_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Project

プロジェクトを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

Request Body schema: application/json
name
required
string (ProjectName) [ 1 .. 255 ] characters

プロジェクトの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-project"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "parent_group_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Project

プロジェクトを削除します。プロジェクトを削除できるのはプロジェクトのオーナーのみです。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "You cannot delete a project. Because you are not a project owner."
}

Project Members

List Project Members

プロジェクトメンバーリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

query Parameters
user_uuid
Array of strings
Example: user_uuid=b7f5f259-6a63-4a26-bfa3-e15240cbc0b7

ユーザーのUUID

is_owner
boolean
  • true を指定した場合、オーナーのみを取得します。
  • false を指定した場合、オーナー以外を取得します。
  • 指定を省略した場合、オーナーであるかにかかわらずメンバーを取得します。
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Add Project Member

プロジェクトメンバーを追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

Request Body schema: application/json
user_email_address
string <= 512 characters

ユーザーのメールアドレス。user_uuid といずれか必須です。user_uuid を優先します。

user_uuid
string <= 36 characters

ユーザーのUUID。user_email_address といずれか必須です。user_uuid を優先します。

role_uuids
required
Array of strings[ items <= 36 characters ]

ユーザーに割り当てるロールのUUID

Responses

Request samples

Content type
application/json
{
  • "user_email_address": "intdash@example.com",
  • "user_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "role_uuids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Project Member

プロジェクトメンバーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Project Member

プロジェクトメンバーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
role_uuids
Array of strings (RoleUUIDs) [ items <= 36 characters ]

ユーザーに割り当てるロールのUUID。オーナーのロールUUIDは変更できません。

Responses

Request samples

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

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Remove Project Member

プロジェクトからメンバーを外します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "unremovable owner member"
}

Add Project Owner Attribute

オーナー属性を追加します。オーナー属性を追加したメンバーは自動的にそのプロジェクトにおける全ての権限が付与されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Remove Project Owner Attribute

オーナー属性を取り除きます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "project must have at least one owner."
}

Project Edges

List Project Edges

プロジェクトに所属するエッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

query Parameters
edge_uuid
Array of strings
Example: edge_uuid=b7f5f259-6a63-4a26-bfa3-e15240cbc0b7

エッジのUUID

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "nickname" "nickname+" "nickname-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Add Project Edge

エッジをプロジェクトに追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

Request Body schema: application/json
edge_name
required
string [ 1 .. 255 ] characters

追加したいエッジの名前

nickname
required
string (ProjectEdgeNickname) [ 1 .. 255 ] characters

プロジェクトにおけるエッジのニックネーム

Responses

Request samples

Content type
application/json
{
  • "edge_name": "edge-name",
  • "nickname": "Edge Nickname"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "edge_uuid": "756c0e45-21e3-4942-92d9-4ef44a0add26",
  • "name": "edge-name",
  • "nickname": "Edge Nickname",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Project Edge

プロジェクトに所属するエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "edge_uuid": "756c0e45-21e3-4942-92d9-4ef44a0add26",
  • "name": "edge-name",
  • "nickname": "Edge Nickname",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Remove Project Edge

プロジェクトからエッジを外します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Update Project Edge

プロジェクトエッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

プロジェクトのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
nickname
string (ProjectEdgeNickname) [ 1 .. 255 ] characters

プロジェクトにおけるエッジのニックネーム

Responses

Request samples

Content type
application/json
{
  • "nickname": "Edge Nickname"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "edge_uuid": "756c0e45-21e3-4942-92d9-4ef44a0add26",
  • "name": "edge-name",
  • "nickname": "Edge Nickname",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Connect by iSCP

Connect ISCPv2

iSCP v2（WebSocket上でリアルタイムデータを送受信するintdash独自プロトコル）の使用を開始するためのエンドポイントです。 このリクエストを送ることで、プロトコルがWebSocketに切り替えられ、iSCP v2を使用できます。

iSCP v2の詳細については、 アプトポッド にお問い合わせください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Issue ISCP Ticket

iSCPの認証チケットを発行します。

iSCPの認証チケットは、iSCPv2の接続リクエスト時の拡張用アクセストークンとして使用することができます。 また、認証チケットは有効期限内で一回のみ使用することができます。 一度使用した認証チケットは有効期限に関わらず使用することはできません。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "ticket": "VjVL9o7cj45Z1WJX-dPVZ0Z6i80xAfs6.AFVDLS0-iPfzKQN3m7j_pGpU7XSwliWopn9QvGtHf2Y=",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Upstream by HTTP

Create Upstream

アップストリームを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

Request Body schema: application/json
session_id
required
string <uuid>
source_node_id
required
string
persist
required
boolean

Responses

Request samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "source_node_id": "string",
  • "persist": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "source_node_id": "6e8dfe1c-0f26-4e14-bf90-f3c1eb146bf9",
  • "persist": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "http": {
    }
}

Close Upstream

アップストリームをクローズします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

stream_id
required
string
Example: e0b6bbbc-29f6-4682-bf17-8383b2ad846e

ストリームのID

Request Body schema: application/json
close_session
required
boolean
Default: false

セッションをクローズします。 intdashではセッションは計測と紐づいており、close_session=true とした場合は紐づく計測は complete 状態に遷移させます。 永続化フラグが false であるストリームに対しては close_session の属性はtrue/falseに関わらず無視されます。

Responses

Request samples

Content type
application/json
{
  • "close_session": false
}

Response samples

Content type
application/json; charset=utf-8
{
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "source_node_id": "string",
  • "persist": true,
  • "http": {
    },
  • "created_at": "2019-08-24T14:15:22Z"
}

Send Upstream Chunks

アップストリームチャンクを送信します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

stream_id
required
string
Example: e0b6bbbc-29f6-4682-bf17-8383b2ad846e

ストリームのID

Request Body schema: application/json
required
Array of objects (DataPointGroups)

Responses

Request samples

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

Response samples

Content type
application/json; charset=utf-8
{
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "source_node_id": "string",
  • "persist": true,
  • "http": {
    },
  • "created_at": "2019-08-24T14:15:22Z"
}

Send Upstream Metadata

メタデータを送信します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

Request Body schema: application/json
persist
required
boolean
source_node_id
required
string
required
object (MetadataBaseTime)

Responses

Request samples

Content type
application/json
{
  • "persist": true,
  • "source_node_id": "string",
  • "base_time": {
    }
}

External Storage Integration

List Persister Configs

永続化拡張モジュール設定のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Persister Configs

永続化拡張モジュール設定を作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string (PersisterConfigAttributeName) <= 255 characters [0-9][a-z][A-Z][-_].*
description
string (PersisterConfigAttributeDescription) <= 65535 characters
type
required
string (PersisterConfigAttributeType)
object (PersisterConfigAttributeS3)
format
required
string (PersisterConfigAttributeS3Format)
Enum: "csv" "parquet" "json-lines" "raw"
Array of objects (PersisterConfigDataFilters)
Array of objects (PersisterConfigIgnoreDataFilters)
Array of objects (PersisterConfigNodes)

対象ノードIDを指定します。空の場合は全てのノードを対象とします。本属性と ignore_nodes 属性の両方に同じノードIDを指定した場合は、ignore_nodes 属性が優先されます。

Array of objects (PersisterConfigIgnoreNodes)

除外するノードIDを指定します。 本属性と nodes 属性の両方に同じノードIDを指定した場合は、本属性が優先されます。

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-persister",
  • "description": "永続化設定です",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "2f8df301-7a2f-4b6b-a289-7a24f24e9101",
  • "name": "my-persister",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "is_shared_global": false,
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Test Persister Configs

永続化拡張モジュール設定をテストします。リソースは作成しません。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string (PersisterConfigAttributeName) <= 255 characters [0-9][a-z][A-Z][-_].*
description
string (PersisterConfigAttributeDescription) <= 65535 characters
type
required
string (PersisterConfigAttributeType)
object (PersisterConfigAttributeS3)
format
required
string (PersisterConfigAttributeS3Format)
Enum: "csv" "parquet" "json-lines" "raw"
Array of objects (PersisterConfigDataFilters)
Array of objects (PersisterConfigIgnoreDataFilters)
Array of objects (PersisterConfigNodes)

対象ノードIDを指定します。空の場合は全てのノードを対象とします。本属性と ignore_nodes 属性の両方に同じノードIDを指定した場合は、ignore_nodes 属性が優先されます。

Array of objects (PersisterConfigIgnoreNodes)

除外するノードIDを指定します。 本属性と nodes 属性の両方に同じノードIDを指定した場合は、本属性が優先されます。

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-persister",
  • "description": "永続化設定です",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ]
}

Get Persister Config

永続化拡張モジュール設定を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "2f8df301-7a2f-4b6b-a289-7a24f24e9101",
  • "name": "my-persister",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "is_shared_global": false,
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Persister Config

永続化拡張モジュール設定を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Request Body schema: application/json
name
string (PersisterConfigAttributeName) <= 255 characters [0-9][a-z][A-Z][-_].*
description
string (PersisterConfigAttributeDescription) <= 65535 characters
type
string (PersisterConfigAttributeType)
object
Array of objects (PersisterConfigDataFilters)
Array of objects (PersisterConfigIgnoreDataFilters)
Array of objects (PersisterConfigNodes)

対象ノードIDを指定します。空の場合は全てのノードを対象とします。本属性と ignore_nodes 属性の両方に同じノードIDを指定した場合は、ignore_nodes 属性が優先されます。

Array of objects (PersisterConfigIgnoreNodes)

除外するノードIDを指定します。 本属性と nodes 属性の両方に同じノードIDを指定した場合は、本属性が優先されます。

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-persister",
  • "description": "永続化設定です",
  • "type": "s3",
  • "s3": {
    },
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "2f8df301-7a2f-4b6b-a289-7a24f24e9101",
  • "name": "my-persister",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "is_shared_global": false,
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Persister Config

永続化拡張モジュール設定を削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Responses

Enable Persister Config

永続化拡張モジュールを無効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "2f8df301-7a2f-4b6b-a289-7a24f24e9101",
  • "name": "my-persister",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "is_shared_global": false,
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Disable Persister Config

永続化拡張モジュールを有効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "2f8df301-7a2f-4b6b-a289-7a24f24e9101",
  • "name": "my-persister",
  • "type": "s3",
  • "s3": {
    },
  • "format": "csv",
  • "is_shared_global": false,
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Test Saved Persister Config

永続化拡張モジュール設定をテストします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
persister_config_uuid
required
string
Example: 3f22db04-0f7f-4ea6-8d2d-7ab94408d4e9

永続化モジュール設定のUUID

Request Body schema: application/json
name
string (PersisterConfigAttributeName) <= 255 characters [0-9][a-z][A-Z][-_].*
description
string (PersisterConfigAttributeDescription) <= 65535 characters
type
string (PersisterConfigAttributeType)
object
Array of objects (PersisterConfigDataFilters)
Array of objects (PersisterConfigIgnoreDataFilters)
Array of objects (PersisterConfigNodes)

対象ノードIDを指定します。空の場合は全てのノードを対象とします。本属性と ignore_nodes 属性の両方に同じノードIDを指定した場合は、ignore_nodes 属性が優先されます。

Array of objects (PersisterConfigIgnoreNodes)

除外するノードIDを指定します。 本属性と nodes 属性の両方に同じノードIDを指定した場合は、本属性が優先されます。

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-persister",
  • "description": "永続化設定です",
  • "type": "s3",
  • "s3": {
    },
  • "data_filters": [
    ],
  • "ignore_data_filters": [
    ],
  • "nodes": [
    ],
  • "ignore_nodes": [
    ]
}

Edge Connections

List Edge Connections

エッジ接続のリストを取得します。 エッジ接続は、エッジがiSCPプロトコル（/api/iscp/connect エンドポイントなど）を使用してサーバーに接続したときに新規作成され、 3日間更新がないと削除されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

query Parameters
edge
Array of strings
Example: edge=b55e3351-97e2-4db1-ac90-60fda8b3d144

エッジのUUID

group_by_edge
boolean
Default: false

最新接続日時でエッジごとにグルーピングするかどうか

sort
string
Default: "last_lived_at"
Enum: "last_lived_at" "created_at" "updated_at"
Example: sort=last_lived_at

並べ替えに使用するキー

order
string
Default: "desc"
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

limit
integer
Default: 100
Example: limit=100

1回のリクエストで取得する件数

page
integer
Default: 1
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": null
}

Get Edge Connection

エッジ接続（ /v1/ws/measurements に接続されたエッジの接続情報）を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

edge_connection_uuid
required
string
Example: e0326d93-6e94-4edf-92a2-961cc1c07414

エッジ接続のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "created_at": "2017-02-11T01:23:45Z",
  • "downstreams": [
    ],
  • "edge": {
    },
  • "last_lived_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "upstreams": [
    ],
  • "uuid": "e0326d93-6e94-4edf-92a2-961cc1c07414"
}

Data Point Model

required
integer or string (DataPointTime)
measurement_uuid
required
string

このデータポイントが含まれる計測のUUID

created_at
required
string

このデータポイントが作成された日時

data_type
required
string

データ型

data_name
required
string

データ名称

data_id
required
string
Deprecated

データID 非推奨 変わりに data_name を使用してください

data
required
object (DataPointDataMap)

データのペイロード。ペイロードのJSON表現はデータタイプによって異なります。 詳説iSCP 1.0 の「付録: データタイプとペイロードの定義」を参照してください。 iscpv1に当てはまらない場合、下記のフォーマットで固定となります。

{
  "d": "データ本体のBase64表記"
}
Example
{
  • "time": 0,
  • "measurement_uuid": "string",
  • "created_at": "string",
  • "data_type": "string",
  • "data_name": "*",
  • "data_id": "string",
  • "data": { }
}

Data Points

List Data Points

データポイントのリストを取得します。 返却されるデータポイントはJSON形式です。データポイントごとに改行で区切られます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
name
required
string
Example: name=8f40b21c-f2c4-4fa5-8fe3-325491a59597

どの計測またはどのエッジのデータポイントを取得するかを、以下のいずれかを使って指定します：

  • 計測UUID
  • エッジUUID
  • エッジの名前

最初に、指定されたnameに一致する計測UUIDがあるかが検索されます。なければ一致するエッジUUIDがあるかが検索され、それもなければ一致するエッジの名前があるかが検索されます。

idq
Array of strings
Deprecated
Example: idq=data_type:data_name

非推奨 です。 data_id_filter を使用してください。両方指定した場合、本属性は無視されます。 取得したいデータポイントの条件を以下のフォーマットで指定します。

  • <data_type>:<data_id>

data_type 、 data_id は GET /data_ids エンドポイントで取得できます。

各セグメントにはワイルドカード(*)を使用することができます。

例:

  • データタイプが string かつ、データ名が任意のものを取得する -> string:* または string
    • ※ iSCPv1で永続化されたデータはデータタイプが10進数となることに注意してください。詳細は以下の「参考2」を参照してください。

参考１ iSCP v2形式で保存されたデータの場合

iSCP v2形式で保存されたデータポイントの data_type 、 data_id は次のようになります。

  • data_type：<iSCPv2におけるデータ型>

  • data_id：<iSCPv2におけるデータ名称>

例:

  • iSCPv2で永続化された、データ型が「string」のデータポイントを取得する：string:* または string
  • iSCPv2で永続化された、データ型が「string」で、データ名称が「my-data」のデータポイントを取得する：string:my-data

参考２ iSCP v1形式で保存されたデータの場合

iSCP v1形式で保存されたデータポイントの data_type 、 data_id は次のようになります。

  • data_type：<iSCPv1におけるデータタイプ(10進数表記)>

  • data_id：<iSCPv1におけるチャンネル(10進数表記)>/<iSCPv1におけるデータID>

例:

  • iSCPv1で永続化された、CAN(データタイプが「1」)のデータポイントを取得する：1:*/* または 1
  • iSCPv1で永続化された、チャンネル2のCANデータポイントを取得する：1:2/* または 1:2
  • iSCPv1で永続化された、チャンネル2のCANデータポイントのうち、データIDが 「00000001」 のものを取得する：1:2/00000001
data_id_filter
Array of strings
Example: data_id_filter=string:string-data-name

取得したいデータポイントの条件をiSCPv2のデータIDフィルターのフォーマットで指定します。 データIDフィルターのフォーマットは データ型（data_type） 、 データ名称（ data_name ）を使用してデータのフィルタ処理を行います。

フィルター文字列は : の前後でデータ型とデータ名称に区切られます。基本的な構造は次の通りです。

  • <data_type>:<data_name>

data_type と data_name はさらに / で内部を分割することができます。その場合 ワイルドカード + と # を使用して、より詳細なフィルタリング条件を定義できます。 以下に、このフィルター表現の使用方法についての詳細な説明を示します。

セグメントとワイルドカードの使用

  • セグメント

    • / で区切られたデータ型またはデータ名称の内部構造を表現します。これにより、階層的なデータ構造やパスのような形式でデータを指定できます。

  • + ワイルドカード

    • 一つのセグメントに完全に一致する任意の文字列を示します。これを使用することで、特定の位置のセグメントの任意値に、マッチする条件を設定できます。

  • # ワイルドカード

    • 一つまたは複数のセグメントに完全に一致する任意の文字列を示します。これにより、任意の深さの階層を持つデータに対して、柔軟なマッチング条件を提供できます。

使用例

  1. 完全一致

    • フィルター a/b:c/d は、データ型が a/b でデータ名称が c/d である文字列に対して完全にマッチします。

  2. + ワイルドカード （一つのセグメントの完全一致）

    • データ型内での使用例: フィルター a/+:c/d は、データ型 a/ の直下にある任意のセグメント（例: a/b a/x など）と、データ名称 c/d にマッチします。 a:<任意のデータ名称> にはマッチしません。
    • データ名称での使用例: フィルター a/b:c/+ は、データ型 a/b と、データ名称 c/ の直下にある任意のセグメント（例: c/d , c/x など）にマッチします。 <任意のデータ型>:c にはマッチしません。

  3. # ワイルドカード （複数のセグメントの完全一致）

    • データ型での使用例: フィルター #:c/d は、任意のデータ型（例: a/b や x/y/z など）と、c/d というデータ名称にマッチします。
    • データ名称での使用例: フィルター a/b:# は、a/b というデータ型と、任意の深さのセグメントを持つデータ名称（例: c/d や e/f/g など）にマッチします。

iSCPv2のデータIDとフィルターについての詳細は以下のリンクを参照します。

参考 iSCP v1形式で保存されたデータの場合

iSCP v1形式で保存されたデータポイントの data_type 、 data_name は次のようになります。

  • data_type：<iSCPv1におけるデータタイプ(10進数表記)>
  • data_name：<iSCPv1におけるチャンネル(10進数表記)>/<iSCPv1におけるデータID>

例:

  • iSCPv1で永続化された、CAN(データタイプが「1」)のデータポイントを取得する：1:#
  • iSCPv1で永続化された、チャンネル2のCANデータポイントを取得する：1:2/#
  • iSCPv1で永続化された、チャンネル2のCANデータポイントのうち、データIDが 「00000001」 のものを取得する：1:2/00000001
start
string
Example: start=2019-10-29T03:04:05.123456Z

取得対象区間の始点（始点は対象区間に含まれます）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

取得対象区間の終点（終点は対象区間に含まれません）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
since
string
Example: since=2019-10-29T03:04:05.341268Z

指定した時刻以降に更新された計測のみを取得します。 以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z).
  • UNIX時刻（マイクロ秒）(Deprecated).
exit_on_error
string
Default: false
Example: exit_on_error=false

true を指定した場合、取得中にエラーが発生すると処理を中断し、中断前までのデータポイントのリストを返します。

label
Array of strings
Example: label=label

信号定義のラベル

limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序。デフォルトは asc （昇順）

time_format
string
Enum: "ns" "us" "ms" "s" "rfc3339"
Example: time_format=rfc3339

レスポンスの時刻表示形式。デフォルトは us （マイクロ秒）

Responses

Response samples

Content type
"string"

List Data IDs

データポイントのデータID（ data_type, data_id ）のリストを取得します。

name で計測UUIDを指定した場合、 start / end パラメーターは無視されます。

name でエッジUUIDまたはエッジの名前を指定した場合、 start / end パラメーターを使ってそのエッジの計測をさらに絞り込むことができます。 この場合、 start / end で指定された区間内に基準時刻を持つ計測のみが対象となり、その計測に含まれるデータIDが取得されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
name
required
string
Example: name=8f40b21c-f2c4-4fa5-8fe3-325491a59597

どの計測またはどのエッジのデータポイントを取得するかを、以下のいずれかを使って指定します：

  • 計測UUID
  • エッジUUID
  • エッジの名前

最初に、指定されたnameに一致する計測UUIDがあるかが検索されます。なければ一致するエッジUUIDがあるかが検索され、それもなければ一致するエッジの名前があるかが検索されます。

start
string
Example: start=2019-10-29T03:04:05.123456Z

取得対象区間の始点（始点は対象区間に含まれます）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

取得対象区間の終点（終点は対象区間に含まれません）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Measurements

List Measurements

計測のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
uuid
Array of strings
Example: uuid=5c3ac8b5-3acd-43ea-86cb-4835664b0483

計測のUUID

name
string
Example: name=measurement1

名前が指定した文字列から始まる計測を取得します。 文字列をダブルクォーテーションで囲むと、完全一致のものだけが取得されます。

edge_uuid
string
Example: edge_uuid=e0022b03-023f-4f24-90f1-560be10c423b

計測に関連付けられたエッジのUUID

start
string
Example: start=2019-10-29T03:04:05.123456Z

計測を取得するための対象区間の始点（始点は対象区間に含まれます）。 計測の基準時刻が、ここで指定した時刻と同じかそれより後の場合、その計測は取得対象になります。 ただし、 partial_match を true にした場合については partial_match の説明を参照してください。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

計測を取得するための対象区間の終点（終点は対象区間に含まれません）。 計測の基準時刻が、ここで指定した時刻よりも前の場合、その計測は取得対象になります。 ただし、 partial_match を true にした場合については partial_match の説明を参照してください。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
partial_match
boolean
Default: false
Example: partial_match=true

false の場合、 start と end によって指定された取得対象区間に 基準時刻(basetime)が入っていると、その計測は取得対象になります。

true の場合、取得対象区間に計測の一部でも入っていると、その計測は取得対象となります。 計測の始点は基準時刻(basetime)、終点は基準時刻に長さを加えたもの(basetime+max_elapsed_time)です。

以下の図の例では、 partial_match=false のように指定すると、 measurement2 と measurement3 が取得されます。

partial_match=true のように指定すると、 measurement1 、 measurement2 、 measurement3 が取得されます。

                   :                            :
                   :                            :
           | measurement1 |                     :
           +--------------+                     :
                   :           | measurement2 | :
                   :           +--------------+ :
                   :                       | measurement3 |
                   :                       +--------------+
    | measurement4 |                            :
    +--------------+                            :
                   :                            | measurement5 |
                   :                            +--------------+
                   :                            :
                   :                            :            time
-------------------+----------------------------+--------------->
                   |                            |
                  start                        end

partial_match=true の場合の計測の端点の扱いは以下のようになります。

  • 「計測の終点(=basetime+max_elapsed_time) == 取得対象区間のstart」の場合、 その計測は取得されません（上図のmeasurement4）。

  • 「計測の始点(=basetime) == 取得対象区間の end 」の場合も、 その計測は取得されません（上図のmeasurement5）。

basetime_type
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: basetime_type=ntp

計測の基準時刻のタイプ

ended
boolean

計測が終了している（ended）かどうかを指定して計測を取得します。

エッジにおいてデータの取得が終了している場合、その計測は「終了(ended)」となります。 計測は終了(ended)していても、まだサーバーに送信されていないデータがエッジに残っている可能性があります。

  • true: 終了した計測だけを取得します。
  • false: 終了していない計測だけを取得します。
since
string
Example: since=2019-10-29T03:04:05.341268Z

指定した時刻以降に更新された計測のみを取得します。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
duration_start
integer <int64>
Example: duration_start=100

計測時間の最小値（マイクロ秒）。これより短い計測は取得しません。

duration_end
integer <int64>
Example: duration_end=100000

計測時間の最大値（マイクロ秒）。これより長い計測は取得しません。

status
Array of strings
Items Enum: "measuring" "resending" "finished"
Example: status=measuring

計測のステータス

limit
integer <int32>
Default: 1000
Example: limit=1000

1回のリクエストで取得する件数。ただし、0を指定するとデフォルトの値が使用されます。

sort
string
Default: "base_time"
Enum: "name" "description" "ended" "duration" "base_time" "processed_ratio" "created_at" "updated_at"
Example: sort=base_time

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Measurement

計測を作成します。

  • Note
    • 計測の保護／非保護を切り替える権限を持たないエッジも、 計測作成時は保護された計測を作成することが可能です。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime
required
string <date-time>

計測の基準時刻（計測が開始された時刻）

basetime_type
required
string (MeasurementBaseTimeType)
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ。この属性に加えて、 basetime_priority と 任意の basetime_name も同時に設定することを推奨します。 undefined を指定した場合は、接頭辞 basetime_ 及び basetime の属性は無視される事にご注意ください。

basetime_priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

basetime_name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

basetime_elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

edge_uuid
required
string

この計測に関連付けられたエッジのUUID

protected
required
boolean
Deprecated

true の場合、計測は保護されます。保護されている計測は削除できません。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "protected": false
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Get Measurement

計測を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Create Measurement with UUID

指定したUUIDの計測を作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime
required
string <date-time>

計測の基準時刻（計測が開始された時刻）

basetime_type
required
string (MeasurementBaseTimeType)
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ。この属性に加えて、 basetime_priority と 任意の basetime_name も同時に設定することを推奨します。 undefined を指定した場合は、接頭辞 basetime_ 及び basetime の属性は無視される事にご注意ください。

basetime_priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

basetime_name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

basetime_elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

edge_uuid
required
string

この計測に関連付けられたエッジのUUID

protected
required
boolean
Deprecated

true の場合、計測は保護されます。保護されている計測は削除できません。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "protected": false
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Update Measurement

計測に関する情報を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime_type
string (MeasurementBaseTimeType)
Deprecated
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ 非推奨 代わりに基準時刻APIを使用して、当該基準時刻の優先度を明示的に設定してください。この値をセットすると、基準時刻タイプの優先度を強制的に一番高いものに変更します。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime_type": "ntp",
  • "max_priority_basetime_id": 1
}

Trash Measurement

計測を削除します。

  • Note
    • 保護された計測は削除できません。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Complete Measurement

計測を回収完了（completed）にします。 completedは、エッジでのデータ取得が終了し（ended）、 かつ、すべてのデータがサーバーに送信されたことを意味します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

End Measurement

計測終了（ended）とします。endedは、エッジにおけるデータの取得が終了していることを表します。 （サーバーに回収されていないデータがまだエッジに残っている可能性はあります。サーバーへのデータの回収が完了した状態は、completedと呼びます。）

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "received_chunks_ratio": 0.5,
  • "received_data_points": 123456789,
  • "expected_data_points": 123456789,
  • "status": "measuring"
}

Get Measurement from Marker

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Measurement Base Times

List Measurement Base Times

計測の基準時刻のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Create Measurement Base Time

計測の基準時刻を作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
basetime
required
string <date-time> (MeasBaseTimeBaseTime)

基準時刻（計測が開始された時刻）（RFC3339形式）

priority
required
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

name
required
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

elapsed_time
required
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

Responses

Request samples

Content type
application/json
{
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "type": "edge_rtc",
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Measurement Base Time by ID

基準時刻IDを指定して計測の基準時刻を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

id
required
integer <int64> (MeasBaseTimeID)
Example: 1

基準時刻のID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "type": "edge_rtc",
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Measurement Base Time by ID

基準時刻を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

id
required
integer <int64> (MeasBaseTimeID)
Example: 1

基準時刻のID

Request Body schema: application/json
basetime
string <date-time> (MeasBaseTimeBaseTime)

基準時刻（計測が開始された時刻）（RFC3339形式）

priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

Responses

Request samples

Content type
application/json
{
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "type": "edge_rtc",
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Measurement Base Time by ID

基準時刻を削除します。 指定された基準時刻が使用中の場合（その計測の basetime_type として設定されている場合）は、 その基準時刻は削除できません（ステータスコード 409 が返却されます）。 このような場合は、他の基準時刻をその計測の basetime_type にしてから、削除したい基準時刻を削除してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

id
required
integer <int64> (MeasBaseTimeID)
Example: 1

基準時刻のID

Responses

Measurement Sequences

List Measurement Sequences

計測シーケンスのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Measurement Sequence

計測シーケンスを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Measurement Sequence

計測シーケンスを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Request Body schema: application/json
expected_data_points
integer <int64> >= 0

この計測シーケンスでサーバーが受信することが想定されるデータポイントの総数 （既に受信済みのデータポイントを含む） 符号なし64bit整数。

final_sequence_number
integer <int64> [ 0 .. 4294967295 ]

この計測シーケンスに含まれるチャンクに付与された最後のシーケンス番号

Responses

Request samples

Content type
application/json
{
  • "expected_data_points": 123456789,
  • "final_sequence_number": 10
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Replace Measurement Sequence

計測シーケンスを置換します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Request Body schema: application/json
expected_data_points
integer <int64> >= 0

この計測シーケンスでサーバーが受信することが想定されるデータポイントの総数 （既に受信済みのデータポイントを含む） 符号なし64bit整数。

final_sequence_number
integer <int64> [ 0 .. 4294967295 ]

この計測シーケンスに含まれるチャンクに付与された最後のシーケンス番号

Responses

Request samples

Content type
application/json
{
  • "expected_data_points": 123456789,
  • "final_sequence_number": 10
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create Measurement Sequence Chunk

計測シーケンスにチャンクを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema:
string <binary>

protocol.protoのStoreDataChunksを参照してくだいさい。

StoreDataPointのpayloadは iSCP v2のデータフォーマットに従います。この資料は現在準備中です。

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 1
}

Measurement Jobs

List Measurement Jobs

ジョブ（CSVファイルを計測に変換するジョブなど）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

status
Array of strings
Items Enum: "ready" "processing" "succeeded" "failed" "cancelled"
Example: status=succeeded

ジョブのステータス

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Measurement Job

ジョブを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "meas_uuid": "a72c674a-e8e9-43bc-940f-a034853363e1",
  • "status": "succeeded",
  • "message": "Succeeded",
  • "file_name": "sample.csv",
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Delete Measurement Job

ジョブを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

Cancel Measurement Job

ジョブをキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

Measurement Markers

List Measurement Markers

計測マーカーのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
uuid
Array of strings
Example: uuid=c14f84c1-b7a5-459b-bd1e-35982e4a4f38

計測マーカーのUUID

name
Array of strings
Example: name=measurement marker1

計測マーカーの名前

start_unix_micro
integer <int64>
Example: start_unix_micro=1000

取得対象区間の始点（マイクロ秒単位のUNIX時刻）（始点は対象区間に含まれます）。 範囲マーカーについては、マーカーの始点が取得対象区間に入っている場合に取得されます。

end_unix_micro
integer <int64>
Example: end_unix_micro=1000

取得対象区間の終点（マイクロ秒単位のUNIX時刻）（終点は対象区間に含まれません）。 範囲マーカーについては、マーカーの始点が取得対象区間に入っている場合に取得されます。

tag.<key>
Array of strings
Example: tag.<key>=include_tag_value

タグのキーと値を使って条件を指定し、条件に一致する計測マーカーを取得します。 キーのみを指定した場合は、指定されたキーを持つ計測マーカーを取得します。 キーと値を指定した場合は、指定されたキーを持ち、その値として指定された値を含む計測マーカーを取得します。 tag.<key>=<value> 条件は複数個指定することができ、OR条件で使用されます。 ただし !tag.<key> と組み合わせた場合、 !tag.<key> が優先されます。

例:

| measurement marker | tag (key: value) |
| ------------------ | ---------------- |
| 1                  | a: value1        |
|                    | c: value2        |
|                    | e: 1             |

| 2                  | a: b             |
|                    | c: d             |

| 3                  | a: b             |
  • ?tag.e= の場合、計測マーカー1番が取得されます。
  • ?!tag.c= の場合、計測マーカー3番が取得されます。
  • ?tag.a=&!tag.e= の場合、計測マーカー2、3番が取得されます。
  • ?tag.a=val&tag.c=d の場合、計測マーカー1、2番が取得されます。
!tag.<key>
Array of strings
Example: !tag.<key>=exclude_tag_value

タグのキーを使って条件を指定し、条件に一致する計測キャプチャを除外します。 タグの値は無視されます。 !tag.<key> を複数個指定した場合、AND条件となります。 また、 tag.<key>=<value> と組み合わせて使用した場合、 tag.<key>=<value> よりも !tag.<key> が優先されます。 例: 上の tag.<key> の説明を参照してください。

limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "base_time"
Enum: "name" "base_time" "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Measurement Marker

計測マーカーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6",
  • "name": "name",
  • "description": "description",
  • "type": "range",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Update Measurement Marker

計測マーカーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "range",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6",
  • "name": "name",
  • "description": "description",
  • "type": "range",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Delete Measurement Marker

計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Delete Measurement Markers by Measurement UUID

計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Create Measurement Marker by Measurement UUID

計測マーカーを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
required
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
required
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Delete Measurement Marker by Measurement UUID

計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Replace Measurement Marker by Measurement UUID

計測マーカーの情報を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Uploading Measurements

Create Measurement from CSV File

CSVまたはMP4（MP4はexperimental）ファイルをアップロードし、計測を作成します。 計測には、指定されたエッジUUIDが関連付けられます。

base_time （基準時刻）は、RFC3339による表現か、UNIX時刻（マイクロ秒）を指定してください。 基準時刻が指定されていない場合は、CSVファイルのデータ行の1行目の時刻が基準時刻として使用されます。 CSVファイルのデータは、時刻順にソートされている必要があります。 meas_end パラメーターの設定は任意です。指定しない場合、 true となります。

CSVファイルの例:

time,       col1,   col2, col3,      col4,   col5, col6,      col7,   col8, col9,      col10
1539263579, val11,  12,   13.12345,  val14,  15,   16.12345,  val17,  18, 19.12345,  val110
1539263580, val21,  22,   23.12345,  val24,  25,   26.12345,  val27,  28, 29.12345,  val210
1539263581, val31,  32,   33.12345,  val34,  35,   36.12345,  val37,  38, 39.12345,  val310
1539263582, val41,  42,   43.12345,  val44,  45,   46.12345,  val47,  48, 49.12345,  val410

空白行がある場合、行番号のカウントは加算されますが、その行は処理されません。 例えば、以下のような場合の空白行は無視されます。

time,       col1,   col2, col3,      col4,   col5, col6,      col7,   col8, col9,      col10
1539263579, val11,  12,   13.12345,  val14,  15,   16.12345,  val17,  18, 19.12345,  val110

1539263581, val31,  32,   33.12345,  val34,  35,   36.12345,  val37,  38, 39.12345,  val310
1539263582, val41,  42,   43.12345,  val44,  45,   46.12345,  val47,  48, 49.12345,  val410

Go parser library も参照してください。

時刻の列には、RFC3339による表現か、UNIX時刻（秒）を使用することができます。

エスケープ

値の内部で , を使用したい場合は、その値全体を " で囲んでください。 また、値の内部で " を使用したい場合は、値全体を " で囲み、さらに、 " を "" のように表記してください。 値を " で囲まないと、CSVファイルのパースの際にエラーが発生します。

エスケープの例:

time,col1
1539263579,"ab,cde"                  .....OK (parsed as 'ab,cde')
1539263579,"ab""cde"                 .....OK (parsed as 'ab"cde')
1539263579,     abcde                .....OK (parsed as '     abcde')
1539263579,"     abcde"              .....OK (parsed as '     abcde')
1539263579,ab"cde                    .....NG
1539263579, "abcde"                  .....NG
1539263579,ab,cde                    .....NG(wrong number of fields)
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema: multipart/form-data
edge_uuid
required
string <uuid>

エッジのUUID

base_time
string <date-time>

計測の基準時刻。MP4ファイルをアップロードする場合は必須です。

base_time_type
string
Default: "edge_rtc"
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

基準時刻のタイプ

channel
integer

計測のチャンネル（十進表記の文字列）

meas_end
boolean

true にすると、計測は終了したものとして扱われます。

label_data_type
string <json> (LabelDataType)

列名とデータタイプの対応。 データタイプは、 int 、 string 、 float のいずれかを指定してください。 例:

{
  "column_1": "float",
  "column_2": "string",
  "column_3": "int"
}
data_file
required
string <binary>

アップロードするファイル

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "meas_upload_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "job_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "file_name": "filename.csv"
}

Trashed Measurements

List Trashed Measurements

ゴミ箱に入っている計測のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
uuid
Array of strings <uuid>
Example: uuid=11111111-1111-1111-1111-111111111111

ゴミ箱に入っている計測のUUID。

limit
integer [ 0 .. 50 ]
Example: limit=1

1回のリクエストで取得する件数。0 を指定した場合は、デフォルト値の50件となります。

page
integer >= 0
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 1
}

Delete Trashed Measurement and Its Data Points Immediately

ゴミ箱に入っている計測と、その計測に関連付けられているデータポイントを直ちに削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 86fff159-5887-43c9-bf2d-cd1b522c047d

計測のUUID

Responses

Restore Measurement

ゴミ箱に入っている計測を復元します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 86fff159-5887-43c9-bf2d-cd1b522c047d

計測のUUID

Responses

HLS Jobs

List HLS Jobs

HLSへの変換ジョブのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
uuid
Array of strings
Example: uuid=ade4eea8-edc6-3ca5-c557-12a616c2028a

取得したいジョブのUUID

meas_uuid
Array of strings
Example: meas_uuid=a5170afc-9cc2-5327-e0e1-32746b5a7977

計測のUUID

type
Array of strings (JobType)
Items Enum: "update" "finalize" "delete"
Example: type=update
  • update
    • 計測内の動画データのうち、新しくサーバーが受信した部分（HLSにまだ変換されていない部分）を HLSに変換するジョブ。通常は計測実行中に行います。
  • finalize
    • 計測全体をサーバーに回収した後に、動画データ全体をHLSに変換するジョブ
  • delete
    • 変換によって作成されたHLSデータを削除するジョブ。 このジョブを実行すると、HLSプレイリスト、セグメントファイル、 データベース内のHLSに関する情報が削除され、この動画のHLSによる再生はできなくなります。
status
Array of strings (JobStatus)
Items Enum: "unprocessed" "processing" "succeeded" "failed"
Example: status=succeeded

ジョブのステータス

limit
number
Example: limit=1000

1回のリクエストで取得する件数

page
integer >= 1
Default: 1

取得するページ番号

sort
string
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 100
}

Create HLS Job

HLSへの変換ジョブを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema: application/json
meas_uuid
required
string

計測のUUID

type
required
string (JobType)
Enum: "update" "finalize" "delete"
  • update
    • 計測内の動画データのうち、新しくサーバーが受信した部分（HLSにまだ変換されていない部分）を HLSに変換するジョブ。通常は計測実行中に行います。
  • finalize
    • 計測全体をサーバーに回収した後に、動画データ全体をHLSに変換するジョブ
  • delete
    • 変換によって作成されたHLSデータを削除するジョブ。 このジョブを実行すると、HLSプレイリスト、セグメントファイル、 データベース内のHLSに関する情報が削除され、この動画のHLSによる再生はできなくなります。

Responses

Request samples

Content type
application/json
{
  • "meas_uuid": "a5170afc-9cc2-5327-e0e1-32746b5a7977",
  • "type": "update"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "ade4eea8-edc6-3ca5-c557-12a616c2028a",
  • "meas_uuid": "a5170afc-9cc2-5327-e0e1-32746b5a7977",
  • "type": "update",
  • "status": "unprocessed",
  • "message": "ok",
  • "created_at": "2000-01-02T03:04:5Z",
  • "updated_at": "2000-01-02T03:04:5Z"
}

Videos

List Videos

動画（video）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
uuid
string
Example: uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

動画（video）のUUID

meas_uuid
string
Example: meas_uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

計測のUUID

channel
integer
Example: channel=1

チャンネル

sort
string
Default: "create_at+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。例えば、 name- を指定すると、nameによる降順で出力されます。

  • channel
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページ番号

per_page
integer <= 1000
Default: 100

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Video

動画を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "68b91013-47e9-4e68-a965-892549587dfa",
  • "measurement_uuid": "d299eea4-d02c-4742-a97a-795346a0c005",
  • "measurement": {
    },
  • "edge_uuid": "a8afa022-7e60-4f6a-8686-5b99d8785d25",
  • "channel": 1,
  • "codec": "h264",
  • "source_data_type": "h264",
  • "source_data_name": "h264_camera_1",
  • "offset_time": 0,
  • "duration": 10000,
  • "fps": 29.98,
  • "width": 1920,
  • "height": 1080,
  • "status": "succeeded",
  • "hls": {
    },
  • "mp4s": [
    ],
  • "jpegs": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

MP4 Videos

List MP4s

動画（video）から変換されたMP4データのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create MP4

動画（video）を変換してMP4データを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Request Body schema: application/json
trimmed
boolean

時間範囲を指定してその部分のMP4を作成する場合は true にします。

start_offset
integer

動画の開始時刻からのオフセット（マイクロ秒）。trimmedがtrueの場合は必須です。

duration
integer

長さ（マイクロ秒）。trimmedがtrueの場合は必須です。

Responses

Request samples

Content type
application/json
{
  • "trimmed": false,
  • "start_offset": 0,
  • "duration": 10000
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get MP4

動画（video）から変換されたMP4データの情報を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete MP4

動画（video）から変換されたMP4データを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Cancel Creating MP4

動画（video）からMP4データへの変換をキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

JPEG Videos

List JPEGs

動画（video）から変換されたJPEGデータのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create JPEG

動画（video）を変換してJPEGデータを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Request Body schema: application/json
trimmed
boolean

時間範囲を指定してその部分のJPEGを作成する場合は true にします。

start_offset
integer

計測開始からのオフセット（マイクロ秒）。trimmedがtrueの場合は必須です。

duration
integer

長さ（マイクロ秒）。trimmedがtrueの場合は必須です。

fps
number <float>

フレームレート。値が省略された場合は、元のデータと同じフレームレートが使用されます。

quality
string (JpegQuality)
Enum: "high" "middle" "low"

JPEGの品質。デフォルトは 'middle' です。

  • high
  • middle
  • low

Responses

Request samples

Content type
application/json
{
  • "trimmed": false,
  • "start_offset": 0,
  • "duration": 10000,
  • "fps": 15,
  • "quality": "high"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get JPEG

動画（video）から変換されたJPEGデータの情報を取得します。 JPEGファイル自体を取得するには、GET /media/projects/{project_uuid}/videos/{video_uuid}/jpegs/{jpeg_uuid}/images/selected.zip を使用してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete JPEG

動画（video）から変換されたJPEGデータを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Cancel Creating JPEG

動画（video）からJPEGデータへの変換をキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get JPEG as zip

JPEGデータをZIPファイルにまとめた形で取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

query Parameters
indexes
Array of integers
Example: indexes=1

取得したいJPEGのインデックス番号（最初の番号は1）。指定がない場合はすべて取得します。 indexes パラメーターを複数回指定することで、複数のJPEGファイルを取得することができます。

Responses

Use Webhook

Use Hook

Hookを使用すると、intdash-apiのイベントをHTTPのPOSTリクエストを取得することができます。 Hookを使用する流れは次のとおりです。

  1. Hookの登録する
  2. Hookサーバーアプリケーションを実装する
  3. Hookのテストを行う
  4. Hookを有効化する。

また、登録時のシークレットを使用することで、intdashからのリクエストであることを証明することができます。 シークレットを登録するとintdashはリクエストしたペイロードをシークレットでHMAC署名します。 署名は X-Intdash-Signature-256 リクエストヘッダに設定され、アプリケーションへリクエストされます。

アプリケーションはリクエストヘッダに指定された署名を検証することで、intdashからのリクエストであることを判定できます。

Hooks Request

フックのリクエストボディスキーマ次のとおりです。

delivery_uuid
required
string <uuid> (HookUUID)
hook_uuid
required
string <uuid> (HookUUID)
resource_type
required
string (HookResourceType)
action
required
string (HookEdgeAction)
Enum: "created" "deleted" "updated"
edge_uuid
required
string <uuid> (HookEdgeUUID)

対象となるエッジUUID。テスト実行時はランダム値となります。

is_test
required
boolean (HookIsTest)

テスト実行かどうか

tenant_id
integer (HookTenantID)

対象となるテナントのID。テナントIDは共有グローバルフックにのみ付与されます。

occurred_at
required
string <date-time> (HookReceiverOccurredAt)

発生時刻

Example
{
  • "delivery_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "resource_type": "edge",
  • "action": "created",
  • "edge_uuid": "3d21d4ae-d1c1-45bd-bdb9-2f967f32370c",
  • "is_test": true,
  • "tenant_id": 0,
  • "occurred_at": "2019-08-24T14:15:22Z"
}

また、フックリクエストは X-Intdash-Resource-Type ヘッダに、リクエストボディスキーマを決めるため resource_type を付与します。 単一のフックに複数のリソースのイベントを処理する場合は、 X-Intdash-Resource-Type を判別して、型を決めることができます。

フックリクエストを受信し、処理が成功したら 2xx 番台のレスポンスを返却します。 2xx番台以外のレスポンスを返した場合、デリバリは失敗扱いとなります。

フックリクエストのタイムアウトは10秒です。 それよりレスポンスが時間がかかる場合はタイムアウトが発生し、デリバリは失敗扱いとなります。

Shared Global Hook

テナントすべてに適用するHookを共有グローバルフックと呼びます。 共有グローバルフックを使用したい場合は、サーバー運用者に問い合わせください。

Hooks

List Hooks

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
hook_uuid
Array of strings <uuid> (HookUUID)
Example: hook_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
enabled
Array of booleans (HookEnabled)
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset:utf-8
url
required
string <uri> (HookURL)

WebhookのURL

secret
string (HookSecret) [ 32 .. 255 ] characters [0-9][a-z][A-Z][-_].*

シークレット。 ペイロードの署名に使用します。詳細は Hooks Request を参照してください。 空の場合はサーバーが鍵を生成します。

edges_events
boolean (HookEdgesEvent)

エッジイベントを表します。 エッジイベントは Hooks Request の resource_type が edge を参照してください。

measurements_events
boolean (HookMeasurementsEvent)

計測イベントを表します。 計測イベントは Hooks Request の resource_type が measurement を参照してください。

users_events
boolean (HookUsersEvent)

ユーザーイベントを表します。 ユーザーイベントは Hooks Request の resource_type が user を参照してください。

edge_connections_events
boolean (HookEdgeConnectionsEvent)

エッジ接続イベントを表します。 エッジ接続イベントは Hooks Request の resource_type が edge_connection を参照してください。

project_edges_events
boolean (HookProjectEdgesEvent)

プロジェクトエッジのイベントを表します。 プロジェクトエッジイベントは Hooks Request の resource_type が project_edge を参照してください。

project_members_events
boolean (HookProjectMemberEvent)

プロジェクトメンバーのイベントを表します。 プロジェクトメンバーイベントは Hooks Request の resource_type が project_member を参照してください。

Responses

Request samples

Content type
application/json; charset:utf-8
{
  • "url": "http://example.com/my-web-hooks",
  • "secret": "stringstringstringstringstringst",
  • "edges_events": false,
  • "measurements_events": false,
  • "users_events": false,
  • "edge_connections_events": false,
  • "project_edges_events": false,
  • "project_members_events": false
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "edges_event": false,
  • "measurements_event": false,
  • "users_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "tenants_event": false,
  • "is_shared_global": true,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "secret": "string"
}

Get Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "edges_event": false,
  • "measurements_event": false,
  • "users_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "tenants_event": false,
  • "is_shared_global": true,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
Request Body schema: application/json; charset:utf-8
url
string <uri> (HookURL)

WebhookのURL

secret
string (HookSecret) [ 32 .. 255 ] characters [0-9][a-z][A-Z][-_].*

シークレット。 ペイロードの署名に使用します。詳細は Hooks Request を参照してください。 空の場合はサーバーが鍵を生成します。

edges_event
boolean (HookEdgesEvent)

エッジイベントを表します。 エッジイベントは Hooks Request の resource_type が edge を参照してください。

measurements_event
boolean (HookMeasurementsEvent)

計測イベントを表します。 計測イベントは Hooks Request の resource_type が measurement を参照してください。

users_event
boolean (HookUsersEvent)

ユーザーイベントを表します。 ユーザーイベントは Hooks Request の resource_type が user を参照してください。

edge_connections_event
boolean (HookEdgeConnectionsEvent)

エッジ接続イベントを表します。 エッジ接続イベントは Hooks Request の resource_type が edge_connection を参照してください。

project_edges_event
boolean (HookProjectEdgesEvent)

プロジェクトエッジのイベントを表します。 プロジェクトエッジイベントは Hooks Request の resource_type が project_edge を参照してください。

project_members_event
boolean (HookProjectMemberEvent)

プロジェクトメンバーのイベントを表します。 プロジェクトメンバーイベントは Hooks Request の resource_type が project_member を参照してください。

Responses

Request samples

Content type
application/json; charset:utf-8
{
  • "url": "http://example.com/my-web-hooks",
  • "secret": "stringstringstringstringstringst",
  • "edges_event": false,
  • "measurements_event": false,
  • "users_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "edges_event": false,
  • "measurements_event": false,
  • "users_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "tenants_event": false,
  • "is_shared_global": true,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138

Responses

Test Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
Request Body schema: application/json; charset:utf-8
resource_type
string (HookResourceType)
action
string (HookEdgeAction)
Enum: "created" "deleted" "updated"

Responses

Request samples

Content type
application/json; charset:utf-8
Example
{
  • "resource_type": "edge",
  • "action": "created"
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Hook Deliveries

List Deliveries of Specific Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
query Parameters
hook_delivery_uuid
Array of strings <uuid> (HookUUID)
Example: hook_delivery_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_redelivered_by
Array of strings <uuid> (HookUUID)
Example: hook_redelivered_by=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
is_redeliver
Array of booleans
is_test
Array of booleans (HookIsTest)
status
Array of strings (HookDeliveryStatus)
Items Enum: "processing" "succeeded" "failed"
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

List Deliveries

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
hook_delivery_uuid
Array of strings <uuid> (HookUUID)
Example: hook_delivery_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_uuid
Array of strings <uuid> (HookUUID)
Example: hook_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_redelivered_by
Array of strings <uuid> (HookUUID)
Example: hook_redelivered_by=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
is_redeliver
Array of booleans
is_test
Array of booleans (HookIsTest)
status
Array of strings (HookDeliveryStatus)
Items Enum: "processing" "succeeded" "failed"
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Delivery

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_delivery_uuid
required
string <uuid>
Example: c6e27662-37ab-4e2c-b5fa-9fa7495bb01b

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Redeliver Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
hook_delivery_uuid
required
string <uuid>
Example: c6e27662-37ab-4e2c-b5fa-9fa7495bb01b

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Project Hooks

List Project Hooks

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
query Parameters
hook_uuid
Array of strings <uuid> (HookUUID)
Example: hook_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
enabled
Array of booleans (HookEnabled)
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
Request Body schema: application/json; charset:utf-8
url
required
string <uri> (HookURL)

WebhookのURL

secret
string (HookSecret) [ 32 .. 255 ] characters [0-9][a-z][A-Z][-_].*

シークレット。 ペイロードの署名に使用します。詳細は Hooks Request を参照してください。 空の場合はサーバーが鍵を生成します。

measurements_event
boolean (HookMeasurementsEvent)

計測イベントを表します。 計測イベントは Hooks Request の resource_type が measurement を参照してください。

edge_connections_event
boolean (HookEdgeConnectionsEvent)

エッジ接続イベントを表します。 エッジ接続イベントは Hooks Request の resource_type が edge_connection を参照してください。

project_edges_event
boolean (HookProjectEdgesEvent)

プロジェクトエッジのイベントを表します。 プロジェクトエッジイベントは Hooks Request の resource_type が project_edge を参照してください。

project_members_event
boolean (HookProjectMemberEvent)

プロジェクトメンバーのイベントを表します。 プロジェクトメンバーイベントは Hooks Request の resource_type が project_member を参照してください。

Responses

Request samples

Content type
application/json; charset:utf-8
{
  • "url": "http://example.com/my-web-hooks",
  • "secret": "stringstringstringstringstringst",
  • "measurements_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "measurements_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "secret": "string"
}

Get Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "measurements_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
Request Body schema: application/json; charset:utf-8
url
string <uri> (HookURL)

WebhookのURL

secret
string (HookSecret) [ 32 .. 255 ] characters [0-9][a-z][A-Z][-_].*

シークレット。 ペイロードの署名に使用します。詳細は Hooks Request を参照してください。 空の場合はサーバーが鍵を生成します。

measurements_event
boolean (HookMeasurementsEvent)

計測イベントを表します。 計測イベントは Hooks Request の resource_type が measurement を参照してください。

edge_connections_event
boolean (HookEdgeConnectionsEvent)

エッジ接続イベントを表します。 エッジ接続イベントは Hooks Request の resource_type が edge_connection を参照してください。

project_edges_event
boolean (HookProjectEdgesEvent)

プロジェクトエッジのイベントを表します。 プロジェクトエッジイベントは Hooks Request の resource_type が project_edge を参照してください。

project_members_event
boolean (HookProjectMemberEvent)

プロジェクトメンバーのイベントを表します。 プロジェクトメンバーイベントは Hooks Request の resource_type が project_member を参照してください。

Responses

Request samples

Content type
application/json; charset:utf-8
{
  • "url": "http://example.com/my-web-hooks",
  • "secret": "stringstringstringstringstringst",
  • "measurements_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "url": "http://example.com/my-web-hooks",
  • "measurements_event": false,
  • "edge_connections_event": false,
  • "project_edges_event": false,
  • "project_members_event": false,
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138

Responses

Test Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
Request Body schema: application/json; charset:utf-8
resource_type
string (HookResourceType)
action
string (HookEdgeAction)
Enum: "created" "deleted" "updated"

Responses

Request samples

Content type
application/json; charset:utf-8
Example
{
  • "resource_type": "edge",
  • "action": "created"
}

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Project Hook Deliveries

List Deliveries of Specific Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_uuid
required
string <uuid>
Example: 1acd5659-5786-4f8d-bca9-6842fdb5b138
query Parameters
hook_delivery_uuid
Array of strings <uuid> (HookUUID)
Example: hook_delivery_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_redelivered_by
Array of strings <uuid> (HookUUID)
Example: hook_redelivered_by=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
is_redeliver
Array of booleans
is_test
Array of booleans (HookIsTest)
status
Array of strings (HookDeliveryStatus)
Items Enum: "processing" "succeeded" "failed"
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

List Project Deliveries

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
query Parameters
hook_delivery_uuid
Array of strings <uuid> (HookUUID)
Example: hook_delivery_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_uuid
Array of strings <uuid> (HookUUID)
Example: hook_uuid=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
hook_redelivered_by
Array of strings <uuid> (HookUUID)
Example: hook_redelivered_by=e42cd906-8e7f-4a1e-8407-f8ca2cc633e1
is_redeliver
Array of booleans
is_test
Array of booleans (HookIsTest)
status
Array of strings (HookDeliveryStatus)
Items Enum: "processing" "succeeded" "failed"
page
integer
Default: 1
Example: page=10
per_page
integer
Default: 100
Example: per_page=10

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Project Delivery

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_delivery_uuid
required
string <uuid>
Example: c6e27662-37ab-4e2c-b5fa-9fa7495bb01b

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Redeliver Project Hook

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string <uuid> (HookUUID)
Example: c8c9bd69-459d-4d83-8df7-d74afc23ba3e
hook_delivery_uuid
required
string <uuid>
Example: c6e27662-37ab-4e2c-b5fa-9fa7495bb01b

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "hook_uuid": "e42cd906-8e7f-4a1e-8407-f8ca2cc633e1",
  • "redelivered_by": "a373d0a8-0003-479e-9115-9724b9d72de8",
  • "status": "processing",
  • "reason": "string",
  • "is_test": true,
  • "request": {
    },
  • "response": {
    },
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Tenants

List Tenants

テナントを取得します。

Authorizations:
BasicAuthForTenantAPI

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Tenant

テナントを作成します。

Authorizations:
BasicAuthForTenantAPI
Request Body schema: application/json

Create a tenant.

name
string <= 255 characters ^[a-zA-Z0-9_-]*$
Default: "uuidの先頭セグメント"
description
string <= 65535 characters
initial_username
string
Default: "intdash"
initial_password
string
Default: "random-temporary-password"
expired_at
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "company1",
  • "description": "string",
  • "initial_username": "intdash",
  • "initial_password": "my-password1234",
  • "expired_at": "2000-01-01T00:00:00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "initial_username": "string",
  • "initial_password": "string",
  • "uuid": "2e3b63e4-f808-463e-a02c-f4954517490e",
  • "name": "company1",
  • "description": "description",
  • "expired_at": "2017-10-03T07:17:10.095527Z",
  • "created_at": "2017-10-03T07:17:10.095527Z",
  • "updated_at": "2017-10-03T07:17:10.095527Z"
}

Update Tenant

テナントを更新します。

Authorizations:
BasicAuthForTenantAPI
path Parameters
tenant_uuid
required
string
Example: 2e3b63e4-f808-463e-a02c-f4954517490e
Request Body schema: application/json

Update a tenant.

name
string <= 255 characters ^[a-zA-Z0-9_-]*$
description
string <= 65535 characters
expired_at
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "company1",
  • "description": "string",
  • "expired_at": "2000-01-01T00:00:00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2e3b63e4-f808-463e-a02c-f4954517490e",
  • "name": "company1",
  • "description": "description",
  • "expired_at": "2017-10-03T07:17:10.095527Z",
  • "created_at": "2017-10-03T07:17:10.095527Z",
  • "updated_at": "2017-10-03T07:17:10.095527Z"
}

Delete Tenant

テナントを削除します。

Authorizations:
BasicAuthForTenantAPI
path Parameters
tenant_uuid
required
string
Example: 2e3b63e4-f808-463e-a02c-f4954517490e

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "scheduled_at": "2017-10-03T07:17:10.095527Z",
  • "created_at": "2017-10-03T07:17:10.095527Z"
}

Get Total Count of Tenants

テナントの数を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "total_count": 1
}

License Usages

List Usage

Authorizations:
BasicAuthForLicenseAPI
query Parameters
start
required
string <date-time>
Example: start=2000-01-01T00:00:00Z
end
required
string <date-time>
Example: end=2000-01-01T00:00:00Z
interval_seconds
required
integer
Example: interval_seconds=60
name
required
string
Example: name=iscp2_upstream_publish_data_points_total:edge_uuid

取得するメトリクス名（必須）とグルーピングするラベル名（任意）を指定します。 グルーピングする場合はコロン(:)とラベル名を文字列に追加します。

以下は指定できるメトリクス名とグルーピングできるラベル名の一覧です。

メトリクス名 ラベル名
iscp2_upstream_publish_data_points_total edge_uuid
iscp2_upstream_publish_data_point_bytes_total edge_uuid
measurement_transfer_data_points_total user_uuid
measurement_transfer_data_point_bytes_total user_uuid

Responses

Response samples

Content type
application/json; charset:utf-8
{
  • "items": [
    ]
}

PasswordPolicy

Get Password Policy

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "min_length": 8,
  • "max_length": 255,
  • "min_alphabet_num": 0,
  • "min_uppercase_alphabet_num": 0,
  • "min_lowercase_alphabet_num": 0,
  • "min_number_num": 0,
  • "min_symbol_num": 0,
  • "allowed_same_username": true,
  • "allowed_save_previous_password": true,
  • "created_at": "2000-01-01T00.00.00Z",
  • "updated_at": "2000-01-01T00.00.00Z"
}

Update Password Policy

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset=utf-8
min_length
integer <int64>
max_length
integer <int64>
min_alphabet_num
integer <int64>
min_uppercase_alphabet_num
integer <int64>
min_lowercase_alphabet_num
integer <int64>
min_number_num
integer <int64>
min_symbol_num
integer <int64>
allowed_same_username
boolean
allowed_save_previous_password
boolean

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "min_length": 8,
  • "max_length": 255,
  • "min_alphabet_num": 0,
  • "min_uppercase_alphabet_num": 0,
  • "min_lowercase_alphabet_num": 0,
  • "min_number_num": 0,
  • "min_symbol_num": 0,
  • "allowed_same_username": true,
  • "allowed_save_previous_password": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "min_length": 8,
  • "max_length": 255,
  • "min_alphabet_num": 0,
  • "min_uppercase_alphabet_num": 0,
  • "min_lowercase_alphabet_num": 0,
  • "min_number_num": 0,
  • "min_symbol_num": 0,
  • "allowed_same_username": true,
  • "allowed_save_previous_password": true,
  • "created_at": "2000-01-01T00.00.00Z",
  • "updated_at": "2000-01-01T00.00.00Z"
}

Configs

Get System Config

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "email_verification_expiration_period": "3h",
  • "email_limit_per_user": 1,
  • "access_token_expiration_period": "1h",
  • "refresh_token_expiration_days": 30,
  • "temporary_token_expiration_period": "5m",
  • "password_attempt_limit": 5,
  • "password_reset_attempt_count_threshold": "24h",
  • "password_recovery_expiration_period": "1h",
  • "password_default_temporary_expiration_period": "6h",
  • "password_default_expiration_days": 36500,
  • "api_token_limit_per_user": 3,
  • "api_token_default_expiration_period": "876000h",
  • "max_groups_count": 1000,
  • "max_project_count_per_group": 1000
}

Version

Get Version

APIバージョンを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "version": "1.0.0"
}

Deprecated Endpoints

Set My Email as Verified Deprecated

自分（ユーザー）のメールアドレスを確認済みにします。 Deprecated: 代わりに/emails/verifiedを使用してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
verification_token
required
string [ 1 .. 4096 ] characters

メールアドレス確認用トークン

Responses

Request samples

Content type
application/json
{
  • "verification_token": "verification.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "address": "intdash@example.com",
  • "created_at": "2000-01-01T00:00:00Z",
  • "id": 1,
  • "updated_at": "2000-01-01T00:00:00Z",
  • "verified": true
}

List Edge Connections Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/edge_connection を使用してください） エッジ接続のリストを取得します。 エッジ接続は、エッジがiSCPプロトコル（/api/iscp/connect エンドポイントなど）を使用してサーバーに接続したときに新規作成され、 3日間更新がないと削除されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
edge
Array of strings
Example: edge=b55e3351-97e2-4db1-ac90-60fda8b3d144

エッジのUUID

group_by_edge
boolean
Default: false

最新接続日時でエッジごとにグルーピングするかどうか

sort
string
Default: "last_lived_at"
Enum: "last_lived_at" "created_at" "updated_at"
Example: sort=last_lived_at

並べ替えに使用するキー

order
string
Default: "desc"
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

limit
integer
Default: 100
Example: limit=100

1回のリクエストで取得する件数

page
integer
Default: 1
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": null
}

Get Edge Connection Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/edge_connection/{edge_connection_uuid} を使用してください） エッジ接続（ /v1/ws/measurements に接続されたエッジの接続情報）を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_connection_uuid
required
string
Example: e0326d93-6e94-4edf-92a2-961cc1c07414

エッジ接続のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "created_at": "2017-02-11T01:23:45Z",
  • "downstreams": [
    ],
  • "edge": {
    },
  • "last_lived_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "upstreams": [
    ],
  • "uuid": "e0326d93-6e94-4edf-92a2-961cc1c07414"
}

Get Realtime Streaming Data Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/stream を使用してください） WebSocketを使ってリアルタイムデータを取得します。

同じくWebSocketを使ってリアルタイムデータを扱う /v1/ws/measurements では、 iSCP (intdash Stream Control Protocol)を使用しますが、 本エンドポイントではJSONとしてデータポイントを取得することができます。

クエリパラメータ

パラメータ名 型 必須 デフォルト 説明
flush_interval string true - メッセージがフラッシュされる間隔を指定します。 単位は"ns"、"us" (または"µs")、"ms"、"s"、"m"、"h"のいずれかを使用してください （参考: Goのtimeパッケージ）。 指定がない場合は、メッセージごとにフラッシュされます。

メッセージのフォーマット

JSON Lines

リクエストメッセージおよびレスポンスメッセージには JSON lines 形式を使用します。

1つのメッセージが1行です。

例:


{ "type" : "message_type", "contents" : { depends on message_type }}

{ "type" : "message_type", "contents" : { depends on message_type }}

{ "type" : "message_type", "contents" : { depends on message_type }}

{ "type" : "message_type", "contents" : { depends on message_type }}

{ "type" : "message_type", "contents" : { depends on message_type }}

.

.

注意: メッセージに改行を含むことはできません。

改行が入ったメッセージの例（悪い例）:


{
  "type" : "message_type",
  "contents" : { depends on message_type }
}

メッセージには、 type 属性および contents 属性が必要です。 contents のスキーマは、 type により決定されます。

ダウンストリーム開始リクエスト

ダウンストリーム開始リクエストメッセージのスキーマ

属性名 型 必須 デフォルト 説明
id number false - idに指定した値は、レスポンスの ack 属性として返ります。
type string true "open_downstream" 固定値
contents object（次の表を参照） true -

ダウンストリーム開始リクエスト内 contents のスキーマ

属性名 型 必須 デフォルト 説明
edge string true - データの送信元エッジを、エッジのUUIDまたはエッジの名前で指定します。 最初に、一致するエッジUUIDが検索され、一致するエッジUUIDがなければ一致する名前が検索されます。
filter string array false [] 「フィルター」を参照してください。

フィルター

データコードとデータ名を指定することにより、指定にマッチしたデータポイントだけを受信することができます。

ただし、メタデータのデータポイントは、フィルターの設定に関係なくすべて受信されます。

フィルターは以下のフォーマットで設定します: <型コード>:<データ名>

データコードについては、後述の 時系列データのペイロードフォーマット を参照してください。

フィルター設定文字列の各セグメントにはワイルドカード( ** )を使用することができます。

例:

  • 型コードが can_data_field のデータポイント（CAN）を受信する -> can_data_field:**

  • 型コードが string/ で始まるデータポイントを受信する（string/json 、 string/csv など） -> string/**:**

  • 文字列のデータポイントのうち、データ名が my-string のものを受信する -> string:my-string

filter として空の配列が指定された場合は、すべてのデータポイントを受信します。

ダウンストリーム開始リクエストの例

リクエスト:


{ "type" : "open_downstream", "contents" : { "edge" : "edge_name_or_uuid", "filter" : ["string:a/b"] } }

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:


{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

ダウンストリーム更新リクエスト

ダウンストリーム更新リクエストメッセージのスキーマ

属性名 型 必須 デフォルト 説明
id number false - idに指定した値は、レスポンスの ack 属性として返ります。
type string true "update_downstream" 固定値
contents object（次の表を参照） true -

ダウンストリーム更新リクエスト内 contents のスキーマ

属性名 型 必須 デフォルト 説明
filter string array true - 「フィルター」を参照してください。

ダウンストリーム更新リクエストの例

フィルターを指定する場合のリクエスト:


{ "type" : "update_downstream", "contents" : { "filter" : ["string:a/b"] } }

フィルターを指定せずすべてのデータポイントを受信する場合のリクエスト:


{ "type" : "update_downstream", "contents" : { "filter" : [] } }

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:


{ "type" : "response", "contents": { "code" : 10000, "message": "succeed:
update downstream" } }

ダウンストリーム終了リクエスト

ダウンストリーム終了リクエストメッセージのスキーマ

| 属性名 | 型 | 必須 | デフォルト | 説明 | | ---------------- | ------------------------ | ---------- | ----------------- | ------- | | id | number | false | - | idに指定した値は、レスポンスの ack 属性として返ります。 | | type | string | true | "close_downstream" | 固定値|

ダウンストリーム終了リクエストの例

リクエスト:


{ "type" : "close_downstream"}

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:


{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: close downstream" } }

レスポンスメッセージ

リクエストの処理結果が返却されます。

レスポンスメッセージのスキーマ

属性名 型 必須 デフォルト 説明
type string true "response" 固定値
ack number false - リクエストで id が指定されていた場合、その値
contents object（次の表を参照） true -

レスポンス内 contents のスキーマ

属性名 型 必須 デフォルト 説明
code number true - 10000 < code < 20000 の場合、成功。 20000 < code < 30000 の場合、不正なリクエスト。50000 < code の場合、予期しないエラー
message string true - リクエストで id が指定されていた場合、その値

レスポンスの例


{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

リクエストで id が指定されている場合のレスポンス例（ id の値が ack として返ります）:


{ "ack": 1, "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

時系列データのペイロードフォーマット

時系列データポイントが格納するペイロードのフォーマットです。各データ型に対する contentsのフォーマットは このページ を参照してください。

データ型

各データバイナリには、ペイロードのフォーマットを示すデータ型が付与されます。各データ型には、型を識別するためのコード名が割り当てられます。

標準データ型

単一のデータを格納するデータ型です。

名称 コード バイト長 説明
Bytes bytes 可変 フォーマットなしバイト列
String string 可変 フォーマットなし文字列
Float64 float64 8 IEEE754 64ビット浮動小数点数
Int64 int64 8 符号付き 64ビット整数
Bool bool 1 真偽値

メディアデータ型

メディア（動画/音声）関連のデータを格納するデータ型です。

名称 コード バイト長 説明
JPEG video/jpeg 可変 JPEG 形式の画像データ
H264 video/h264 可変 H264 形式の映像データ

拡張バイナリ型

フォーマット付きのバイナリデータを格納するデータ型です。

名称 コード バイト長 説明
BSON bson 可変 BSON フォーマット
CAN Frame can_frame 可変 CAN フレーム フォーマット
CAN Data Field can_data_field 可変 CAN データフィールド フォーマット
MAVLink1 Packet mavlink1_packet 可変 MAVLink パケット フォーマット
Generic (非推奨) generic 可変 iSCPv1互換 汎用フォーマット
Controlpad (非推奨) control_pad 可変 iSCPv1互換 コントロールパッドフォーマット
GeneralSensor (非推奨) general_sensor 可変 iSCPv1互換 汎用センサーフォーマット

拡張文字列型

フォーマット付きの文字列データを格納するデータ型です。

名称 コード バイト長 説明
JSON string/json 可変 JSON フォーマット
CSV string/csv 可変 CSV フォーマット
NMEA string/nmea 可変 NMEA フォーマット
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Connect ISCPv1 Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/ws/measurements を使用してください） iSCP v1（WebSocket上でリアルタイムデータを送受信するintdash独自プロトコル）の使用を開始するためのエンドポイントです。

このリクエストを送ることで、プロトコルがWebSocketに切り替えられ、iSCP v1を使用できます。

"permessage-deflate" (RFC 7692) が使用できます。

iSCP v1の詳細については、別ドキュメント 詳説iSCP 1.0 を参照してください。

「詳説iSCP 1.0」に記載されいていない事項ついては、 アプトポッド にお問い合わせください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Get Realtime Streaming Data Deprecated

WebSocketを使ってリアルタイムデータを取得します。

同じくWebSocketを使ってリアルタイムデータを扱う /v1/ws/measurements では、 iSCP (intdash Stream Control Protocol)を使用しますが、 本エンドポイントではJSONとしてデータポイントを取得することができます。

クエリパラメータ

パラメータ名 型 必須 デフォルト 説明
flush_interval string true - メッセージがフラッシュされる間隔を指定します。 単位は"ns"、"us" (または"µs")、"ms"、"s"、"m"、"h"のいずれかを使用してください （参考: Goのtimeパッケージ）。 指定がない場合は、メッセージごとにフラッシュされます。

メッセージのフォーマット

JSON Lines

リクエストメッセージおよびレスポンスメッセージには JSON lines 形式を使用します。 1つのメッセージが1行です。

例:

{ "type" : "message_type", "contents" : { depends on message_type }}
{ "type" : "message_type", "contents" : { depends on message_type }}
{ "type" : "message_type", "contents" : { depends on message_type }}
{ "type" : "message_type", "contents" : { depends on message_type }}
{ "type" : "message_type", "contents" : { depends on message_type }}
.
.

注意: メッセージに改行を含むことはできません。 改行が入ったメッセージの例（悪い例）:

{
  "type" : "message_type",
  "contents" : { depends on message_type }
}

メッセージには、 type 属性および contents 属性が必要です。 contents のスキーマは、 type により決定されます。

ダウンストリーム開始リクエスト

ダウンストリーム開始リクエストメッセージのスキーマ

属性名 型 必須 デフォルト 説明
id number false - idに指定した値は、レスポンスの ack 属性として返ります。
type string true "open_downstream" 固定値
contents object（次の表を参照） true -

ダウンストリーム開始リクエスト内 contents のスキーマ

属性名 型 必須 デフォルト 説明
edge string true - データの送信元エッジを、エッジのUUIDまたはエッジの名前で指定します。 最初に、一致するエッジUUIDが検索され、一致するエッジUUIDがなければ一致する名前が検索されます。
filter string array false [] 「フィルター」を参照してください。

フィルター

データコードとデータ名を指定することにより、指定にマッチしたデータポイントだけを受信することができます。 ただし、メタデータのデータポイントは、フィルターの設定に関係なくすべて受信されます。

フィルターは以下のフォーマットで設定します: <型コード>:<データ名> データコードについては、後述の 時系列データのペイロードフォーマット を参照してください。 フィルター設定文字列の各セグメントにはワイルドカード( ** )を使用することができます。

例:

  • 型コードが can_data_field のデータポイント（CAN）を受信する -> can_data_field:**
  • 型コードが string/ で始まるデータポイントを受信する（string/json 、 string/csv など） -> string/**:**
  • 文字列のデータポイントのうち、データ名が my-string のものを受信する -> string:my-string

filter として空の配列が指定された場合は、すべてのデータポイントを受信します。

ダウンストリーム開始リクエストの例

リクエスト:

{ "type" : "open_downstream", "contents" : { "edge" : "edge_name_or_uuid", "filter" : ["string:a/b"] } }

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:

{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

ダウンストリーム更新リクエスト

ダウンストリーム更新リクエストメッセージのスキーマ

属性名 型 必須 デフォルト 説明
id number false - idに指定した値は、レスポンスの ack 属性として返ります。
type string true "update_downstream" 固定値
contents object（次の表を参照） true -

ダウンストリーム更新リクエスト内 contents のスキーマ

属性名 型 必須 デフォルト 説明
filter string array true - 「フィルター」を参照してください。

ダウンストリーム更新リクエストの例

フィルターを指定する場合のリクエスト:

{ "type" : "update_downstream", "contents" : { "filter" : ["string:a/b"] } }

フィルターを指定せずすべてのデータポイントを受信する場合のリクエスト:

{ "type" : "update_downstream", "contents" : { "filter" : [] } }

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:

{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: update downstream" } }

ダウンストリーム終了リクエスト

ダウンストリーム終了リクエストメッセージのスキーマ

属性名 型 必須 デフォルト 説明
id number false - idに指定した値は、レスポンスの ack 属性として返ります。
type string true "close_downstream" 固定値

ダウンストリーム終了リクエストの例

リクエスト:

{ "type" : "close_downstream"}

レスポンス（レスポンスの詳細については、「レスポンス」を参照してください）:

{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: close downstream" } }

レスポンスメッセージ

リクエストの処理結果が返却されます。

レスポンスメッセージのスキーマ

属性名 型 必須 デフォルト 説明
type string true "response" 固定値
ack number false - リクエストで id が指定されていた場合、その値
contents object（次の表を参照） true -

レスポンス内 contents のスキーマ

属性名 型 必須 デフォルト 説明
code number true - 10000 < code < 20000 の場合、成功。 20000 < code < 30000 の場合、不正なリクエスト。50000 < code の場合、予期しないエラー
message string true - リクエストで id が指定されていた場合、その値

レスポンスの例

{ "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

リクエストで id が指定されている場合のレスポンス例（ id の値が ack として返ります）:

{ "ack": 1, "type" : "response", "contents": { "code" : 10000, "message": "succeed: open downstream" } }

時系列データのペイロードフォーマット

時系列データポイントが格納するペイロードのフォーマットです。各データ型に対する contentsのフォーマットは このページ を参照してください。

データ型

各データバイナリには、ペイロードのフォーマットを示すデータ型が付与されます。各データ型には、型を識別するためのコード名が割り当てられます。

標準データ型

単一のデータを格納するデータ型です。

名称 コード バイト長 説明
Bytes bytes 可変 フォーマットなしバイト列
String string 可変 フォーマットなし文字列
Float64 float64 8 IEEE754 64ビット浮動小数点数
Int64 int64 8 符号付き 64ビット整数
Bool bool 1 真偽値

メディアデータ型

メディア（動画/音声）関連のデータを格納するデータ型です。

名称 コード バイト長 説明
JPEG video/jpeg 可変 JPEG 形式の画像データ
H264 video/h264 可変 H264 形式の映像データ

拡張バイナリ型

フォーマット付きのバイナリデータを格納するデータ型です。

名称 コード バイト長 説明
BSON bson 可変 BSON フォーマット
CAN Frame can_frame 可変 CAN フレーム フォーマット
CAN Data Field can_data_field 可変 CAN データフィールド フォーマット
MAVLink1 Packet mavlink1_packet 可変 MAVLink パケット フォーマット
Generic (非推奨) generic 可変 iSCPv1互換 汎用フォーマット
Controlpad (非推奨) control_pad 可変 iSCPv1互換 コントロールパッドフォーマット
GeneralSensor (非推奨) general_sensor 可変 iSCPv1互換 汎用センサーフォーマット

拡張文字列型

フォーマット付きの文字列データを格納するデータ型です。

名称 コード バイト長 説明
JSON string/json 可変 JSON フォーマット
CSV string/csv 可変 CSV フォーマット
NMEA string/nmea 可変 NMEA フォーマット
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

Responses

Connect ISCPv1 Deprecated

iSCP v1（WebSocket上でリアルタイムデータを送受信するintdash独自プロトコル）の使用を開始するためのエンドポイントです。

このリクエストを送ることで、プロトコルがWebSocketに切り替えられ、iSCP v1を使用できます。 "permessage-deflate" (RFC 7692) が使用できます。

iSCP v1の詳細については、別ドキュメント 詳説iSCP 1.0 を参照してください。

「詳説iSCP 1.0」に記載されいていない事項ついては、 アプトポッド にお問い合わせください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: c78ce0c1-eb57-4f93-a087-ee3b7cee5e06

プロジェクトのUUID

Responses

List Edge's Data IDs Deprecated

エッジを指定し、そのエッジから送信されているデータに含まれるデータ識別子（ data_type 、 channel 、 data_id の組み合わせ）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
start
integer <int64>
Example: start=1505797626000000

取得対象範囲の始点（マイクロ秒単位のUNIX時刻）

end
integer <int64>
Example: end=1505798226123456

取得対象範囲の終点（マイクロ秒単位のUNIX時刻）

edge_uuid
string
Example: edge_uuid=24dbdc29-165f-4919-b2ce-7a335282bde2

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

List Data IDs Deprecated

計測を指定し、その計測に含まれるデータ識別子（ data_type 、 channel 、 data_id の組み合わせ）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Store Data Points Deprecated

データポイントを登録します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema: application/protobuf

このエンドポイント使用時は、 Content-Type を以下にしてください。

  • application/protobuf
    • protocol.proto の StoreProto を参照してください。
      • DataPointProto の data_payloadは iSCP v1のデータフォーマットに従います。
      • iSCPのデータフォーマットは 詳説 iSCP 1.0を参照してください。
string <binary>

Responses

Protect Measurement Deprecated

計測を保護します。保護された計測は削除できません。 See も参照してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Unprotect Measurement Deprecated

計測の保護を解除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

List Measurement Sections Deprecated

計測に含まれるセクションのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

query Parameters
filter
string
Default: "both"
Enum: "processed" "unprocessed" "both"
Example: filter=processed

計測セクションの処理ステータス。 processed （処理済みの計測セクションを取得）、 unprocessed （未処理の計測セクションを取得）、 both （両方を取得）のいずれかを選択します。

limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 100
}

List Uploading Statuses of Measurements Deprecated

（ Deprecated このエンドポイントではなく、GET /measurements/jobs を使用してください。） 計測のアップロードのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Store Data Points by CSV File Deprecated

CSVファイルをアップロードし、計測にデータを追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: multipart/form-data

meas_end パラメーターの設定は任意です。指定しない場合、 true となります。

channel
integer

作成された計測のチャンネル

meas_end
boolean
  • true : 終了した計測
  • false : 終了していない計測
label_data_type
string <json> (LabelDataType)

列名とデータタイプの対応。 データタイプは、 int 、 string 、 float のいずれかを指定してください。 例:

{
  "column_1": "float",
  "column_2": "string",
  "column_3": "int"
}
data_file
required
string <binary>

アップロードするファイル

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "meas_upload_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "job_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "file_name": "filename.csv"
}

List Measurement Markers by Measurement UUID Deprecated

(Deprecated このエンドポイントではなく、 GET /measurements/{measurement_uuid} を使用してください。) 計測UUIDを指定して、その計測に付与されたマーカーの一覧を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Get Measurement Marker by Measurement UUID Deprecated

Deprecated このエンドポイントではなく、 GET /measurements/{measurement_uuid} を使用してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

List Signals Deprecated

信号定義のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
label
Array of strings
Example: label=label1

ラベルが指定した文字列から始まる信号定義を取得します。 文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

sort
string
Enum: "label" "created_at" "updated_at"
Example: sort=label

並べ替えに使用するキー

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

limit
integer <int32>
Example: limit=100

1回のリクエストで取得する件数

page
integer <int32>
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Signal Deprecated

信号定義を作成します。

  • Note
    • 既存の信号定義と label が重複する場合、または uuid が重複する場合は、 ステータスコード 409 Conflict が返却されます。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

Request Body schema: application/json
channel
integer <int32>

チャンネル

object or object or object or object or object or object (SignalConversion)
data_id
string

データID

data_type
integer <int32>

データタイプ

description
string

信号定義の説明

object (SignalDisplay)
label
string

信号定義のラベル

uuid
string

信号定義のUUID

Responses

Request samples

Content type
application/json
{
  • "channel": 1,
  • "conversion": {
    },
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "description of signal",
  • "display": {
    },
  • "label": "signal",
  • "uuid": "022a9941-d7ff-44ee-a9ff-55a623880a40"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

Delete Signal Deprecated

信号定義を削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Responses

Get Signal Deprecated

信号定義を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

Update Signal Deprecated

信号定義を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Request Body schema: application/json
channel
integer <int32>

チャンネル

object or object or object or object or object or object (SignalConversion)
data_id
string

データID

data_type
integer <int32>

データタイプ

description
string

信号定義の説明

object (SignalDisplay)
label
string

信号定義のラベル

Responses

Request samples

Content type
application/json
{
  • "channel": 1,
  • "conversion": {
    },
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "description of signal",
  • "display": {
    },
  • "label": "signal"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

List Data Points Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/data を使用してください） データポイントのリストを取得します。 返却されるデータポイントはJSON形式です。データポイントごとに改行で区切られます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
name
required
string
Example: name=8f40b21c-f2c4-4fa5-8fe3-325491a59597

どの計測またはどのエッジのデータポイントを取得するかを、以下のいずれかを使って指定します：

  • 計測UUID
  • エッジUUID
  • エッジの名前

最初に、指定されたnameに一致する計測UUIDがあるかが検索されます。なければ一致するエッジUUIDがあるかが検索され、それもなければ一致するエッジの名前があるかが検索されます。

start
string
Example: start=2019-10-29T03:04:05.123456Z

取得対象区間の始点（始点は対象区間に含まれます）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

取得対象区間の終点（終点は対象区間に含まれません）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
data_id_filter
Array of strings
Example: data_id_filter=string:string-data-name

取得したいデータポイントの条件をiSCPv2のデータIDフィルターのフォーマットで指定します。 データIDフィルターのフォーマットは データ型（data_type） 、 データ名称（ data_name ）を使用してデータのフィルタ処理を行います。

フィルター文字列は : の前後でデータ型とデータ名称に区切られます。基本的な構造は次の通りです。

  • <data_type>:<data_name>

data_type と data_name はさらに / で内部を分割することができます。その場合 ワイルドカード + と # を使用して、より詳細なフィルタリング条件を定義できます。 以下に、このフィルター表現の使用方法についての詳細な説明を示します。

セグメントとワイルドカードの使用

  • セグメント

    • / で区切られたデータ型またはデータ名称の内部構造を表現します。これにより、階層的なデータ構造やパスのような形式でデータを指定できます。

  • + ワイルドカード

    • 一つのセグメントに完全に一致する任意の文字列を示します。これを使用することで、特定の位置のセグメントの任意値に、マッチする条件を設定できます。

  • # ワイルドカード

    • 一つまたは複数のセグメントに完全に一致する任意の文字列を示します。これにより、任意の深さの階層を持つデータに対して、柔軟なマッチング条件を提供できます。

使用例

  1. 完全一致

    • フィルター a/b:c/d は、データ型が a/b でデータ名称が c/d である文字列に対して完全にマッチします。

  2. + ワイルドカード （一つのセグメントの完全一致）

    • データ型内での使用例: フィルター a/+:c/d は、データ型 a/ の直下にある任意のセグメント（例: a/b a/x など）と、データ名称 c/d にマッチします。 a:<任意のデータ名称> にはマッチしません。
    • データ名称での使用例: フィルター a/b:c/+ は、データ型 a/b と、データ名称 c/ の直下にある任意のセグメント（例: c/d , c/x など）にマッチします。 <任意のデータ型>:c にはマッチしません。

  3. # ワイルドカード （複数のセグメントの完全一致）

    • データ型での使用例: フィルター #:c/d は、任意のデータ型（例: a/b や x/y/z など）と、c/d というデータ名称にマッチします。
    • データ名称での使用例: フィルター a/b:# は、a/b というデータ型と、任意の深さのセグメントを持つデータ名称（例: c/d や e/f/g など）にマッチします。

iSCPv2のデータIDとフィルターについての詳細は以下のリンクを参照します。

参考 iSCP v1形式で保存されたデータの場合

iSCP v1形式で保存されたデータポイントの data_type 、 data_name は次のようになります。

  • data_type：<iSCPv1におけるデータタイプ(10進数表記)>
  • data_name：<iSCPv1におけるチャンネル(10進数表記)>/<iSCPv1におけるデータID>

例:

  • iSCPv1で永続化された、CAN(データタイプが「1」)のデータポイントを取得する：1:#
  • iSCPv1で永続化された、チャンネル2のCANデータポイントを取得する：1:2/#
  • iSCPv1で永続化された、チャンネル2のCANデータポイントのうち、データIDが 「00000001」 のものを取得する：1:2/00000001
idq
Array of strings
Deprecated
Example: idq=data_type:data_name

非推奨 です。 data_id_filter を使用してください。両方指定した場合、本属性は無視されます。 取得したいデータポイントの条件を以下のフォーマットで指定します。

  • <data_type>:<data_id>

data_type 、 data_id は GET /data_ids エンドポイントで取得できます。

各セグメントにはワイルドカード(*)を使用することができます。

例:

  • データタイプが string かつ、データ名が任意のものを取得する -> string:* または string
    • ※ iSCPv1で永続化されたデータはデータタイプが10進数となることに注意してください。詳細は以下の「参考2」を参照してください。

参考１ iSCP v2形式で保存されたデータの場合

iSCP v2形式で保存されたデータポイントの data_type 、 data_id は次のようになります。

  • data_type：<iSCPv2におけるデータ型>

  • data_id：<iSCPv2におけるデータ名称>

例:

  • iSCPv2で永続化された、データ型が「string」のデータポイントを取得する：string:* または string
  • iSCPv2で永続化された、データ型が「string」で、データ名称が「my-data」のデータポイントを取得する：string:my-data

参考２ iSCP v1形式で保存されたデータの場合

iSCP v1形式で保存されたデータポイントの data_type 、 data_id は次のようになります。

  • data_type：<iSCPv1におけるデータタイプ(10進数表記)>

  • data_id：<iSCPv1におけるチャンネル(10進数表記)>/<iSCPv1におけるデータID>

例:

  • iSCPv1で永続化された、CAN(データタイプが「1」)のデータポイントを取得する：1:*/* または 1
  • iSCPv1で永続化された、チャンネル2のCANデータポイントを取得する：1:2/* または 1:2
  • iSCPv1で永続化された、チャンネル2のCANデータポイントのうち、データIDが 「00000001」 のものを取得する：1:2/00000001
since
string
Example: since=2019-10-29T03:04:05.341268Z

指定した時刻以降に更新された計測のみを取得します。 以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z).
  • UNIX時刻（マイクロ秒）(Deprecated).
exit_on_error
string
Default: false
Example: exit_on_error=false

true を指定した場合、取得中にエラーが発生すると処理を中断し、中断前までのデータポイントのリストを返します。

label
Array of strings
Example: label=label

信号定義のラベル

limit
integer <int64>

1回のリクエストで取得する件数。デフォルトは無制限。

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序。デフォルトは asc （昇順）

time_format
string
Enum: "ns" "us" "ms" "s" "rfc3339"
Example: time_format=rfc3339

レスポンスの時刻表示形式。デフォルトは us （マイクロ秒）

Responses

Response samples

Content type
"string"

List Data Point Data IDs Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/data_ids を使用してください） データポイントのデータID（ data_type, data_id ）のリストを取得します。

name で計測UUIDを指定した場合、 start / end パラメーターは無視されます。

name でエッジUUIDまたはエッジの名前を指定した場合、 start / end パラメーターを使ってそのエッジの計測をさらに絞り込むことができます。 この場合、 start / end で指定された区間内に基準時刻を持つ計測のみが対象となり、その計測に含まれるデータIDが取得されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
name
required
string
Example: name=8f40b21c-f2c4-4fa5-8fe3-325491a59597

どの計測またはどのエッジのデータポイントを取得するかを、以下のいずれかを使って指定します：

  • 計測UUID
  • エッジUUID
  • エッジの名前

最初に、指定されたnameに一致する計測UUIDがあるかが検索されます。なければ一致するエッジUUIDがあるかが検索され、それもなければ一致するエッジの名前があるかが検索されます。

start
string
Example: start=2019-10-29T03:04:05.123456Z

取得対象区間の始点（始点は対象区間に含まれます）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

取得対象区間の終点（終点は対象区間に含まれません）。以下のいずれかの形式で指定します。

  • rfc3339(ex 2019-10-29T03:04:05.341268Z)
  • UNIX時刻（マイクロ秒）(Deprecated)

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

List Edge's Data IDs Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/getids を使用してください） エッジを指定し、そのエッジから送信されているデータに含まれるデータ識別子（ data_type 、 channel 、 data_id の組み合わせ）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
start
integer <int64>
Example: start=1505797626000000

取得対象範囲の始点（マイクロ秒単位のUNIX時刻）

end
integer <int64>
Example: end=1505798226123456

取得対象範囲の終点（マイクロ秒単位のUNIX時刻）

edge_uuid
string
Example: edge_uuid=24dbdc29-165f-4919-b2ce-7a335282bde2

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

List Data IDs Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/getids を使用してください） 計測を指定し、その計測に含まれるデータ識別子（ data_type 、 channel 、 data_id の組み合わせ）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Store Data Points Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/data を使用してください） データポイントを登録します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/protobuf

このエンドポイント使用時は、 Content-Type を以下にしてください。

  • application/protobuf
    • protocol.proto の StoreProto を参照してください。
      • DataPointProto の data_payloadは iSCP v1のデータフォーマットに従います。
      • iSCPのデータフォーマットは 詳説 iSCP 1.0を参照してください。
string <binary>

Responses

List Measurements Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements を使用してください） 計測のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=5c3ac8b5-3acd-43ea-86cb-4835664b0483

計測のUUID

name
string
Example: name=measurement1

名前が指定した文字列から始まる計測を取得します。 文字列をダブルクォーテーションで囲むと、完全一致のものだけが取得されます。

edge_uuid
string
Example: edge_uuid=e0022b03-023f-4f24-90f1-560be10c423b

計測に関連付けられたエッジのUUID

start
string
Example: start=2019-10-29T03:04:05.123456Z

計測を取得するための対象区間の始点（始点は対象区間に含まれます）。 計測の基準時刻が、ここで指定した時刻と同じかそれより後の場合、その計測は取得対象になります。 ただし、 partial_match を true にした場合については partial_match の説明を参照してください。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
end
string
Example: end=2019-10-29T03:04:05.234567Z

計測を取得するための対象区間の終点（終点は対象区間に含まれません）。 計測の基準時刻が、ここで指定した時刻よりも前の場合、その計測は取得対象になります。 ただし、 partial_match を true にした場合については partial_match の説明を参照してください。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
partial_match
boolean
Default: false
Example: partial_match=true

false の場合、 start と end によって指定された取得対象区間に 基準時刻(basetime)が入っていると、その計測は取得対象になります。

true の場合、取得対象区間に計測の一部でも入っていると、その計測は取得対象となります。 計測の始点は基準時刻(basetime)、終点は基準時刻に長さを加えたもの(basetime+max_elapsed_time)です。

以下の図の例では、 partial_match=false のように指定すると、 measurement2 と measurement3 が取得されます。

partial_match=true のように指定すると、 measurement1 、 measurement2 、 measurement3 が取得されます。

                   :                            :
                   :                            :
           | measurement1 |                     :
           +--------------+                     :
                   :           | measurement2 | :
                   :           +--------------+ :
                   :                       | measurement3 |
                   :                       +--------------+
    | measurement4 |                            :
    +--------------+                            :
                   :                            | measurement5 |
                   :                            +--------------+
                   :                            :
                   :                            :            time
-------------------+----------------------------+--------------->
                   |                            |
                  start                        end

partial_match=true の場合の計測の端点の扱いは以下のようになります。

  • 「計測の終点(=basetime+max_elapsed_time) == 取得対象区間のstart」の場合、 その計測は取得されません（上図のmeasurement4）。

  • 「計測の始点(=basetime) == 取得対象区間の end 」の場合も、 その計測は取得されません（上図のmeasurement5）。

basetime_type
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: basetime_type=ntp

計測の基準時刻のタイプ

ended
boolean

計測が終了している（ended）かどうかを指定して計測を取得します。

エッジにおいてデータの取得が終了している場合、その計測は「終了(ended)」となります。 計測は終了(ended)していても、まだサーバーに送信されていないデータがエッジに残っている可能性があります。

  • true: 終了した計測だけを取得します。
  • false: 終了していない計測だけを取得します。
since
string
Example: since=2019-10-29T03:04:05.341268Z

指定した時刻以降に更新された計測のみを取得します。

以下のいずれかの形式で指定します。

  • RFC3339(例 2019-10-29T03:04:05.341268Z )
  • UNIX時刻（マイクロ秒）(Deprecated)
duration_start
integer <int64>
Example: duration_start=100

計測時間の最小値（マイクロ秒）。これより短い計測は取得しません。

duration_end
integer <int64>
Example: duration_end=100000

計測時間の最大値（マイクロ秒）。これより長い計測は取得しません。

status
Array of strings
Items Enum: "measuring" "resending" "finished"
Example: status=measuring

計測のステータス

limit
integer <int32>
Default: 1000
Example: limit=1000

1回のリクエストで取得する件数。ただし、0を指定するとデフォルトの値が使用されます。

sort
string
Default: "base_time"
Enum: "name" "description" "ended" "duration" "base_time" "processed_ratio" "created_at" "updated_at"
Example: sort=base_time

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements を使用してください） 計測を作成します。

  • Note
    • 計測の保護／非保護を切り替える権限を持たないエッジも、 計測作成時は保護された計測を作成することが可能です。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime
required
string <date-time>

計測の基準時刻（計測が開始された時刻）

basetime_type
required
string (MeasurementBaseTimeType)
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ。この属性に加えて、 basetime_priority と 任意の basetime_name も同時に設定することを推奨します。 undefined を指定した場合は、接頭辞 basetime_ 及び basetime の属性は無視される事にご注意ください。

basetime_priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

basetime_name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

basetime_elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

edge_uuid
required
string

この計測に関連付けられたエッジのUUID

protected
required
boolean
Deprecated

true の場合、計測は保護されます。保護されている計測は削除できません。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "protected": false
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Trash Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid} を使用してください） 計測を削除します。

  • Note
    • 保護された計測は削除できません。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Get Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid} を使用してください） 計測を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Create Measurement with UUID Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid} を使用してください） 指定したUUIDの計測を作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime
required
string <date-time>

計測の基準時刻（計測が開始された時刻）

basetime_type
required
string (MeasurementBaseTimeType)
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ。この属性に加えて、 basetime_priority と 任意の basetime_name も同時に設定することを推奨します。 undefined を指定した場合は、接頭辞 basetime_ 及び basetime の属性は無視される事にご注意ください。

basetime_priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

basetime_name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

basetime_elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

edge_uuid
required
string

この計測に関連付けられたエッジのUUID

protected
required
boolean
Deprecated

true の場合、計測は保護されます。保護されている計測は削除できません。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "protected": false
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Update Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid} を使用してください） 計測に関する情報を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測の名前

description
string

計測の説明

basetime_type
string (MeasurementBaseTimeType)
Deprecated
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

計測の基準時刻タイプ 非推奨 代わりに基準時刻APIを使用して、当該基準時刻の優先度を明示的に設定してください。この値をセットすると、基準時刻タイプの優先度を強制的に一番高いものに変更します。

Responses

Request samples

Content type
application/json
{
  • "name": "meas1",
  • "description": "description of measurement",
  • "basetime_type": "ntp",
  • "max_priority_basetime_id": 1
}

Complete Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/complete を使用してください） 計測を回収完了（completed）にします。 completedは、エッジでのデータ取得が終了し（ended）、 かつ、すべてのデータがサーバーに送信されたことを意味します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

End Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/end を使用してください） 計測終了（ended）とします。endedは、エッジにおけるデータの取得が終了していることを表します。 （サーバーに回収されていないデータがまだエッジに残っている可能性はあります。サーバーへのデータの回収が完了した状態は、completedと呼びます。）

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "received_chunks_ratio": 0.5,
  • "received_data_points": 123456789,
  • "expected_data_points": 123456789,
  • "status": "measuring"
}

Unprotect Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/protected を使用してください） 計測の保護を解除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Protect Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/protected を使用してください） 計測を保護します。保護された計測は削除できません。 See も参照してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

List Measurement Base Times Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/basetimes を使用してください） 計測の基準時刻のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Delete Measurement Base Time Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/basetimes/{type} を使用してください） 基準時刻を削除します。

指定された基準時刻が使用中の場合（その計測の basetime_type として設定されている場合）は、 その基準時刻は削除できません（ステータスコード 409 が返却されます）。

このような場合は、他の基準時刻をその計測の basetime_type にしてから、削除したい基準時刻を削除してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Responses

Get Measurement Base Time Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/basetimes/{type} を使用してください） 基準時刻タイプを指定して計測の基準時刻を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "ntp",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T01:23:45Z"
}

Replace Measurement Base Time Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/basetimes/{type} を使用してください） 基準時刻を更新します。 この計測において、使用する基準時刻が設定されていない（ basetime_type が undefined ）の場合は、 新しい基準時刻を basetime_type に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Request Body schema: application/json
basetime
string <date-time> (MeasBaseTimeBaseTime)

基準時刻（計測が開始された時刻）（RFC3339形式）

priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

Responses

Request samples

Content type
application/json
{
  • "basetime": "2017-02-11T01:23:45Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "ntp",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T01:23:45Z"
}

List Measurement Sections Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/sections を使用してください） 計測に含まれるセクションのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

query Parameters
filter
string
Default: "both"
Enum: "processed" "unprocessed" "both"
Example: filter=processed

計測セクションの処理ステータス。 processed （処理済みの計測セクションを取得）、 unprocessed （未処理の計測セクションを取得）、 both （両方を取得）のいずれかを選択します。

limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 100
}

List Measurement Sequences Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/sequences を使用してください） 計測シーケンスのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Measurement Sequence Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/sequences/{sequence_uuid} を使用してください） 計測シーケンスを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Measurement Sequence Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/sequences/{sequence_uuid} を使用してください） 計測シーケンスを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Request Body schema: application/json
expected_data_points
integer <int64> >= 0

この計測シーケンスでサーバーが受信することが想定されるデータポイントの総数 （既に受信済みのデータポイントを含む） 符号なし64bit整数。

final_sequence_number
integer <int64> [ 0 .. 4294967295 ]

この計測シーケンスに含まれるチャンクに付与された最後のシーケンス番号

Responses

Request samples

Content type
application/json
{
  • "expected_data_points": 123456789,
  • "final_sequence_number": 10
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Replace Measurement Sequence Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/sequences/{sequence_uuid} を使用してください） 計測シーケンスを置換します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

sequences_uuid
required
string
Example: 0b849907-9f04-4c87-b176-b73fb527e935

計測シーケンスのUUID

Request Body schema: application/json
expected_data_points
integer <int64> >= 0

この計測シーケンスでサーバーが受信することが想定されるデータポイントの総数 （既に受信済みのデータポイントを含む） 符号なし64bit整数。

final_sequence_number
integer <int64> [ 0 .. 4294967295 ]

この計測シーケンスに含まれるチャンクに付与された最後のシーケンス番号

Responses

Request samples

Content type
application/json
{
  • "expected_data_points": 123456789,
  • "final_sequence_number": 10
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0b849907-9f04-4c87-b176-b73fb527e935",
  • "expected_data_points": 123456789,
  • "received_data_points": 123456789,
  • "received_chunks_count": 10,
  • "final_sequence_number": 10,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create Measurement Sequence Chunk Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/sequence/chunks を使用してください） 計測シーケンスにチャンクを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema:
string <binary>

protocol.protoのStoreDataChunksをJSONでシリアライズしたものです。

StoreDataPointのpayloadは iSCP v2のデータフォーマットに従います。この資料は現在準備中です。

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 1
}

List Measurement Jobs Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/jobs を使用してください） ジョブ（CSVファイルを計測に変換するジョブなど）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

status
Array of strings
Items Enum: "ready" "processing" "succeeded" "failed" "cancelled"
Example: status=succeeded

ジョブのステータス

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Delete Measurement Job Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/jobs/{job_uuid} を使用してください） ジョブを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

Get Measurement Job Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/jobs/{job_uuid} を使用してください） ジョブを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "meas_uuid": "a72c674a-e8e9-43bc-940f-a034853363e1",
  • "status": "succeeded",
  • "message": "Succeeded",
  • "file_name": "sample.csv",
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

Cancel Measurement Job Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/jobs/{job_uuid}/cancel を使用してください） ジョブをキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
job_uuid
required
string
Example: ddba7729-3a53-42bb-a4cf-6d19a3e66deb

ジョブのUUID

Responses

List Measurement Markers Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/markers を使用してください） 計測マーカーのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=c14f84c1-b7a5-459b-bd1e-35982e4a4f38

計測マーカーのUUID

name
Array of strings
Example: name=measurement marker1

計測マーカーの名前

start_unix_micro
integer <int64>
Example: start_unix_micro=1000

取得対象区間の始点（マイクロ秒単位のUNIX時刻）（始点は対象区間に含まれます）。 範囲マーカーについては、マーカーの始点が取得対象区間に入っている場合に取得されます。

end_unix_micro
integer <int64>
Example: end_unix_micro=1000

取得対象区間の終点（マイクロ秒単位のUNIX時刻）（終点は対象区間に含まれません）。 範囲マーカーについては、マーカーの始点が取得対象区間に入っている場合に取得されます。

tag.<key>
Array of strings
Example: tag.<key>=include_tag_value

タグのキーと値を使って条件を指定し、条件に一致する計測マーカーを取得します。 キーのみを指定した場合は、指定されたキーを持つ計測マーカーを取得します。 キーと値を指定した場合は、指定されたキーを持ち、その値として指定された値を含む計測マーカーを取得します。 tag.<key>=<value> 条件は複数個指定することができ、OR条件で使用されます。 ただし !tag.<key> と組み合わせた場合、 !tag.<key> が優先されます。

例:

| measurement marker | tag (key: value) |
| ------------------ | ---------------- |
| 1                  | a: value1        |
|                    | c: value2        |
|                    | e: 1             |

| 2                  | a: b             |
|                    | c: d             |

| 3                  | a: b             |
  • ?tag.e= の場合、計測マーカー1番が取得されます。
  • ?!tag.c= の場合、計測マーカー3番が取得されます。
  • ?tag.a=&!tag.e= の場合、計測マーカー2、3番が取得されます。
  • ?tag.a=val&tag.c=d の場合、計測マーカー1、2番が取得されます。
!tag.<key>
Array of strings
Example: !tag.<key>=exclude_tag_value

タグのキーを使って条件を指定し、条件に一致する計測キャプチャを除外します。 タグの値は無視されます。 !tag.<key> を複数個指定した場合、AND条件となります。 また、 tag.<key>=<value> と組み合わせて使用した場合、 tag.<key>=<value> よりも !tag.<key> が優先されます。 例: 上の tag.<key> の説明を参照してください。

limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "base_time"
Enum: "name" "base_time" "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Delete Measurement Marker Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/markers/{measurement_marker_uuid} を使用してください） 計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Get Measurement Marker Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/markers/{measurement_marker_uuid} を使用してください） 計測マーカーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Update Measurement Marker Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/markers/{measurement_marker_uuid} を使用してください） 計測マーカーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Get Measurement from Marker Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/markers/{measurement_marker_uuid}/measurement を使用してください）

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "2cc7de37-6f71-4458-887e-10e618a6fcfb",
  • "name": "meas1",
  • "description": "description of measurement",
  • "edge_uuid": "00de1861-6614-4435-af07-da9b4338d57c",
  • "duration": 100000000,
  • "ended": true,
  • "status": "measuring",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "basetime_type": "ntp",
  • "processed_ratio": 0.9,
  • "received_data_points": null,
  • "markers": [
    ],
  • "protected": false,
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T12:34:56Z"
}

List Uploading Statuses of Measurements Deprecated

（ Deprecated このエンドポイントではなく、GET /measurements/jobs を使用してください。） 計測のアップロードのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
limit
integer <int32>
Example: limit=1000

1回のリクエストで取得する件数

sort
any
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

page
integer <int32>
Example: page=1

取得するページの番号

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Measurement from CSV File Deprecated

CSVまたはMP4（MP4はexperimental）ファイルをアップロードし、計測を作成します。 計測には、指定されたエッジUUIDが関連付けられます。

base_time （基準時刻）は、RFC3339による表現か、UNIX時刻（マイクロ秒）を指定してください。 基準時刻が指定されていない場合は、CSVファイルのデータ行の1行目の時刻が基準時刻として使用されます。 CSVファイルのデータは、時刻順にソートされている必要があります。 meas_end パラメーターの設定は任意です。指定しない場合、 true となります。

CSVファイルの例:

time,       col1,   col2, col3,      col4,   col5, col6,      col7,   col8, col9,      col10
1539263579, val11,  12,   13.12345,  val14,  15,   16.12345,  val17,  18, 19.12345,  val110
1539263580, val21,  22,   23.12345,  val24,  25,   26.12345,  val27,  28, 29.12345,  val210
1539263581, val31,  32,   33.12345,  val34,  35,   36.12345,  val37,  38, 39.12345,  val310
1539263582, val41,  42,   43.12345,  val44,  45,   46.12345,  val47,  48, 49.12345,  val410

空白行がある場合、行番号のカウントは加算されますが、その行は処理されません。 例えば、以下のような場合の空白行は無視されます。

time,       col1,   col2, col3,      col4,   col5, col6,      col7,   col8, col9,      col10
1539263579, val11,  12,   13.12345,  val14,  15,   16.12345,  val17,  18, 19.12345,  val110

1539263581, val31,  32,   33.12345,  val34,  35,   36.12345,  val37,  38, 39.12345,  val310
1539263582, val41,  42,   43.12345,  val44,  45,   46.12345,  val47,  48, 49.12345,  val410

Go parser library も参照してください。

時刻の列には、RFC3339による表現か、UNIX時刻（秒）を使用することができます。

エスケープ

値の内部で , を使用したい場合は、その値全体を " で囲んでください。 また、値の内部で " を使用したい場合は、値全体を " で囲み、さらに、 " を "" のように表記してください。 値を " で囲まないと、CSVファイルのパースの際にエラーが発生します。

エスケープの例:

time,col1
1539263579,"ab,cde"                  .....OK (parsed as 'ab,cde')
1539263579,"ab""cde"                 .....OK (parsed as 'ab"cde')
1539263579,     abcde                .....OK (parsed as '     abcde')
1539263579,"     abcde"              .....OK (parsed as '     abcde')
1539263579,ab"cde                    .....NG
1539263579, "abcde"                  .....NG
1539263579,ab,cde                    .....NG(wrong number of fields)
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: multipart/form-data
edge_uuid
required
string <uuid>

エッジのUUID

base_time
string <date-time>

計測の基準時刻。MP4ファイルをアップロードする場合は必須です。

base_time_type
string
Default: "edge_rtc"
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual" "undefined"

基準時刻のタイプ

channel
integer

計測のチャンネル（十進表記の文字列）

meas_end
boolean

true にすると、計測は終了したものとして扱われます。

label_data_type
string <json> (LabelDataType)

列名とデータタイプの対応。 データタイプは、 int 、 string 、 float のいずれかを指定してください。 例:

{
  "column_1": "float",
  "column_2": "string",
  "column_3": "int"
}
data_file
required
string <binary>

アップロードするファイル

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "meas_upload_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "job_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "file_name": "filename.csv"
}

Store Data Points by CSV File Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/upload を使用してください） CSVファイルをアップロードし、計測にデータを追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: multipart/form-data

meas_end パラメーターの設定は任意です。指定しない場合、 true となります。

channel
integer

作成された計測のチャンネル

meas_end
boolean
  • true : 終了した計測
  • false : 終了していない計測
label_data_type
string <json> (LabelDataType)

列名とデータタイプの対応。 データタイプは、 int 、 string 、 float のいずれかを指定してください。 例:

{
  "column_1": "float",
  "column_2": "string",
  "column_3": "int"
}
data_file
required
string <binary>

アップロードするファイル

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "meas_upload_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "job_uuid": "d9135580-4a6b-4fbd-971b-8fdce27b617c",
  • "file_name": "filename.csv"
}

Delete Measurement Markers by Measurement UUID Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/markers を使用してください） 計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

List Measurement Markers by Measurement UUID Deprecated

(Deprecated このエンドポイントではなく、 GET /measurements/{measurement_uuid} を使用してください。) 計測UUIDを指定して、その計測に付与されたマーカーの一覧を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Create Measurement Marker by Measurement UUID Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/markers を使用してください） 計測マーカーを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
required
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
required
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Delete Measurement Marker by Measurement UUID Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/markers/{Measurement_marker_uuid} を使用してください） 計測マーカーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Get Measurement Marker by Measurement UUID Deprecated

Deprecated このエンドポイントではなく、 GET /measurements/{measurement_uuid} を使用してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

Replace Measurement Marker by Measurement UUID Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/measurements/{measurement_uuid}/markers/{Measurement_marker_uuid} を使用してください） 計測マーカーの情報を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

measurement_marker_uuid
required
string
Example: 27a841d8-78c0-4e5e-b0ee-ec1fafd90ef6

計測マーカーのUUID

Request Body schema: application/json
name
string

計測マーカーの名前

description
string

計測マーカーの説明

type
string

計測マーカーのタイプ

  • point : ポイントマーカー
  • range : 範囲マーカー
tag
object

この計測マーカーに付与するタグ。タグはキーと値からなるペア（いずれもstring）で設定します。 複数のタグを一度に設定することができます。 値の中にオブジェクトを入れる（ネストする）ことはできません。

// Not good
{
  "tagkey" : {
    "nestKey": "not allowed"
  }
}

// OK
{
  "tagkey1" : "ok1",
  "tagkey2" : "ok2"
}
object (MeasurementMarkerDetailPoint)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    }
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "uuid": "cdc1029e-d474-477c-aa6e-b48928fdb825",
  • "name": "name",
  • "description": "description",
  • "type": "point",
  • "detail": {
    },
  • "tag": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "created_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "updated_by": "adbbd1ff-1e13-4b12-b125-e213945a65f8"
}

List Signals Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/signals を使用してください） 信号定義のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
label
Array of strings
Example: label=label1

ラベルが指定した文字列から始まる信号定義を取得します。 文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

sort
string
Enum: "label" "created_at" "updated_at"
Example: sort=label

並べ替えに使用するキー

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

limit
integer <int32>
Example: limit=100

1回のリクエストで取得する件数

page
integer <int32>
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Signal Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/signals を使用してください） 信号定義を作成します。

  • Note
    • 既存の信号定義と label が重複する場合、または uuid が重複する場合は、 ステータスコード 409 Conflict が返却されます。
Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
channel
integer <int32>

チャンネル

object or object or object or object or object or object (SignalConversion)
data_id
string

データID

data_type
integer <int32>

データタイプ

description
string

信号定義の説明

object (SignalDisplay)
label
string

信号定義のラベル

uuid
string

信号定義のUUID

Responses

Request samples

Content type
application/json
{
  • "channel": 1,
  • "conversion": {
    },
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "description of signal",
  • "display": {
    },
  • "label": "signal",
  • "uuid": "022a9941-d7ff-44ee-a9ff-55a623880a40"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

Delete Signal Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/signals/{signal_uuid} を使用してください） 信号定義を削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Responses

Get Signal Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/signals/{signal_uuid} を使用してください） 信号定義を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

Update Signal Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/signals/{signal_uuid} を使用してください） 信号定義を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
signal_uuid
required
string
Example: a74b933c-7c3a-4e9f-bf16-299a96d26562

信号定義のUUID

Request Body schema: application/json
channel
integer <int32>

チャンネル

object or object or object or object or object or object (SignalConversion)
data_id
string

データID

data_type
integer <int32>

データタイプ

description
string

信号定義の説明

object (SignalDisplay)
label
string

信号定義のラベル

Responses

Request samples

Content type
application/json
{
  • "channel": 1,
  • "conversion": {
    },
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "description of signal",
  • "display": {
    },
  • "label": "signal"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "channel": 1,
  • "conversion": {
    },
  • "created_at": "2017-02-11T01:23:45Z",
  • "data_id": "00000001",
  • "data_type": 1,
  • "description": "this is signal1",
  • "display": {
    },
  • "hash": "sha256:8ddad69061d8...",
  • "label": "signal1",
  • "updated_at": "2017-02-11T12:34:56Z",
  • "uuid": "c1c3fd05-89c6-4da8-abdb-7d31aec2af18"
}

List Trashed Measurements Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/trashed_measurements を使用してください） ゴミ箱に入っている計測のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
limit
integer [ 0 .. 50 ]
Example: limit=1

1回のリクエストで取得する件数。0 を指定した場合は、デフォルト値の50件となります。

page
integer >= 0
Example: page=1

取得するページの番号

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 1
}

Delete Trashed Measurement and Delete Data Points Immediately Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/trashed_measurements/{measurement_uuid} を使用してください） ゴミ箱に入っている計測と、その計測に関連付けられているデータポイントを直ちに削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 86fff159-5887-43c9-bf2d-cd1b522c047d

計測のUUID

Responses

Restore Measurement Deprecated

（Deprecated。このエンドポイントでなく /projects/00000000-0000-0000-0000-000000000000/trashed_measurements/{measurement_uuid}/restore を使用してください） ゴミ箱に入っている計測を復元します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
measurement_uuid
required
string
Example: 86fff159-5887-43c9-bf2d-cd1b522c047d

計測のUUID

Responses

Delete Measurement Base Time Deprecated

非推奨 代わりに「Delete Measurement Base Time by ID」を使用してください。 基準時刻を削除します。 指定された基準時刻が使用中の場合（その計測の basetime_type として設定されている場合）は、 その基準時刻は削除できません（ステータスコード 409 が返却されます）。 このような場合は、他の基準時刻をその計測の basetime_type にしてから、削除したい基準時刻を削除してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Responses

Get Measurement Base Time Deprecated

非推奨 代わりに「Get Measurement Base Time by ID」を使用してください。 基準時刻タイプを指定して計測の基準時刻を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "ntp",
  • "basetime": "2017-02-11T01:23:45.678901Z",
  • "created_at": "2017-02-11T01:23:45Z",
  • "updated_at": "2017-02-11T01:23:45Z"
}

Replace Measurement Base Time Deprecated

非推奨 代わりに「Update Measurement Base Time by ID」または「Create Measurement Base Time」を使用してください。 基準時刻を更新します。 この計測において、使用する基準時刻が設定されていない（ basetime_type が undefined ）の場合は、 新しい基準時刻を basetime_type に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

measurement_uuid
required
string
Example: 2cc7de37-6f71-4458-887e-10e618a6fcfb

計測のUUID

type
required
string
Enum: "edge_rtc" "ntp" "gps" "api_first_received" "volatile" "manual"
Example: ntp

基準時刻のタイプ

Request Body schema: application/json
basetime
string <date-time> (MeasBaseTimeBaseTime)

基準時刻（計測が開始された時刻）（RFC3339形式）

priority
integer (MeasBaseTimePriority) [ 0 .. 255 ]

基準時刻の優先度

name
string (MeasBaseTimeName) [ 0 .. 255 ] characters

基準時刻の名前

elapsed_time
integer <int64> (MeasBaseTimeElapsedTime)

基準時刻を受信した基準時刻からの経過時間（ナノ秒）。

Responses

Request samples

Content type
application/json
{
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "type": "edge_rtc",
  • "basetime": "2000-01-01T00:00:00Z",
  • "priority": 255,
  • "name": "NTP",
  • "elapsed_time": 1000,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List HLSes Deprecated

Deprecated このエンドポイントではなく GET /media/videos を使用してください

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
start
integer
Example: start=1234567890

取得対象範囲の始点（マイクロ秒単位のUNIX時刻）

end
integer
Example: end=1234567890

取得対象範囲の終点（マイクロ秒単位のUNIX時刻）

edge_uuid
string
Example: edge_uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

エッジのUUID

channel
integer
Example: channel=1

チャンネル

limit
integer
Example: limit=1000

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

List HLS Jobs Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） HLSへの変換ジョブのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=ade4eea8-edc6-3ca5-c557-12a616c2028a

取得したいジョブのUUID

meas_uuid
Array of strings
Example: meas_uuid=a5170afc-9cc2-5327-e0e1-32746b5a7977

計測のUUID

type
Array of strings (JobType)
Items Enum: "update" "finalize" "delete"
Example: type=update
  • update
    • 計測内の動画データのうち、新しくサーバーが受信した部分（HLSにまだ変換されていない部分）を HLSに変換するジョブ。通常は計測実行中に行います。
  • finalize
    • 計測全体をサーバーに回収した後に、動画データ全体をHLSに変換するジョブ
  • delete
    • 変換によって作成されたHLSデータを削除するジョブ。 このジョブを実行すると、HLSプレイリスト、セグメントファイル、 データベース内のHLSに関する情報が削除され、この動画のHLSによる再生はできなくなります。
status
Array of strings (JobStatus)
Items Enum: "unprocessed" "processing" "succeeded" "failed"
Example: status=succeeded

ジョブのステータス

limit
number
Example: limit=1000

1回のリクエストで取得する件数

page
integer >= 1
Default: 1

取得するページ番号

sort
string
Default: "created_at"
Enum: "created_at" "updated_at"
Example: sort=created_at

並べ替えに使用するキー

order
string
Enum: "asc" "desc"
Example: order=asc

並べ替えの順序

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "total_count": 100
}

Create HLS Job Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） HLSへの変換ジョブを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
meas_uuid
required
string

計測のUUID

type
required
string (JobType)
Enum: "update" "finalize" "delete"
  • update
    • 計測内の動画データのうち、新しくサーバーが受信した部分（HLSにまだ変換されていない部分）を HLSに変換するジョブ。通常は計測実行中に行います。
  • finalize
    • 計測全体をサーバーに回収した後に、動画データ全体をHLSに変換するジョブ
  • delete
    • 変換によって作成されたHLSデータを削除するジョブ。 このジョブを実行すると、HLSプレイリスト、セグメントファイル、 データベース内のHLSに関する情報が削除され、この動画のHLSによる再生はできなくなります。

Responses

Request samples

Content type
application/json
{
  • "meas_uuid": "a5170afc-9cc2-5327-e0e1-32746b5a7977",
  • "type": "update"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "ade4eea8-edc6-3ca5-c557-12a616c2028a",
  • "meas_uuid": "a5170afc-9cc2-5327-e0e1-32746b5a7977",
  • "type": "update",
  • "status": "unprocessed",
  • "message": "ok",
  • "created_at": "2000-01-02T03:04:5Z",
  • "updated_at": "2000-01-02T03:04:5Z"
}

Get HLS Playlist Deprecated

Depricated このエンドポイントの代わりに、Videoオブジェクトの hlsにあるPATHにしたがってPlaylistを取得してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
meas_uuid
required
string
Example: f967c530-f562-410a-991b-031c43142778

計測のUUID

channel
required
integer
Example: 1

チャンネル

query Parameters
force_end
boolean
Example: force_end=true

true にすると、取得するm3u8形式のプレイリストに強制的にEXT-X-ENDLISTを追加します。

Responses

Get HLS as FMP4 Deprecated

Deprecated このエンドポイントの代わりに POST /media/videos/{video_uuid}/mp4s を使用してください。 mp4リソース作成後、 MP4オブジェクトの file_pathにあるPATHに従って動画を取得してください

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
meas_uuid
required
string
Example: f967c530-f562-410a-991b-031c43142778

計測のUUID

channel
required
integer
Example: 1

チャンネル

Responses

List Videos Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）のリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
string
Example: uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

動画（video）のUUID

meas_uuid
string
Example: meas_uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

計測のUUID

channel
integer
Example: channel=1

計測のチャンネル。チャンネルが存在しない計測データ（iscp-v2）の動画のみを取得したい場合は0を指定します。未指定の場合、チャンネルの有無問わず全ての動画を取得します。

sort
string
Default: "create_at+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。例えば、 name- を指定すると、nameによる降順で出力されます。

  • channel
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページ番号

per_page
integer <= 1000
Default: 100

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get Video Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "68b91013-47e9-4e68-a965-892549587dfa",
  • "measurement_uuid": "d299eea4-d02c-4742-a97a-795346a0c005",
  • "measurement": {
    },
  • "edge_uuid": "a8afa022-7e60-4f6a-8686-5b99d8785d25",
  • "channel": 1,
  • "codec": "h264",
  • "source_data_type": "h264",
  • "source_data_name": "h264_camera_1",
  • "offset_time": 0,
  • "duration": 10000,
  • "fps": 29.98,
  • "width": 1920,
  • "height": 1080,
  • "status": "succeeded",
  • "hls": {
    },
  • "mp4s": [
    ],
  • "jpegs": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List JPEGs Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたJPEGデータのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create JPEG Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）を変換してJPEGデータを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Request Body schema: application/json
trimmed
boolean

時間範囲を指定してその部分のJPEGを作成する場合は true にします。

start_offset
integer

計測開始からのオフセット（マイクロ秒）。trimmedがtrueの場合は必須です。

duration
integer

長さ（マイクロ秒）。trimmedがtrueの場合は必須です。

fps
number <float>

フレームレート。値が省略された場合は、元のデータと同じフレームレートが使用されます。

quality
string (JpegQuality)
Enum: "high" "middle" "low"

JPEGの品質。デフォルトは 'middle' です。

  • high
  • middle
  • low

Responses

Request samples

Content type
application/json
{
  • "trimmed": false,
  • "start_offset": 0,
  • "duration": 10000,
  • "fps": 15,
  • "quality": "high"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete JPEG Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたJPEGデータを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Get JPEG Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたJPEGデータの情報を取得します。 JPEGファイル自体を取得するには、GET /media/videos/{video_uuid}/jpegs/{jpeg_uuid}/images/selected.zip を使用してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Cancel Creating JPEG Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）からJPEGデータへの変換をキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "3279bdfb-9079-417e-8f94-ee8126da5933",
  • "start_offset": 5000,
  • "duration": 10000,
  • "trimmed": true,
  • "fps": 15,
  • "quality": "high",
  • "status": "succeeded",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get JPEG as zip Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） JPEGデータをZIPファイルにまとめた形で取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

jpeg_uuid
required
string
Example: 3279bdfb-9079-417e-8f94-ee8126da5933

JPEGのUUID

query Parameters
indexes
Array of integers
Example: indexes=1

取得したいJPEGのインデックス番号（最初の番号は1）。指定がない場合はすべて取得します。 indexes パラメーターを複数回指定することで、複数のJPEGファイルを取得することができます。

Responses

List MP4s Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたMP4データのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create MP4 Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）を変換してMP4データを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

Request Body schema: application/json
trimmed
boolean

時間範囲を指定してその部分のMP4を作成する場合は true にします。

start_offset
integer

動画の開始時刻からのオフセット（マイクロ秒）。trimmedがtrueの場合は必須です。

duration
integer

長さ（マイクロ秒）。trimmedがtrueの場合は必須です。

Responses

Request samples

Content type
application/json
{
  • "trimmed": false,
  • "start_offset": 0,
  • "duration": 10000
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete MP4 Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたMP4データを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Get MP4 Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）から変換されたMP4データの情報を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Cancel Creating MP4 Deprecated

（Deprecated。代わりに Prefix(/projects/00000000-0000-0000-0000-000000000000/)が付いたエンドポイントを使用してください） 動画（video）からMP4データへの変換をキャンセルします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
video_uuid
required
string
Example: 68b91013-47e9-4e68-a965-892549587dfa

変換元の動画（video）のUUID

mp4_uuid
required
string
Example: 34cd9cc6-4c62-4310-bbfd-04541f59ca0f

MP4のUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0108aeb1-f486-400f-9bcd-f176eee8b7e3",
  • "start_offset": 0,
  • "duration": 10000,
  • "trimmed": false,
  • "file_path": "/api/media/68b91013-47e9-4e68-a965-892549587dfa/mp4s/0108aeb1-f486-400f-9bcd-f176eee8b7e3/measurement.mp4",
  • "status": "unprocessed",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get realtime video stream Deprecated

Deprecated このエンドポイントの代わりに GET /v1/stream でデータを取得し、WebCodecsを使用して取得したデータをデコードしてください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: 421fecd4-646b-4ab8-a715-c4b888964b11

エッジのUUID

channel
required
integer
Example: 1

チャンネル

Responses

List HLSes Deprecated

Deprecated このエンドポイントではなく GET /media/videos を使用してください

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

query Parameters
start
integer
Example: start=123456789

取得対象範囲の始点（マイクロ秒単位のUNIX時刻）

end
integer
Example: end=1234567890

取得対象範囲の終点（マイクロ秒単位のUNIX時刻）

edge_uuid
string
Example: edge_uuid=3699e2b9-5d87-4dbd-9b85-098e7dfaee76

エッジのUUID

channel
integer
Example: channel=1

チャンネル

limit
integer
Example: limit=1000

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ]
}

Get HLS Playlist Deprecated

Depricated このエンドポイントの代わりに、Videoオブジェクトの hlsにあるPATHにしたがってPlaylistを取得してください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

meas_uuid
required
string
Example: f967c530-f562-410a-991b-031c43142778

計測のUUID

channel
required
integer
Example: 1

チャンネル

query Parameters
force_end
boolean
Example: force_end=true

true にすると、取得するm3u8形式のプレイリストに強制的にEXT-X-ENDLISTを追加します。

Responses

Get HLS as FMP4 Deprecated

Deprecated このエンドポイントの代わりに POST /media/videos/{video_uuid}/mp4s を使用してください。 mp4リソース作成後、 MP4オブジェクトの file_pathにあるPATHに従って動画を取得してください

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

meas_uuid
required
string
Example: f967c530-f562-410a-991b-031c43142778

計測のUUID

channel
required
integer
Example: 1

チャンネル

Responses

Get realtime video stream Deprecated

Deprecated このエンドポイントの代わりに GET /v1/stream でデータを取得し、WebCodecsを使用して取得したデータをデコードしてください。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
project_uuid
required
string
Example: 75c55669-b2ab-4f14-a871-8571c6afa1ef

プロジェクトのUUID

edge_uuid
required
string
Example: 421fecd4-646b-4ab8-a715-c4b888964b11

エッジのUUID

channel
required
integer
Example: 1

チャンネル

Responses