Skip to content

Latest commit

 

History

History
818 lines (761 loc) · 30.7 KB

spec_JA.md

File metadata and controls

818 lines (761 loc) · 30.7 KB

Smart Data Models

エンティティアラート

オープン・ライセンス

文書は自動的に生成される

グローバルな説明指定された場所のユーザーまたはデバイスによって生成されたアラート。

バージョン: 0.0.3

プロパティのリスト

[*] 属性に型がない場合は、複数の型があるか、異なるフォーマット/パターンがある可能性があるためです。

  • address[object]: 郵送先住所 . Model: https://schema.org/address
  • alertSource[*]: 警告の発信源 . Model: http://schema.org/URL
  • alternateName[string]: この項目の別名
  • areaServed[string]: サービスまたは提供品が提供される地理的地域 . Model: https://schema.org/Text
  • category[string]: アラートのカテゴリ。Enum:'traffic, naturalDisaster, weather, environment, health, security, agriculture'.
  • data[object]: 取得したデータを含むペイロード
  • dataProvider[string]: ハーモナイズされたデータ・エンティティの提供者を識別する一連の文字。
  • dateCreated[date-time]: エンティティの作成タイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられます。
  • dateIssued[date-time]: ISO8601 UTCフォーマットによるアイテムの発行日時 . Model: https://schema.org/DateTime
  • dateModified[date-time]: エンティティの最終変更のタイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられる。
  • description[string]: この商品の説明
  • id[*]: エンティティの一意識別子
  • location[*]: アイテムへの Geojson 参照。Point、LineString、Polygon、MultiPoint、MultiLineString、MultiPolygon のいずれか。
  • name[string]: このアイテムの名前
  • owner[array]: 所有者の固有IDを参照するJSONエンコードされた文字列を含むリスト。
  • seeAlso[*]: アイテムに関する追加リソースを指すURIのリスト
  • severity[string]: アラームの重大性
  • source[string]: エンティティ・データの元のソースを URL として示す一連の文字。ソース・プロバイダの完全修飾ドメイン名、またはソース・オブジェクトの URL を推奨する。
  • subCategory[string]: アラートのサブカテゴリを記述する。列挙する：'trafficJam, carAccident, carWrongDirection, carStopped, pothole, roadClosed, roadWorks, hazardOnRoad, injuredBiker, pedestrianOnRoad, bikerOnRoad, tramApproaching, flood、津波、海岸イベント、地震、降雨、高温、低温、熱波、寒波、氷、雪、風、霧、竜巻、熱帯低気圧、ハリケーン、雪/氷、雷雨、火災リスク、雪崩リスク、洪水リスク、大気汚染、水質汚濁、花粉濃度、喘息発作、接触患者、転倒患者、心臓発作、不審な行動、強盗、暴行、市民混乱、建物火災、森林火災、有害雑草、カタツムリ、昆虫、げっ歯類、細菌、微生物、真菌、ダニ、ウイルス、線虫、灌漑、施肥
  • type[string]: NGSIエンティティタイプ。アラート
  • validFrom[date-time]: この予報の有効期間の開始日をISO8601形式で表す。 . Model: https://schema.org/DateTime
  • validTo[date-time]: ISO8601形式でのこの予報の有効期間の終了日 . Model: https://schema.org/DateTime

必須プロパティ

  • alertSource
  • category
  • dateIssued
  • id
  • type

このエンティティはアラートをモデル化し、交通渋滞、事故、天候、高濃度の汚染物質などに関連するアラートを送信するために使用できる。このモデルの目的は、このようなアラートに基づいて、ユーザーへの通知の生成や他のアクションのトリガをサポートすることである。アラートは特定の状況によって生成される。アラートの主な特徴は、予測不可能であり、繰り返し発生するデータではないということである。つまり、アラートは事故や高濃度の汚染物質の測定値であることもあれば、患者の転倒や反対方向に走る車であることもあります。 コンテキストデータの例としては、アラートのタイプ（交通、天候、セキュリティ、汚染など）、重大度、場所などがある。

プロパティのデータモデル記述

アルファベット順（クリックで詳細表示）

