Skip to content

Latest commit

 

History

History
534 lines (477 loc) · 19 KB

spec_JA.md

File metadata and controls

534 lines (477 loc) · 19 KB
Raw

Smart Data Models

エンティティDataServiceRun

オープン・ライセンス

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

グローバルな記述：**データサービス（例：DataServiceDCAT-AP）の特定の実行を表す。

バージョン: 0.0.1

プロパティのリスト

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

  • alternateName[string]: この項目の別名
  • configuration[array]: サービスの技術的構成。この属性は、サービスの設定（出力形式、URLなど）に関係し、このモデルによって定義された標準属性によって現在カバーされていないパラメータをキャプチャするプロパティとその値の配列であることを意図しています。 . Model: https://schema.org/StructuredValue
  • dataProvider[string]: ハーモナイズされたデータ・エンティティの提供者を識別する一連の文字。
  • dateCreated[date-time]: エンティティの作成タイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられます。
  • dateModified[date-time]: エンティティの最終変更のタイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられる。
  • description[string]: この商品の説明
  • id[*]: エンティティの一意識別子
  • name[string]: このアイテムの名前
  • owner[array]: 所有者の固有IDを参照するJSONエンコードされた文字列を含むリスト。
  • resultEntities[array]: サービス実行中に生成されたNGSI-LDエンティティを指す参照のリスト。
  • resultExternal[array]: サービス実行中に生成された外部結果を指すuriのリスト。
  • seeAlso[*]: アイテムに関する追加リソースを指すURIのリスト
  • service[*]: 対応するデータサービスを表すNGSI-LDエンティティ（例えばDataServiceDCAT-AP型）を指す参照。
  • source[string]: エンティティ・データの元のソースを URL として示す一連の文字。ソース・プロバイダの完全修飾ドメイン名、またはソース・オブジェクトの URL を推奨する。
  • sourceEntities[array]: サービスラン内でソースとして動作したNGSI-LDエンティティを指す参照のリスト。
  • sourceExternal[array]: サービス実行時にソースとして機能した外部結果を指すURIのリスト。
  • type[string]: NGSIエンティティタイプ。DataServiceRunでなければならない。

必須プロパティ

  • id
  • type

このデータ・モデルはDCAT 2.1.0標準には属さない。

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

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

full yaml details 
DataServiceRun:      
  description: A representation of one specific run of a data service (e.g. DataServiceDCAT-AP).      
  properties:      
    alternateName:      
      description: An alternative name for this item      
      type: string      
      x-ngsi:      
        type: Property      
    configuration:      
      description: 'Technical configuration of the service. This attribute is intended to be an array of properties and their values which capture parameters which have to do with the configuration of a service (output format, URL, etc.) and which are not currently covered by the standard attributes defined by this model'      
      items:      
        properties:      
          parameter:      
            format: text      
            type: string      
          value:      
            type: string      
        type: object      
      type: array      
      x-ngsi:      
        model: https://schema.org/StructuredValue      
        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      
    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      
    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      
    resultEntities:      
      description: A list of references pointing to NGSI-LD entities that were generated within a service run      
      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      
      type: array      
      x-ngsi:      
        type: Relationship      
    resultExternal:      
      description: A list of uri pointing to external results that were generated within a service run      
      items:      
        format: uri      
        type: string      
      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      
    service:      
      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: A reference pointing to the NGSI-LD entity representing the corresponding data service (e.g. of type DataServiceDCAT-AP)      
      x-ngsi:      
        type: Relationship      
    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      
    sourceEntities:      
      description: A list of references pointing to NGSI-LD entities that acted as source within a service run      
      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      
      type: array      
      x-ngsi:      
        type: Relationship      
    sourceExternal:      
      description: A list of uri pointing to external results that acted as source within a service run      
      items:      
        format: uri      
        type: string      
      type: array      
      x-ngsi:      
        type: Property      
    type:      
      description: NGSI entity type. It has to be DataServiceRun      
      enum:      
        - DataServiceRun      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - id      
    - type      
  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.DCAT-AP/blob/master/DataServiceRun/LICENSE.md      
  x-model-schema: https://smart-data-models.github.io/dataModel.DCAT-AP/DataServiceRun/schema.json      
  x-model-tags: SALTED      
  x-version: 0.0.1

ペイロードの例

DataServiceRun NGSI-v2 キー値の例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:DataServiceRun:example-1234",  
  "type": "DataServiceRun",  
  "configuration": [  
    {  
      "parameter": "param1",  
      "value": "10"  
    },  
    {  
      "parameter": "param2",  
      "value": "3"  
    }  
  ],  
  "dateCreated": "2022-06-21T08:24:35.905712+02:00",  
  "dateModified": "2022-06-22T09:24:35.905712+02:00",  
  "description": "This is a representation of one specific run of a data service.",  
  "resultEntities": [  
    "urn:ngsi-ld:KeyPerformanceIndicator:example3",  
    "urn:ngsi-ld:KeyPerformanceIndicator:example4"  
  ],  
  "resultExternal": [  
    "http://1.2.3.4:5678/files/example-file-3",  
    "http://1.2.3.4:5678/files/example-file-4"  
  ],  
  "sourceEntities": [  
    "urn:ngsi-ld:Organization:example1",  
    "urn:ngsi-ld:Organization:example2"  
  ],  
  "sourceExternal": [  
    "http://1.2.3.4:5678/files/example-file-1",  
    "http://1.2.3.4:5678/files/example-file-2"  
  ],  
  "service": "urn:ngsi-ld:DataServiceDCAT-AP:example"  
}

