Table of Contents

icarResource

Description

Base class for a resource, defining self-link and meta data. Resources should use AllOf to incorporate this class.

Properties

Name Description Required Type
Self Uniform resource identifier (URI) of the resource (rel=self). No string
Meta Meta-data for the resource. Mandatory if you wish to support synchronisation. No icarMetaDataType
Location Unique location scheme and identifier combination. No icarIdentifierType

Examples

Example 1

{
  "resourceType": "resourceType",
  "@self": "@self",
  "meta": {
    "source": "source",
    "sourceId": "sourceId",
    "isDeleted": false,
    "modified": "2024-12-04T20:18:42.6873161+00:00",
    "created": "2024-12-04T20:18:42.6873174+00:00",
    "creator": "creator",
    "validFrom": "2024-12-04T20:18:42.6873194+00:00",
    "validTo": "2024-12-04T20:18:42.6873223+00:00"
  },
  "location": {
    "id": "id",
    "scheme": "scheme"
  }
}