@twin.org/dataspace-models 0.0.3-next.18 → 0.0.3-next.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +4 -44
  2. package/dist/es/dataTypes/dataspaceDataTypes.js +4 -1
  3. package/dist/es/dataTypes/dataspaceDataTypes.js.map +1 -1
  4. package/dist/es/models/dataspaceContexts.js +3 -0
  5. package/dist/es/models/dataspaceContexts.js.map +1 -1
  6. package/dist/types/models/dataspaceContexts.d.ts +3 -0
  7. package/docs/changelog.md +14 -0
  8. package/docs/examples.md +33 -1
  9. package/docs/reference/classes/DataspaceDataTypes.md +1 -1
  10. package/docs/reference/classes/TransferProcess.md +15 -15
  11. package/docs/reference/interfaces/IActivityLogDates.md +2 -2
  12. package/docs/reference/interfaces/IActivityLogDetails.md +6 -6
  13. package/docs/reference/interfaces/IActivityLogEntry.md +11 -11
  14. package/docs/reference/interfaces/IActivityLogEntryGetRequest.md +1 -1
  15. package/docs/reference/interfaces/IActivityLogEntryGetResponse.md +1 -1
  16. package/docs/reference/interfaces/IActivityLogStatusNotification.md +3 -3
  17. package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md +1 -1
  18. package/docs/reference/interfaces/IActivityLogStatusRequest.md +1 -1
  19. package/docs/reference/interfaces/IActivityQuery.md +3 -3
  20. package/docs/reference/interfaces/IActivityStreamNotifyRequest.md +1 -1
  21. package/docs/reference/interfaces/IActivityTask.md +2 -2
  22. package/docs/reference/interfaces/ICompleteTransferRequest.md +3 -3
  23. package/docs/reference/interfaces/ICompleteTransferResponse.md +2 -2
  24. package/docs/reference/interfaces/IDataAssetEntitiesRequest.md +3 -3
  25. package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +2 -2
  26. package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +2 -2
  27. package/docs/reference/interfaces/IDataAssetItemList.md +3 -3
  28. package/docs/reference/interfaces/IDataAssetItemListResult.md +2 -2
  29. package/docs/reference/interfaces/IDataAssetQuery.md +1 -1
  30. package/docs/reference/interfaces/IDataAssetQueryRequest.md +3 -3
  31. package/docs/reference/interfaces/IDataspaceActivity.md +2 -2
  32. package/docs/reference/interfaces/IDataspaceApp.md +5 -5
  33. package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +11 -11
  34. package/docs/reference/interfaces/IDataspaceControlPlaneResolverComponent.md +2 -2
  35. package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +6 -6
  36. package/docs/reference/interfaces/IEntitySet.md +2 -2
  37. package/docs/reference/interfaces/IExecutionPayload.md +3 -3
  38. package/docs/reference/interfaces/IFilteringQuery.md +3 -3
  39. package/docs/reference/interfaces/IGetTransferProcessRequest.md +2 -2
  40. package/docs/reference/interfaces/IGetTransferProcessResponse.md +2 -2
  41. package/docs/reference/interfaces/INegotiationCallback.md +3 -3
  42. package/docs/reference/interfaces/IQueryDataAssetRequest.md +3 -3
  43. package/docs/reference/interfaces/IRequestTransferRequest.md +2 -2
  44. package/docs/reference/interfaces/IRequestTransferResponse.md +2 -2
  45. package/docs/reference/interfaces/IStartTransferRequest.md +3 -3
  46. package/docs/reference/interfaces/IStartTransferResponse.md +2 -2
  47. package/docs/reference/interfaces/ISuspendTransferRequest.md +3 -3
  48. package/docs/reference/interfaces/ISuspendTransferResponse.md +2 -2
  49. package/docs/reference/interfaces/ITaskApp.md +2 -2
  50. package/docs/reference/interfaces/ITerminateTransferRequest.md +3 -3
  51. package/docs/reference/interfaces/ITerminateTransferResponse.md +2 -2
  52. package/docs/reference/interfaces/ITransferContext.md +9 -9
  53. package/docs/reference/interfaces/ITransferContextResponse.md +1 -1
  54. package/docs/reference/interfaces/ITransferProcess.md +15 -15
  55. package/docs/reference/variables/ActivityProcessingStatus.md +5 -5
  56. package/docs/reference/variables/DataRequestType.md +2 -2
  57. package/docs/reference/variables/DataspaceContexts.md +3 -1
  58. package/docs/reference/variables/DataspaceTypes.md +1 -1
  59. package/docs/reference/variables/TransferProcessRole.md +2 -2
  60. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