full yaml details 
Alert:      
  description: An alert generated by a user or device in a given location      
  properties:      
    address:      
      description: The mailing address      
      properties:      
        addressCountry:      
          description: 'The country. For example, Spain'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressCountry      
            type: Property      
        addressLocality:      
          description: 'The locality in which the street address is, and which is in the region'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressLocality      
            type: Property      
        addressRegion:      
          description: 'The region in which the locality is, and which is in the country'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressRegion      
            type: Property      
        district:      
          description: 'A district is a type of administrative division that, in some countries, is managed by the local government'      
          type: string      
          x-ngsi:      
            type: Property      
        postOfficeBoxNumber:      
          description: 'The post office box number for PO box addresses. For example, 03578'      
          type: string      
          x-ngsi:      
            model: https://schema.org/postOfficeBoxNumber      
            type: Property      
        postalCode:      
          description: 'The postal code. For example, 24004'      
          type: string      
          x-ngsi:      
            model: https://schema.org/https://schema.org/postalCode      
            type: Property      
        streetAddress:      
          description: The street address      
          type: string      
          x-ngsi:      
            model: https://schema.org/streetAddress      
            type: Property      
        streetNr:      
          description: Number identifying a specific property on a public street      
          type: string      
          x-ngsi:      
            type: Property      
      type: object      
      x-ngsi:      
        model: https://schema.org/address      
        type: Property      
    alertSource:      
      anyOf:      
        - description: Identifier format of any NGSI entity      
          maxLength: 256      
          minLength: 1      
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
          type: string      
          x-ngsi:      
            type: Property      
        - description: Identifier format of any NGSI entity      
          format: uri      
          type: string      
          x-ngsi:      
            type: Property      
      description: Source of the alert      
      x-ngsi:      
        model: http://schema.org/URL      
        type: Relationship      
    alternateName:      
      description: An alternative name for this item      
      type: string      
      x-ngsi:      
        type: Property      
    areaServed:      
      description: The geographic area where a service or offered item is provided      
      type: string      
      x-ngsi:      
        model: https://schema.org/Text      
        type: Property      
    category:      
      description: 'Category of the Alert. Enum:''traffic, naturalDisaster, weather, environment, health, security, agriculture'''      
      enum:      
        - traffic      
        - naturalDisaster      
        - weather      
        - environment      
        - health      
        - security      
        - agriculture      
      type: string      
      x-ngsi:      
        type: Property      
    data:      
      description: Payload containing the data retrieved      
      type: object      
      x-ngsi:      
        type: Property      
    dataProvider:      
      description: A sequence of characters identifying the provider of the harmonised data entity      
      type: string      
      x-ngsi:      
        type: Property      
    dateCreated:      
      description: Entity creation timestamp. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    dateIssued:      
      description: The date and time the item was issued in ISO8601 UTC format      
      format: date-time      
      type: string      
      x-ngsi:      
        model: https://schema.org/DateTime      
        type: Property      
    dateModified:      
      description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    description:      
      description: A description of this item      
      type: string      
      x-ngsi:      
        type: Property      
    id:      
      anyOf:      
        - description: Identifier format of any NGSI entity      
          maxLength: 256      
          minLength: 1      
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
          type: string      
          x-ngsi:      
            type: Property      
        - description: Identifier format of any NGSI entity      
          format: uri      
          type: string      
          x-ngsi:      
            type: Property      
      description: Unique identifier of the entity      
      x-ngsi:      
        type: Property      
    location:      
      description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'      
      oneOf:      
        - description: Geojson reference to the item. Point      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                type: number      
              minItems: 2      
              type: array      
            type:      
              enum:      
                - Point      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON Point      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. LineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  type: number      
                minItems: 2      
                type: array      
              minItems: 2      
              type: array      
            type:      
              enum:      
                - LineString      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON LineString      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. Polygon      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    type: number      
                  minItems: 2      
                  type: array      
                minItems: 4      
                type: array      
              type: array      
            type:      
              enum:      
                - Polygon      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON Polygon      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiPoint      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  type: number      
                minItems: 2      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiPoint      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiPoint      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiLineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    type: number      
                  minItems: 2      
                  type: array      
                minItems: 2      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiLineString      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiLineString      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiLineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    items:      
                      type: number      
                    minItems: 2      
                    type: array      
                  minItems: 4      
                  type: array      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiPolygon      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiPolygon      
          type: object      
          x-ngsi:      
            type: GeoProperty      
      x-ngsi:      
        type: GeoProperty      
    name:      
      description: The name of this item      
      type: string      
      x-ngsi:      
        type: Property      
    owner:      
      description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)      
      items:      
        anyOf:      
          - description: Identifier format of any NGSI entity      
            maxLength: 256      
            minLength: 1      
            pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
            type: string      
            x-ngsi:      
              type: Property      
          - description: Identifier format of any NGSI entity      
            format: uri      
            type: string      
            x-ngsi:      
              type: Property      
        description: Unique identifier of the entity      
        x-ngsi:      
          type: Property      
      type: array      
      x-ngsi:      
        type: Property      
    seeAlso:      
      description: list of uri pointing to additional resources about the item      
      oneOf:      
        - items:      
            format: uri      
            type: string      
          minItems: 1      
          type: array      
        - format: uri      
          type: string      
      x-ngsi:      
        type: Property      
    severity:      
      description: Severity of the Alarm      
      enum:      
        - informational      
        - low      
        - medium      
        - high      
        - critical      
      type: string      
      x-ngsi:      
        type: Property      
    source:      
      description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object'      
      type: string      
      x-ngsi:      
        type: Property      
    subCategory:      
      anyOf:      
        - enum:      
            - airPollution      
            - assault      
            - asthmaAttack      
            - avalancheRisk      
            - bacteria      
            - badSeaState      
            - bikerOnRoad      
            - buildingFire      
            - bumpedPatient      
            - carAccident      
            - carStopped      
            - carWrongDirection      
            - coastalEvent      
            - civilDisorder      
            - coldWave      
            - crowdRisk      
            - earthquake      
            - fallenPatient      
            - fertilisation      
            - fireRisk      
            - flood      
            - floodRisk      
            - fog      
            - forestFire      
            - fungus      
            - hazardOnRoad      
            - heartAttack      
            - heatWave      
            - highAtmosphericPressure      
            - highHumidity      
            - highTemperature      
            - hurricane      
            - ice      
            - injuredBiker      
            - insect      
            - irrigation      
            - lowAtmosphericPressure      
            - lowHumidity      
            - lowTemperature      
            - microbe      
            - mite      
            - nematodes      
            - noxiousWeed      
            - pedestrianOnRoad      
            - pollenConcentration      
            - pothole      
            - rainfall      
            - roadClosed      
            - roadWorks      
            - robbery      
            - rodent      
            - snail      
            - snow      
            - snow/ice      
            - suspiciousAction      
            - thunderstorms      
            - tornado      
            - trafficJam      
            - tramApproaching      
            - tropicalCyclone      
            - tsunami      
            - virus      
            - waterPollution      
            - wind      
        - description: 'Weather categories. Enum:'' avalanches,coastalEvent, coldWave, flood, fog, forestFire, heatWave, highTemperature, hurricane, ice, lowTemperature, rainfall, rain_flood, snow, snow_ice, thunderstorms, tornado, tropicalCyclone, tsunami, wind'''      
          enum:      
            - avalanches      
            - coastalEvent      
            - coldWave      
            - flood      
            - fog      
            - forestFire      
            - heatWave      
            - highTemperature      
            - hurricane      
            - ice      
            - lowTemperature      
            - rainfall      
            - rain_flood      
            - snow      
            - snow_ice      
            - thunderstorms      
            - tornado      
            - tropicalCyclone      
            - tsunami      
            - wind      
          type: string      
          x-ngsi:      
            type: Property      
      description: 'Describe the sub category of alert. Enum:''trafficJam, carAccident, carWrongDirection, carStopped, pothole, roadClosed, roadWorks, hazardOnRoad, injuredBiker, pedestrianOnRoad, bikerOnRoad, tramApproaching, flood, tsunami, coastalEvent, earthquake, rainfall, highTemperature, lowTemperature, heatWave, coldWave, ice, snow, wind, fog, tornado, tropicalCyclone, hurricane, snow/ice, thunderstorms, fireRisk, avalancheRisk, floodRisk, airPollution, waterPollution, pollenConcentration, asthmaAttack, bumpedPatient, fallenPatient, heartAttack, suspiciousAction, robbery, assault, civilDisorder, buildingFire, forestFire, noxiousWeed, snail, insect, rodent, bacteria, microbe, fungus,mite, virus, nematodes, irrigation, fertilisation'      
      type: string      
      x-ngsi:      
        type: Property      
    type:      
      description: NGSI Entity type. It has to be Alert      
      enum:      
        - Alert      
      type: string      
      x-ngsi:      
        type: Property      
    validFrom:      
      description: The start of the validity period for this forecast as a ISO8601 format      
      format: date-time      
      type: string      
      x-ngsi:      
        model: https://schema.org/DateTime      
        type: Property      
    validTo:      
      description: The end of the validity period for this forecast as a ISO8601 format      
      format: date-time      
      type: string      
      x-ngsi:      
        model: https://schema.org/DateTime      
        type: Property      
  required:      
    - id      
    - type      
    - alertSource      
    - category      
    - dateIssued      
  type: object      
  x-derived-from: ""      
  x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted  provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'      
  x-license-url: https://github.com/smart-data-models/dataModel.Alert/blob/master/Alert/LICENSE.md      
  x-model-schema: https://smart-data-models.github.io/dataModel.Alert/alert/schema.json      
  x-model-tags: ""      
  x-version: 0.0.3