DataServiceRun NGSI-v2 正規化例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:DataServiceRun:example-1234",  
  "type": "DataServiceRun",  
  "configuration": {  
    "type": "StructuredValue",  
    "value": [  
      {  
        "parameter": "param1",  
        "value": "10"  
      },  
      {  
        "parameter": "param2",  
        "value": "3"  
      }  
    ]  
  },  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "2022-06-21T08:24:35.905712+02:00"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "2022-06-22T09:24:35.905712+02:00"  
  },  
  "description": {  
    "type": "Text",  
    "value": "This is a representation of one specific run of a data service."  
  },  
  "resultEntities": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:KeyPerformanceIndicator:example3",  
      "urn:ngsi-ld:KeyPerformanceIndicator:example4"  
    ]  
  },  
  "resultExternal": {  
    "type": "StructuredValue",  
    "value": [  
      "http://1.2.3.4:5678/files/example-file-3",  
      "http://1.2.3.4:5678/files/example-file-4"  
    ]  
  },  
  "sourceEntities": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:Organization:example1",  
      "urn:ngsi-ld:Organization:example2"  
    ]  
  },  
  "sourceExternal": {  
    "type": "StructuredValue",  
    "value": [  
      "http://1.2.3.4:5678/files/example-file-1",  
      "http://1.2.3.4:5678/files/example-file-2"  
    ]  
  },  
  "service": {  
    "type": "Text",  
    "value": "urn:ngsi-ld:DataServiceDCAT-AP:example"  
  }  
}

DataServiceRun NGSI-LD キー値の例

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

show/hide example 
{  
  "id": "urn:ngsi-ld:DataServiceRun:example-1234",  
  "type": "DataServiceRun",  
  "configuration": [  
    {  
      "parameter": "param1",  
      "value": "10"  
    },  
    {  
      "parameter": "param2",  
      "value": "3"  
    }  
  ],  
  "dateCreated": "2022-06-21T08:24:35.905712+02:00",  
  "dateModified": "2022-06-22T09:24:35.905712+02:00",  
  "description": "This is a representation of one specific run of a data service.",  
  "resultEntities": [  
    "urn:ngsi-ld:KeyPerformanceIndicator:example3",  
    "urn:ngsi-ld:KeyPerformanceIndicator:example4"  
  ],  
  "resultExternal": [  
    "http://1.2.3.4:5678/files/example-file-3",  
    "http://1.2.3.4:5678/files/example-file-4"  
  ],  
  "sourceEntities": [  
    "urn:ngsi-ld:Organization:example1",  
    "urn:ngsi-ld:Organization:example2"  
  ],  
  "sourceExternal": [  
    "http://1.2.3.4:5678/files/example-file-1",  
    "http://1.2.3.4:5678/files/example-file-2"  
  ],  
  "service": "urn:ngsi-ld:DataServiceDCAT-AP:example",  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.DCAT-AP/master/context.jsonld"  
  ]  
}

DataServiceRun NGSI-LD 正規化例

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

show/hide example 
{  
    "id": "urn:ngsi-ld:DataServiceRun:example-1234",  
    "type": "DataServiceRun",  
    "configuration": {  
        "type": "Property",  
        "value": [  
            {  
                "parameter": "param1",  
                "value": "10"  
            },  
            {  
                "parameter": "param2",  
                "value": "3"  
            }  
        ]  
    },  
    "dateCreated": {  
        "type": "Property",  
        "value": "2022-06-21T08:24:35.905712+02:00"  
    },  
    "dateModified": {  
        "type": "Property",  
        "value": "2022-06-22T09:24:35.905712+02:00"  
    },  
    "description": {  
        "type": "Property",  
        "value": "This is a representation of one specific run of a data service."  
    },  
    "resultEntities": {  
        "type": "Relationship",  
        "object": [  
            "urn:ngsi-ld:KeyPerformanceIndicator:example3",  
            "urn:ngsi-ld:KeyPerformanceIndicator:example4"  
        ]  
    },  
    "resultExternal": {  
        "type": "Property",  
        "value": [  
            "http://1.2.3.4:5678/files/example-file-3",  
            "http://1.2.3.4:5678/files/example-file-4"  
        ]  
    },  
    "sourceEntities": {  
        "type": "Relationship",  
        "object": [  
            "urn:ngsi-ld:Organization:example1",  
            "urn:ngsi-ld:Organization:example2"  
        ]  
    },  
    "sourceExternal": {  
        "type": "Property",  
        "value": [  
            "http://1.2.3.4:5678/files/example-file-1",  
            "http://1.2.3.4:5678/files/example-file-2"  
        ]  
    },  
    "service": {  
        "type": "Relationship",  
        "object": "urn:ngsi-ld:DataServiceDCAT-AP:example"  
    },  
    "@context": [  
      "https://raw.githubusercontent.com/smart-data-models/dataModel.DataServices/master/context.jsonld"  
  ]  
  }

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

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