- # TWIN Dataspace Models
1
+ # Dataspace Models
2
2
 
3
- Models which define the structure of the dataspace contracts and connectors.
3
+ This package defines the shared contracts and data types used across control plane and data plane components. It provides the common language that keeps request payloads, transfer records, and activity structures aligned between services and clients.
4
+
5
+ The exported interfaces and entities are designed to support consistent integration behaviour across the repository, reducing mismatch risks when components evolve.
4
6
 
5
7
  ## Installation
6
8
 
@@ -8,48 +10,6 @@ Models which define the structure of the dataspace contracts and connectors.
8
10
  npm install @twin.org/dataspace-models
9
11
  ```
10
12
 
11
- ## Overview
12
-
13
- This package provides the core interfaces and entities for the TWIN Dataspace Connector, implementing the Eclipse Dataspace Protocol (DSP) specification.
14
-
15
- ### Key Components
16
-
17
- #### Control Plane
18
-
19
- - `IDataspaceControlPlaneComponent` - Interface for DSP protocol operations (negotiation, transfer management)
20
- - `IDataspaceControlPlaneResolverComponent` - Interface for resolving `consumerPid` to transfer context
21
- - `ITransferContext` - Transfer context containing datasetId, agreement, and policies
22
- - `TransferProcessEntity` - Entity storage model for transfer processes
23
-
24
- #### Data Plane
25
-
26
- - `IDataspaceDataPlaneComponent` - Interface for data access operations (GET/query entities)
27
- - `IDataspaceApp` - Interface for Dataspace Apps that handle specific datasets
28
-
29
- #### Shared Entities
30
-
31
- - `TransferProcessEntity` - Shared between Control Plane and Data Plane via entity storage
32
- - Primary key: `id` (consumerPid)
33
- - Stores: state, datasetId, agreement, dataAddress, token expiration
34
- - Used for `consumerPid` flow
35
-
36
- ### Architecture
37
-
38
- ```text
39
- Control Plane Data Plane
40
- │ │
41
- │ Creates/Updates │ Reads
42
- │ │
43
- └───── TransferProcessEntity ───┘
44
- (shared storage)
45
- ```
46
-
47
- The unified architecture enables:
48
-
49
- - Transfer-based access via `consumerPid` parameter
50
- - Shared state without resolver API calls
51
- - Policy enforcement from agreements
52
-
53
13
  ## Examples
54
14
 
55
15
  Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
@@ -21,7 +21,10 @@ export class DataspaceDataTypes {
21
21
  schema: DataspaceActivitySchema
22
22
  }
23
23
  ];
24
- DataTypeHelper.registerTypes(DataspaceContexts.JsonSchemaNamespace, DataspaceContexts.JsonSchemaNamespace, types);
24
+ DataTypeHelper.registerTypes(DataspaceContexts.JsonSchemaNamespace, undefined, types.map(t => ({
25
+ type: `Dataspace${t.type}`,
26
+ schema: t.schema
27
+ })));
25
28
  }
26
29
  }
27
30
  //# sourceMappingURL=dataspaceDataTypes.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"dataspaceDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/dataspaceDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,uBAAuB,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE9F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,wBAAwB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,wBAAwB,CAAC,aAAa,EAAE,CAAC;QAEzC,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,cAAc,CAAC,QAAQ;gBAC7B,MAAM,EAAE,uBAAuB;aAC/B;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAC3B,iBAAiB,CAAC,mBAAmB,EACrC,iBAAiB,CAAC,mBAAmB,EACrC,KAAK,CACL,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { ActivityStreamsDataTypes } from \"@twin.org/standards-w3c-activity-streams\";\nimport { DataspaceContexts } from \"../models/dataspaceContexts.js\";\nimport { DataspaceTypes } from \"../models/dataspaceTypes.js\";\nimport DataspaceActivitySchema from \"../schemas/DataspaceActivity.json\" with { type: \"json\" };\n\n/**\n * Dataspace datatypes.\n */\nexport class DataspaceDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tActivityStreamsDataTypes.registerRedirects();\n\t\tActivityStreamsDataTypes.registerTypes();\n\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: DataspaceTypes.Activity,\n\t\t\t\tschema: DataspaceActivitySchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\ttypes\n\t\t);\n\t}\n}\n"]}
1
+ {"version":3,"file":"dataspaceDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/dataspaceDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,uBAAuB,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE9F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,wBAAwB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,wBAAwB,CAAC,aAAa,EAAE,CAAC;QAEzC,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,cAAc,CAAC,QAAQ;gBAC7B,MAAM,EAAE,uBAAuB;aAC/B;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAC3B,iBAAiB,CAAC,mBAAmB,EACrC,SAAS,EACT,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACf,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE;YAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;SAChB,CAAC,CAAC,CACH,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { ActivityStreamsDataTypes } from \"@twin.org/standards-w3c-activity-streams\";\nimport { DataspaceContexts } from \"../models/dataspaceContexts.js\";\nimport { DataspaceTypes } from \"../models/dataspaceTypes.js\";\nimport DataspaceActivitySchema from \"../schemas/DataspaceActivity.json\" with { type: \"json\" };\n\n/**\n * Dataspace datatypes.\n */\nexport class DataspaceDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tActivityStreamsDataTypes.registerRedirects();\n\t\tActivityStreamsDataTypes.registerTypes();\n\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: DataspaceTypes.Activity,\n\t\t\t\tschema: DataspaceActivitySchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\tundefined,\n\t\t\ttypes.map(t => ({\n\t\t\t\ttype: `Dataspace${t.type}`,\n\t\t\t\tschema: t.schema\n\t\t\t}))\n\t\t);\n\t}\n}\n"]}
@@ -5,6 +5,9 @@
5
5
  */
6
6
  // eslint-disable-next-line @typescript-eslint/naming-convention
7
7
  export const DataspaceContexts = {
8
+ /**
9
+ * The namespace location of the hosted version of the JSON Schema.
10
+ */
8
11
  JsonSchemaNamespace: "https://schema.twindev.org/dataspace/"
9
12
  };
10
13
  //# sourceMappingURL=dataspaceContexts.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"dataspaceContexts.js","sourceRoot":"","sources":["../../../src/models/dataspaceContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,mBAAmB,EAAE,uCAAuC;CACnD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts related to Dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceContexts = {\n\tJsonSchemaNamespace: \"https://schema.twindev.org/dataspace/\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceContexts = (typeof DataspaceContexts)[keyof typeof DataspaceContexts];\n"]}
1
+ {"version":3,"file":"dataspaceContexts.js","sourceRoot":"","sources":["../../../src/models/dataspaceContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC;;OAEG;IACH,mBAAmB,EAAE,uCAAuC;CACnD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts related to Dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceContexts = {\n\t/**\n\t * The namespace location of the hosted version of the JSON Schema.\n\t */\n\tJsonSchemaNamespace: \"https://schema.twindev.org/dataspace/\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceContexts = (typeof DataspaceContexts)[keyof typeof DataspaceContexts];\n"]}
@@ -2,6 +2,9 @@
2
2
  * The contexts related to Dataspace
3
3
  */
4
4
  export declare const DataspaceContexts: {
5
+ /**
6
+ * The namespace location of the hosted version of the JSON Schema.
7
+ */
5
8
  readonly JsonSchemaNamespace: "https://schema.twindev.org/dataspace/";
6
9
  };
7
10
  /**
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.20](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.19...dataspace-models-v0.0.3-next.20) (2026-03-17)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **dataspace-models:** Synchronize repo versions
9
+
10
+ ## [0.0.3-next.19](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.18...dataspace-models-v0.0.3-next.19) (2026-03-12)
11
+
12
+
13
+ ### Features
14
+
15
+ * improve validation ([#82](https://github.com/twinfoundation/dataspace/issues/82)) ([8bfaf7b](https://github.com/twinfoundation/dataspace/commit/8bfaf7b830f89b63575f8a51ee96bd8ac4da02f4))
16
+
3
17
  ## [0.0.3-next.18](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.17...dataspace-models-v0.0.3-next.18) (2026-03-09)
4
18
 
5
19
 
package/docs/examples.md CHANGED
@@ -1 +1,33 @@
1
- # @twin.org/dataspace-models - Examples
1
+ # Models Examples
2
+
3
+ Use these snippets to register dataspace data types and shape transfer process records for shared persistence.
4
+
5
+ ## DataspaceDataTypes
6
+
7
+ ```typescript
8
+ import { DataspaceDataTypes } from '@twin.org/dataspace-models';
9
+
10
+ DataspaceDataTypes.registerTypes();
11
+ console.log('registered'); // registered
12
+ ```
13
+
14
+ ## TransferProcess
15
+
16
+ ```typescript
17
+ import { TransferProcess } from '@twin.org/dataspace-models';
18
+
19
+ const process = new TransferProcess();
20
+ process.id = 'tp-001';
21
+ process.consumerPid = 'consumer-process-id';
22
+ process.providerPid = 'provider-process-id';
23
+ process.agreementId = 'urn:agreement:001';
24
+ process.datasetId = 'https://twin.example.org/data-service-1';
25
+ process.offerId = 'urn:policy:test-offer-read-consignment';
26
+ process.state = 'REQUESTED';
27
+ process.dateCreated = new Date().toISOString();
28
+ process.dateModified = process.dateCreated;
29
+ process.callbackAddress = 'https://consumer.example/dsp/callback';
30
+
31
+ console.log(process.consumerPid); // consumer-process-id
32
+ console.log(process.state); // REQUESTED
33
+ ```
@@ -14,7 +14,7 @@ Dataspace datatypes.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### registerTypes()
17
+ ### registerTypes() {#registertypes}
18
18
 
19
19
  > `static` **registerTypes**(): `void`
20
20
 
@@ -15,7 +15,7 @@ This entity is the persistent representation of ITransferProcess.
15
15
 
16
16
  ## Properties
17
17
 
18
- ### consumerPid
18
+ ### consumerPid {#consumerpid}
19
19
 
20
20
  > **consumerPid**: `string`
21
21
 
@@ -24,7 +24,7 @@ Used for direct lookup by consumerPid.
24
24
 
25
25
  ***
26
26
 
27
- ### id
27
+ ### id {#id}
28
28
 
29
29
  > **id**: `string`
30
30
 
@@ -32,7 +32,7 @@ Internal UUID for storage (secondary key for providerPid lookup).
32
32
 
33
33
  ***
34
34
 
35
- ### providerPid
35
+ ### providerPid {#providerpid}
36
36
 
37
37
  > **providerPid**: `string`
38
38
 
@@ -41,7 +41,7 @@ Indexed for lookup by providerPid.
41
41
 
42
42
  ***
43
43
 
44
- ### agreementId
44
+ ### agreementId {#agreementid}
45
45
 
46
46
  > **agreementId**: `string`
47
47
 
@@ -49,7 +49,7 @@ Agreement ID linking to the rights-management Agreement.
49
49
 
50
50
  ***
51
51
 
52
- ### state
52
+ ### state {#state}
53
53
 
54
54
  > **state**: `DataspaceProtocolTransferProcessStateType`
55
55
 
@@ -58,7 +58,7 @@ One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
58
58
 
59
59
  ***
60
60
 
61
- ### datasetId
61
+ ### datasetId {#datasetid}
62
62
 
63
63
  > **datasetId**: `string`
64
64
 
@@ -66,7 +66,7 @@ Dataset ID for DSC resolution.
66
66
 
67
67
  ***
68
68
 
69
- ### offerId
69
+ ### offerId {#offerid}
70
70
 
71
71
  > **offerId**: `string`
72
72
 
@@ -74,7 +74,7 @@ Offer ID from the original Catalog offer.
74
74
 
75
75
  ***
76
76
 
77
- ### consumerIdentity?
77
+ ### consumerIdentity? {#consumeridentity}
78
78
 
79
79
  > `optional` **consumerIdentity**: `string`
80
80
 
@@ -82,7 +82,7 @@ Consumer identity (DID or URI).
82
82
 
83
83
  ***
84
84
 
85
- ### providerIdentity?
85
+ ### providerIdentity? {#provideridentity}
86
86
 
87
87
  > `optional` **providerIdentity**: `string`
88
88
 
@@ -90,7 +90,7 @@ Provider identity (DID or URI).
90
90
 
91
91
  ***
92
92
 
93
- ### format?
93
+ ### format? {#format}
94
94
 
95
95
  > `optional` **format**: `string`
96
96
 
@@ -98,7 +98,7 @@ Data format from the Dataset Distribution.
98
98
 
99
99
  ***
100
100
 
101
- ### callbackAddress?
101
+ ### callbackAddress? {#callbackaddress}
102
102
 
103
103
  > `optional` **callbackAddress**: `string`
104
104
 
@@ -106,7 +106,7 @@ Callback address for Consumer notifications.
106
106
 
107
107
  ***
108
108
 
109
- ### dateCreated
109
+ ### dateCreated {#datecreated}
110
110
 
111
111
  > **dateCreated**: `string`
112
112
 
@@ -114,7 +114,7 @@ Creation timestamp (ISO string format).
114
114
 
115
115
  ***
116
116
 
117
- ### dateModified
117
+ ### dateModified {#datemodified}
118
118
 
119
119
  > **dateModified**: `string`
120
120
 
@@ -122,7 +122,7 @@ Last update timestamp (ISO string format).
122
122
 
123
123
  ***
124
124
 
125
- ### policies?
125
+ ### policies? {#policies}
126
126
 
127
127
  > `optional` **policies**: `IDataspaceProtocolPolicy`[]
128
128
 
@@ -130,7 +130,7 @@ Policies from the Agreement (stored as JSON).
130
130
 
131
131
  ***
132
132
 
133
- ### dataAddress?
133
+ ### dataAddress? {#dataaddress}
134
134
 
135
135
  > `optional` **dataAddress**: `IDataspaceProtocolDataAddress`
136
136
 
@@ -4,7 +4,7 @@ Activity log dates.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### startDate
7
+ ### startDate {#startdate}
8
8
 
9
9
  > **startDate**: `string`
10
10
 
@@ -12,7 +12,7 @@ Task processing start timestamp
12
12
 
13
13
  ***
14
14
 
15
- ### endDate?
15
+ ### endDate? {#enddate}
16
16
 
17
17
  > `optional` **endDate**: `string`
18
18
 
@@ -8,7 +8,7 @@ The details related to the processing of an Activity
8
8
 
9
9
  ## Properties
10
10
 
11
- ### id
11
+ ### id {#id}
12
12
 
13
13
  > **id**: `string`
14
14
 
@@ -16,7 +16,7 @@ The Id of the Activity Log entry.
16
16
 
17
17
  ***
18
18
 
19
- ### activityId?
19
+ ### activityId? {#activityid}
20
20
 
21
21
  > `optional` **activityId**: `string`
22
22
 
@@ -24,7 +24,7 @@ The activity Id that this entry refers to.
24
24
 
25
25
  ***
26
26
 
27
- ### generator
27
+ ### generator {#generator}
28
28
 
29
29
  > **generator**: `string`
30
30
 
@@ -32,7 +32,7 @@ The identity of the Activity's generator.
32
32
 
33
33
  ***
34
34
 
35
- ### dateCreated
35
+ ### dateCreated {#datecreated}
36
36
 
37
37
  > **dateCreated**: `string`
38
38
 
@@ -40,7 +40,7 @@ The creation date of this object.
40
40
 
41
41
  ***
42
42
 
43
- ### dateModified
43
+ ### dateModified {#datemodified}
44
44
 
45
45
  > **dateModified**: `string`
46
46
 
@@ -48,7 +48,7 @@ The last update date of this object.
48
48
 
49
49
  ***
50
50
 
51
- ### retryCount?
51
+ ### retryCount? {#retrycount}
52
52
 
53
53
  > `optional` **retryCount**: `number`
54
54
 
@@ -8,7 +8,7 @@ The details related to the processing of an Activity
8
8
 
9
9
  ## Properties
10
10
 
11
- ### id
11
+ ### id {#id}
12
12
 
13
13
  > **id**: `string`
14
14
 
@@ -20,7 +20,7 @@ The Id of the Activity Log entry.
20
20
 
21
21
  ***
22
22
 
23
- ### activityId?
23
+ ### activityId? {#activityid}
24
24
 
25
25
  > `optional` **activityId**: `string`
26
26
 
@@ -32,7 +32,7 @@ The activity Id that this entry refers to.
32
32
 
33
33
  ***
34
34
 
35
- ### generator
35
+ ### generator {#generator}
36
36
 
37
37
  > **generator**: `string`
38
38
 
@@ -44,7 +44,7 @@ The identity of the Activity's generator.
44
44
 
45
45
  ***
46
46
 
47
- ### dateCreated
47
+ ### dateCreated {#datecreated}
48
48
 
49
49
  > **dateCreated**: `string`
50
50
 
@@ -56,7 +56,7 @@ The creation date of this object.
56
56
 
57
57
  ***
58
58
 
59
- ### dateModified
59
+ ### dateModified {#datemodified}
60
60
 
61
61
  > **dateModified**: `string`
62
62
 
@@ -68,7 +68,7 @@ The last update date of this object.
68
68
 
69
69
  ***
70
70
 
71
- ### retryCount?
71
+ ### retryCount? {#retrycount}
72
72
 
73
73
  > `optional` **retryCount**: `number`
74
74
 
@@ -80,7 +80,7 @@ Number of times this activity has been retried.
80
80
 
81
81
  ***
82
82
 
83
- ### status
83
+ ### status {#status}
84
84
 
85
85
  > **status**: [`ActivityProcessingStatus`](../type-aliases/ActivityProcessingStatus.md)
86
86
 
@@ -88,7 +88,7 @@ Status of the Activity Processing.
88
88
 
89
89
  ***
90
90
 
91
- ### pendingTasks?
91
+ ### pendingTasks? {#pendingtasks}
92
92
 
93
93
  > `optional` **pendingTasks**: [`ITaskApp`](ITaskApp.md)[]
94
94
 
@@ -96,7 +96,7 @@ The pending tasks that have to be run to process the Activity.
96
96
 
97
97
  ***
98
98
 
99
- ### runningTasks?
99
+ ### runningTasks? {#runningtasks}
100
100
 
101
101
  > `optional` **runningTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
102
102
 
@@ -104,7 +104,7 @@ The running tasks that are processing the Activity.
104
104
 
105
105
  ***
106
106
 
107
- ### finalizedTasks?
107
+ ### finalizedTasks? {#finalizedtasks}
108
108
 
109
109
  > `optional` **finalizedTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
110
110
 
@@ -112,7 +112,7 @@ The tasks that have already finalized.
112
112
 
113
113
  ***
114
114
 
115
- ### inErrorTasks?
115
+ ### inErrorTasks? {#inerrortasks}
116
116
 
117
117
  > `optional` **inErrorTasks**: [`ITaskApp`](ITaskApp.md) & `object`[]
118
118
 
@@ -4,7 +4,7 @@ Get Request for an Activity Log Entry.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
@@ -4,7 +4,7 @@ Service Offering response
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: [`IActivityLogEntry`](IActivityLogEntry.md)
10
10
 
@@ -4,7 +4,7 @@ The status supplied to clients of the Dataspace Data Plane
4
4
 
5
5
  ## Properties
6
6
 
7
- ### activityLogEntryId
7
+ ### activityLogEntryId {#activitylogentryid}
8
8
 
9
9
  > **activityLogEntryId**: `string`
10
10
 
@@ -12,7 +12,7 @@ The activity log entry id.
12
12
 
13
13
  ***
14
14
 
15
- ### activityId?
15
+ ### activityId? {#activityid}
16
16
 
17
17
  > `optional` **activityId**: `string`
18
18
 
@@ -20,7 +20,7 @@ The activity Id.
20
20
 
21
21
  ***
22
22
 
23
- ### taskProcessingStatus
23
+ ### taskProcessingStatus {#taskprocessingstatus}
24
24
 
25
25
  > **taskProcessingStatus**: `object`
26
26
 
@@ -4,7 +4,7 @@ The status supplied to clients of the Dataspace Data Plane
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: [`IActivityLogStatusNotification`](IActivityLogStatusNotification.md)
10
10
 
@@ -4,7 +4,7 @@ Activity log status
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `object`
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Properties
6
6
 
7
- ### activityType?
7
+ ### activityType? {#activitytype}
8
8
 
9
9
  > `optional` **activityType**: `string`
10
10
 
@@ -12,7 +12,7 @@ FQN of the Activity type.
12
12
 
13
13
  ***
14
14
 
15
- ### objectType
15
+ ### objectType {#objecttype}
16
16
 
17
17
  > **objectType**: `string`
18
18
 
@@ -20,7 +20,7 @@ FQN of the Object Type.
20
20
 
21
21
  ***
22
22
 
23
- ### targetType?
23
+ ### targetType? {#targettype}
24
24
 
25
25
  > `optional` **targetType**: `string`
26
26
 
@@ -4,7 +4,7 @@ Activity Stream Notify Request.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `IActivityStreamsActivity`
10
10
 
@@ -4,7 +4,7 @@ Denotes a task associated with an Activity
4
4
 
5
5
  ## Properties
6
6
 
7
- ### activityLogEntryId
7
+ ### activityLogEntryId {#activitylogentryid}
8
8
 
9
9
  > **activityLogEntryId**: `string`
10
10
 
@@ -12,7 +12,7 @@ The activity log entry.
12
12
 
13
13
  ***
14
14
 
15
- ### associatedTasks
15
+ ### associatedTasks {#associatedtasks}
16
16
 
17
17
  > **associatedTasks**: [`ITaskApp`](ITaskApp.md)[]
18
18
 
@@ -4,7 +4,7 @@ API request for completing a transfer process.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
@@ -18,7 +18,7 @@ Process ID (consumerPid).
18
18
 
19
19
  ***
20
20
 
21
- ### headers
21
+ ### headers {#headers}
22
22
 
23
23
  > **headers**: `object`
24
24
 
@@ -30,7 +30,7 @@ Authorization header containing the Base64-encoded trust payload.
30
30
 
31
31
  ***
32
32
 
33
- ### body
33
+ ### body {#body}
34
34
 
35
35
  > **body**: `IDataspaceProtocolTransferCompletionMessage`
36
36
 
@@ -4,7 +4,7 @@ API response for completing a transfer process.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
10
10
 
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with state COMPLETED, or error.
12
12
 
13
13
  ***
14
14
 
15
- ### statusCode?
15
+ ### statusCode? {#statuscode}
16
16
 
17
17
  > `optional` **statusCode**: `HttpStatusCode`
18
18
 
@@ -4,7 +4,7 @@ Data Request type for representing data requests received by Dataspace Apps.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### type
7
+ ### type {#type}
8
8
 
9
9
  > **type**: `"DataAssetEntities"`
10
10
 
@@ -12,7 +12,7 @@ Data Asset Entities type.
12
12
 
13
13
  ***
14
14
 
15
- ### dataAsset
15
+ ### dataAsset {#dataasset}
16
16
 
17
17
  > **dataAsset**: `IDataspaceProtocolDataset`
18
18
 
@@ -20,7 +20,7 @@ The data asset we are referring to.
20
20
 
21
21
  ***
22
22
 
23
- ### entitySet
23
+ ### entitySet {#entityset}
24
24
 
25
25
  > **entitySet**: [`IEntitySet`](IEntitySet.md)
26
26