ペイロードの例

警告 NGSI-v2 キー値の例

以下は、JSON-LD形式のアラートをkey-valuesとした例である。これはNGSI-v2と互換性があり、options=keyValuesを使用すると個々のエンティティのコンテキストデータを返す。

show/hide example 
{  
  "id": "Alert:1",  
  "type": "Alert",  
  "category": "traffic",  
  "subCategory": "trafficJam",  
  "severity": "high",  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      -3.712247222222222,  
      40.423852777777775  
    ]  
  },  
  "dateIssued": "2017-01-02T09:25:55.00Z",  
  "validFrom": "2017-01-02T09:25:55.00Z",  
  "validTo": "2017-01-02T10:25:55.00Z",  
  "description": "The road is completely blocked for 3kms",  
  "alertSource": "https://account.lab.fiware.org/users/8"  
}

アラート NGSI-v2 正規化例

以下は、正規化されたJSON-LD形式のアラートの例である。これは、オプションを使用しない場合、NGSI-v2と互換性があり、個々のエンティティのコンテキストデータを返します。

show/hide example 
{  
  "id": "Alert:1",  
  "type": "Alert",  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2019-06-06T12:06:06"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "2019-06-07T12:07:06"  
  },  
  "category": {  
    "type": "Text",  
    "value": "traffic"  
  },  
  "subCategory": {  
    "type": "Text",  
    "value": "trafficJam"  
  },  
  "validTo": {  
    "type": "DateTime",  
    "value": "2017-01-02T10:25:55.00Z"  
  },  
  "description": {  
    "type": "Text",  
    "value": "The road is completely blocked for 3kms"  
  },  
  "location": {  
    "type": "geo:json",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        -3.712247222222222,  
        40.423852777777775  
      ]  
    }  
  },  
  "dateIssued": {  
    "type": "DateTime",  
    "value": "2017-01-02T09:25:55.00Z"  
  },  
  "alertSource": {  
    "type": "Text",  
    "value": "https://account.lab.fiware.org/users/8"  
  },  
  "validFrom": {  
    "type": "DateTime",  
    "value": "2017-01-02T09:25:55.00Z"  
  },  
  "severity": {  
    "type": "Text",  
    "value": "high"  
  }  
}

