Skip to content

Latest commit

 

History

History
187 lines (109 loc) · 3.99 KB

EREResponse.md

File metadata and controls

187 lines (109 loc) · 3.99 KB

Class: EREResponse

Root class to represent all the responses sent by the ERE.

__

  • NOTE: this is an abstract class and should not be instantiated directly

URI: ere:EREResponse

 classDiagram
    class EREResponse
    click EREResponse href "../EREResponse/"
      EREMessage <|-- EREResponse
        click EREMessage href "../EREMessage/"
      

      EREResponse <|-- EntityMentionResolutionResponse
        click EntityMentionResolutionResponse href "../EntityMentionResolutionResponse/"
      EREResponse <|-- EREErrorResponse
        click EREErrorResponse href "../EREErrorResponse/"
      

      EREResponse : ere_request_id
        
      EREResponse : timestamp
        
      EREResponse : type
Loading

Inheritance

Slots

Name Cardinality and Range Description Inheritance
type 1
String		 The type of the request or result EREMessage
ere_request_id 1
String		 A string representing the unique ID of an ERE request, or the ID of the reque... EREMessage
timestamp 0..1
Datetime		 The time when the message was created EREMessage

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self ere:EREResponse
native ere:EREResponse

LinkML Source

Direct

Details ```yaml name: EREResponse description: 'Root class to represent all the responses sent by the ERE.

' from_schema: https://data.europa.eu/ers/schema/ere is_a: EREMessage abstract: true

</details>

### Induced

<details>
```yaml
name: EREResponse
description: 'Root class to represent all the responses sent by the ERE.

  '
from_schema: https://data.europa.eu/ers/schema/ere
is_a: EREMessage
abstract: true
attributes:
  type:
    name: type
    description: "The type of the request or result.\n\nAs per LinkML specification,\
      \ `designates_type` is used here in order to allow for this\nslot to tell the\
      \ concrete subclass that an instance (such as a JSON object) belongs to.\n\n\
      In other words, a particular request will have `type` set with values like \n\
      `EntityMentionResolutionRequest` or `EntityResolutionResult`\n"
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    designates_type: true
    alias: type
    owner: EREResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  ere_request_id:
    name: ere_request_id
    description: 'A string representing the unique ID of an ERE request, or the ID
      of the request a response is about.

      This **is not** the same as `request_id` + `source_id`.


      Note on notification responses: as per ERE contract, an `EntityMentionResolutionResponse`
      message

      can originate from within the ERE, without any previous request counterpart,
      as a notification of

      resolution update. In this case, `ere_request_id` has the prefix `ereNotification:`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: ere_request_id
    owner: EREResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  timestamp:
    name: timestamp
    description: 'The time when the message was created. Should be in ISO-8601 format.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: timestamp
    owner: EREResponse
    domain_of:
    - EREMessage
    range: datetime