Entity

Base type for all Caliper entities

  • id
    required

    An IRI can be either:

    1. A URI (any valid URI scheme)
    2. A URN in the format "urn:uuid:" where UUID is a version 4 UUID
    • Type: string · IriPattern: ^[a-z][a-z0-9+.-]*:Format: url

      An IRI can be either:

      1. A URI (any valid URI scheme)
      2. A URN in the format "urn:uuid:" where UUID is a version 4 UUID
  • type
    Type: string · EntityTypeenum
    required
    values
    • Entity
    • Agent
    • Person
    • SoftwareApplication
    • Organization
  • dateCreated
    Type: string · IsoDateTimePattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • dateModified
    Type: string · IsoDateTimePattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string
  • extensions
    Type: object · Extensions
    • propertyName
      Type: anything
  • name
    Type: string
  • otherIdentifiers
    Type: array

    System identifier for external references

    • identifier
      Type: string
      required
    • type
      Type: string · SystemIdentifierTypeenum
      required
      values
      • AccountUserName
      • EmailAddress
      • LisSourcedId
      • LtiContextId
      • LtiDeploymentId
    • source
      • dateCreated
        Type: string · IsoDateTimePattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$Format: date-time

        the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

      • dateModified
        Type: string · IsoDateTimePattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$Format: date-time

        the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

      • description
        Type: string
      • extensions
        Type: object · Extensions
      • host
        Type: string
      • ipAddress
        Type: string
      • name
        Type: string
      • type
        enum
        const:  
        SoftwareApplication
        values
        • SoftwareApplication
      • userAgent
        Type: string
      • version
        Type: string