警告 NGSI-LD キー値の例

これはJSON-LD形式のアラートをkey-valuesとして返す例である。これは NGSI-LD と互換性があり、options=keyValues を使うと個々のエンティティのコンテキストデータを返す。

show/hide example 
{  
  "id": "urn:ngsi-ld:Alert:Alert:1",  
  "type": "Alert",  
  "alertSource": "https://account.lab.fiware.org/users/8",  
  "category": "traffic",  
  "createdAt": "2019-06-06T12:06:06",  
  "dateIssued": "2017-01-02T09:25:55.00Z",  
  "description": "The road is completely blocked for 3kms",  
  "location": {  
    "coordinates": [  
      -3.712247222222222,  
      40.423852777777775  
    ],  
    "type": "Point"  
  },  
  "modifiedAt": "2019-06-07T12:07:06",  
  "severity": "high",  
  "subCategory": "trafficJam",  
  "validFrom": "2017-01-02T09:25:55.00Z",  
  "validTo": "2017-01-02T10:25:55.00Z",  
  "@context": [  
    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.Alert/master/context.jsonld"  
  ]  
}

アラート NGSI-LD 正規化例

以下は、正規化されたJSON-LD形式のアラートの例である。これは、オプションを使用しない場合はNGSI-LDと互換性があり、個々のエンティティのコンテキストデータを返します。

show/hide example 
{  
    "id": "urn:ngsi-ld:Alert:Alert:1",  
    "type": "Alert",  
    "alertSource": {  
        "type": "Property",  
        "value": "https://account.lab.fiware.org/users/8"  
    },  
    "category": {  
        "type": "Property",  
        "value": "traffic"  
    },  
    "createdAt": "2019-06-06T12:06:06",  
    "dateIssued": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2017-01-02T09:25:55.00Z"  
        }  
    },  
    "description": {  
        "type": "Property",  
        "value": "The road is completely blocked for 3kms"  
    },  
    "location": {  
        "type": "GeoProperty",  
        "value": {  
            "type": "Point",  
            "coordinates": [  
                -3.712247222222222,  
                40.423852777777775  
            ]  
        }  
    },  
    "modifiedAt": "2019-06-07T12:07:06",  
    "severity": {  
        "type": "Property",  
        "value": "high"  
    },  
    "subCategory": {  
        "type": "Property",  
        "value": "trafficJam"  
    },  
    "validFrom": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2017-01-02T09:25:55.00Z"  
        }  
    },  
    "validTo": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2017-01-02T10:25:55.00Z"  
        }  
    },  
    "@context": [  
        "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",  
        "https://raw.githubusercontent.com/smart-data-models/dataModel.Alert/master/context.jsonld"  
    ]  
}

マグニチュード単位の扱い方については、FAQ 10を参照のこと。

Smart Data Models +++ Contribution Manual +++ About