@digdir/dialogporten-schema 1.72.1-6cf8ebf → 1.72.1-d9104f0

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digdir/dialogporten-schema",
3
- "version": "1.72.1-6cf8ebf",
3
+ "version": "1.72.1-d9104f0",
4
4
  "description": "GraphQl schema and OpenAPI spec for Dialogporten",
5
5
  "engines": {
6
6
  "node": "22"
@@ -37,36 +37,58 @@ type Actor {
37
37
  }
38
38
 
39
39
  type ApiAction {
40
+ "The unique identifier for the action in UUIDv7 format."
40
41
  id: UUID!
42
+ "String identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog."
41
43
  action: String!
44
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
42
45
  authorizationAttribute: String
46
+ "True if the authenticated user is authorized for this action. If not, the action will not be available and all endpoints will be replaced with a fixed placeholder."
43
47
  isAuthorized: Boolean!
48
+ "The logical name of the operation the API action refers to."
44
49
  name: String
50
+ "The endpoints associated with the action."
45
51
  endpoints: [ApiActionEndpoint!]!
46
52
  }
47
53
 
48
54
  type ApiActionEndpoint {
55
+ "The unique identifier for the endpoint in UUIDv7 format."
49
56
  id: UUID!
57
+ "Arbitrary string indicating the version of the endpoint. Consult the service-specific documentation provided by the service owner for details (if in use)."
50
58
  version: String
59
+ "The fully qualified URL of the API endpoint. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
51
60
  url: URL!
61
+ "The HTTP method that the endpoint expects for this action."
52
62
  httpMethod: HttpVerb!
63
+ "Link to service provider documentation for the endpoint. Used for service owners to provide documentation for integrators. Should be a URL to a human-readable page."
53
64
  documentationUrl: URL
65
+ "Link to the request schema for the endpoint. Used by service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
54
66
  requestSchema: URL
67
+ "Link to the response schema for the endpoint. Used for service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
55
68
  responseSchema: URL
69
+ "Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
56
70
  deprecated: Boolean!
71
+ "Date and time when the service owner has indicated that endpoint will no longer function. Only set if the endpoint is deprecated. Dialogporten will not enforce this date."
57
72
  sunsetAt: DateTime
58
73
  }
59
74
 
60
75
  type Attachment {
76
+ "The unique identifier for the attachment in UUIDv7 format."
61
77
  id: UUID!
78
+ "The display name of the attachment that should be used in GUIs."
62
79
  displayName: [Localization!]!
80
+ "The URLs associated with the attachment, each referring to a different representation of the attachment."
63
81
  urls: [AttachmentUrl!]!
64
82
  }
65
83
 
66
84
  type AttachmentUrl {
85
+ "The unique identifier for the attachment URL in UUIDv7 format."
67
86
  id: UUID!
87
+ "The fully qualified URL of the attachment."
68
88
  url: URL!
89
+ "The media type of the attachment."
69
90
  mediaType: String
91
+ "What type of consumer the URL is intended for."
70
92
  consumerType: AttachmentUrlConsumer!
71
93
  }
72
94
 
@@ -118,11 +140,17 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
118
140
  }
119
141
 
120
142
  type Content {
143
+ "The title of the dialog."
121
144
  title: ContentValue!
145
+ "A short summary of the dialog and its current state."
122
146
  summary: ContentValue
147
+ "Overridden sender name. If not supplied, assume 'org' as the sender name."
123
148
  senderName: ContentValue
149
+ "Additional information about the dialog, this may contain Markdown."
124
150
  additionalInfo: ContentValue
151
+ "Used as the human-readable label used to describe the 'ExtendedStatus' field."
125
152
  extendedStatus: ContentValue
153
+ "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
126
154
  mainContentReference: ContentValue
127
155
  }
128
156
 
@@ -132,25 +160,45 @@ type ContentValue {
132
160
  }
133
161
 
134
162
  type Dialog {
163
+ "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
135
164
  id: UUID!
165
+ "The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
136
166
  revision: UUID!
167
+ "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
137
168
  org: String!
169
+ "The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
138
170
  serviceResource: String!
171
+ "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
139
172
  serviceResourceType: String!
173
+ "The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
140
174
  party: String!
175
+ "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
141
176
  progress: Int
177
+ "Optional process identifier used to indicate a business process this dialog belongs to."
142
178
  process: String
179
+ "Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
143
180
  precedingProcess: String
181
+ "Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
144
182
  extendedStatus: String
183
+ "Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
145
184
  externalReference: String
185
+ "The date and time when the dialog becomes visible to the end user."
146
186
  visibleFrom: DateTime
187
+ "The due date for the dialog. Dialogs past due date might be marked as such in frontends but will still be available. Example: 2022-12-31T23:59:59Z"
147
188
  dueAt: DateTime
189
+ "The expiration date for the dialog. This is the last date when the dialog is available for the end user. After this date is passed, the dialog will be considered expired and no longer available for the end user in any API. If not supplied, the dialog will be considered to never expire. This field can be changed by the service owner after the dialog has been created. Example: 2022-12-31T23:59:59Z"
148
190
  expiresAt: DateTime
191
+ "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
149
192
  createdAt: DateTime!
193
+ "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
150
194
  updatedAt: DateTime!
195
+ "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
151
196
  contentUpdatedAt: DateTime!
197
+ "The dialog token. May be used (if supported) against external URLs referred to in this dialog's apiActions, transmissions or attachments. It should also be used for front-channel embeds."
152
198
  dialogToken: String
199
+ "The aggregated status of the dialog."
153
200
  status: DialogStatus!
201
+ "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
154
202
  hasUnopenedContent: Boolean!
155
203
  "The number of transmissions sent by the service owner"
156
204
  fromServiceOwnerTransmissionsCount: Int!
@@ -158,14 +206,23 @@ type Dialog {
158
206
  fromPartyTransmissionsCount: Int!
159
207
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
160
208
  isApiOnly: Boolean!
209
+ "The dialog unstructured text content."
161
210
  content: Content!
211
+ "The attachments associated with the dialog (on an aggregate level)."
162
212
  attachments: [Attachment!]!
213
+ "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
163
214
  guiActions: [GuiAction!]!
215
+ "The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
164
216
  apiActions: [ApiAction!]!
217
+ "An immutable list of activities associated with the dialog."
165
218
  activities: [Activity!]!
219
+ "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
166
220
  seenSinceLastUpdate: [SeenLog!]!
221
+ "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
167
222
  seenSinceLastContentUpdate: [SeenLog!]!
223
+ "The immutable list of transmissions associated with the dialog."
168
224
  transmissions: [Transmission!]!
225
+ "Metadata about the dialog owned by end-users."
169
226
  endUserContext: EndUserContext!
170
227
  }
171
228
 
@@ -201,15 +258,25 @@ type EndUserContext {
201
258
  }
202
259
 
203
260
  type GuiAction {
261
+ "The unique identifier for the action in UUIDv7 format."
204
262
  id: UUID!
263
+ "The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
205
264
  action: String!
265
+ "The fully qualified URL of the action, to which the user will be redirected when the action is triggered. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
206
266
  url: URL!
267
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
207
268
  authorizationAttribute: String
269
+ "Whether the user is authorized to perform the action."
208
270
  isAuthorized: Boolean!
271
+ "Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
209
272
  isDeleteDialogAction: Boolean!
273
+ "Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
210
274
  priority: GuiActionPriority!
275
+ "The HTTP method that the frontend should use when redirecting the user."
211
276
  httpMethod: HttpVerb!
277
+ "The title of the action, this should be short and in verb form."
212
278
  title: [Localization!]!
279
+ "If there should be a prompt asking the user for confirmation before the action is executed, this field should contain the prompt text."
213
280
  prompt: [Localization!]
214
281
  }
215
282
 
@@ -230,29 +297,50 @@ type Queries @authorize(policy: "enduser") {
230
297
  }
231
298
 
232
299
  type SearchContent {
300
+ "The title of the dialog."
233
301
  title: ContentValue!
302
+ "A short summary of the dialog and its current state."
234
303
  summary: ContentValue
304
+ "Overridden sender name. If not supplied, assume 'org' as the sender name."
235
305
  senderName: ContentValue
306
+ "Used as the human-readable label used to describe the 'ExtendedStatus' field."
236
307
  extendedStatus: ContentValue
237
308
  }
238
309
 
239
310
  type SearchDialog {
311
+ "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
240
312
  id: UUID!
313
+ "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
241
314
  org: String!
315
+ "The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
242
316
  serviceResource: String!
317
+ "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
243
318
  serviceResourceType: String!
319
+ "The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
244
320
  party: String!
321
+ "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
245
322
  progress: Int
323
+ "Optional process identifier used to indicate a business process this dialog belongs to."
246
324
  process: String
325
+ "Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
247
326
  precedingProcess: String
327
+ "The number of attachments in the dialog made available for browser-based frontends."
248
328
  guiAttachmentCount: Int
329
+ "Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
249
330
  extendedStatus: String
331
+ "Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
250
332
  externalReference: String
333
+ "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
251
334
  createdAt: DateTime!
335
+ "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
252
336
  updatedAt: DateTime!
337
+ "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
253
338
  contentUpdatedAt: DateTime!
339
+ "The due date for the dialog. This is the last date when the dialog is expected to be completed. Example: 2022-12-31T23:59:59Z"
254
340
  dueAt: DateTime
341
+ "The aggregated status of the dialog."
255
342
  status: DialogStatus!
343
+ "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
256
344
  hasUnopenedContent: Boolean!
257
345
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
258
346
  isApiOnly: Boolean!
@@ -260,10 +348,15 @@ type SearchDialog {
260
348
  fromServiceOwnerTransmissionsCount: Int!
261
349
  "The number of transmissions sent by a party representative"
262
350
  fromPartyTransmissionsCount: Int!
351
+ "The latest entry in the dialog's activity log."
263
352
  latestActivity: Activity
353
+ "The content of the dialog in search results."
264
354
  content: SearchContent!
355
+ "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
265
356
  seenSinceLastUpdate: [SeenLog!]!
357
+ "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
266
358
  seenSinceLastContentUpdate: [SeenLog!]!
359
+ "Metadata about the dialog owned by end-users."
267
360
  endUserContext: EndUserContext!
268
361
  }
269
362
 
@@ -322,21 +415,34 @@ type Subscriptions {
322
415
  }
323
416
 
324
417
  type Transmission {
418
+ "The unique identifier for the transmission in UUIDv7 format."
325
419
  id: UUID!
420
+ "The date and time when the transmission was created."
326
421
  createdAt: DateTime!
422
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies. Example: mycustomresource, urn:altinn:subresource:mycustomresource, urn:altinn:task:Task_1, urn:altinn:resource:some-other-service-identifier"
327
423
  authorizationAttribute: String
424
+ "Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and the attachments will not be available."
328
425
  isAuthorized: Boolean!
426
+ "Arbitrary URI\/URN describing a service-specific transmission type. Refer to the service-specific documentation provided by the service owner for details (if in use)."
329
427
  extendedType: URL
428
+ "Reference to any other transmission that this transmission is related to."
330
429
  relatedTransmissionId: UUID
430
+ "The type of transmission."
331
431
  type: TransmissionType!
432
+ "The actor that sent the transmission."
332
433
  sender: Actor!
434
+ "The transmission unstructured text content."
333
435
  content: TransmissionContent!
436
+ "The transmission-level attachments."
334
437
  attachments: [Attachment!]!
335
438
  }
336
439
 
337
440
  type TransmissionContent {
441
+ "The transmission title."
338
442
  title: ContentValue!
443
+ "The transmission summary."
339
444
  summary: ContentValue
445
+ "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
340
446
  contentReference: ContentValue
341
447
  }
342
448
 
package/src/index.js CHANGED
@@ -37,36 +37,58 @@ type Actor {
37
37
  }
38
38
 
39
39
  type ApiAction {
40
+ "The unique identifier for the action in UUIDv7 format."
40
41
  id: UUID!
42
+ "String identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog."
41
43
  action: String!
44
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
42
45
  authorizationAttribute: String
46
+ "True if the authenticated user is authorized for this action. If not, the action will not be available and all endpoints will be replaced with a fixed placeholder."
43
47
  isAuthorized: Boolean!
48
+ "The logical name of the operation the API action refers to."
44
49
  name: String
50
+ "The endpoints associated with the action."
45
51
  endpoints: [ApiActionEndpoint!]!
46
52
  }
47
53
 
48
54
  type ApiActionEndpoint {
55
+ "The unique identifier for the endpoint in UUIDv7 format."
49
56
  id: UUID!
57
+ "Arbitrary string indicating the version of the endpoint. Consult the service-specific documentation provided by the service owner for details (if in use)."
50
58
  version: String
59
+ "The fully qualified URL of the API endpoint. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
51
60
  url: URL!
61
+ "The HTTP method that the endpoint expects for this action."
52
62
  httpMethod: HttpVerb!
63
+ "Link to service provider documentation for the endpoint. Used for service owners to provide documentation for integrators. Should be a URL to a human-readable page."
53
64
  documentationUrl: URL
65
+ "Link to the request schema for the endpoint. Used by service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
54
66
  requestSchema: URL
67
+ "Link to the response schema for the endpoint. Used for service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
55
68
  responseSchema: URL
69
+ "Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
56
70
  deprecated: Boolean!
71
+ "Date and time when the service owner has indicated that endpoint will no longer function. Only set if the endpoint is deprecated. Dialogporten will not enforce this date."
57
72
  sunsetAt: DateTime
58
73
  }
59
74
 
60
75
  type Attachment {
76
+ "The unique identifier for the attachment in UUIDv7 format."
61
77
  id: UUID!
78
+ "The display name of the attachment that should be used in GUIs."
62
79
  displayName: [Localization!]!
80
+ "The URLs associated with the attachment, each referring to a different representation of the attachment."
63
81
  urls: [AttachmentUrl!]!
64
82
  }
65
83
 
66
84
  type AttachmentUrl {
85
+ "The unique identifier for the attachment URL in UUIDv7 format."
67
86
  id: UUID!
87
+ "The fully qualified URL of the attachment."
68
88
  url: URL!
89
+ "The media type of the attachment."
69
90
  mediaType: String
91
+ "What type of consumer the URL is intended for."
70
92
  consumerType: AttachmentUrlConsumer!
71
93
  }
72
94
 
@@ -118,11 +140,17 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
118
140
  }
119
141
 
120
142
  type Content {
143
+ "The title of the dialog."
121
144
  title: ContentValue!
145
+ "A short summary of the dialog and its current state."
122
146
  summary: ContentValue
147
+ "Overridden sender name. If not supplied, assume 'org' as the sender name."
123
148
  senderName: ContentValue
149
+ "Additional information about the dialog, this may contain Markdown."
124
150
  additionalInfo: ContentValue
151
+ "Used as the human-readable label used to describe the 'ExtendedStatus' field."
125
152
  extendedStatus: ContentValue
153
+ "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
126
154
  mainContentReference: ContentValue
127
155
  }
128
156
 
@@ -132,25 +160,45 @@ type ContentValue {
132
160
  }
133
161
 
134
162
  type Dialog {
163
+ "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
135
164
  id: UUID!
165
+ "The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
136
166
  revision: UUID!
167
+ "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
137
168
  org: String!
169
+ "The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
138
170
  serviceResource: String!
171
+ "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
139
172
  serviceResourceType: String!
173
+ "The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
140
174
  party: String!
175
+ "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
141
176
  progress: Int
177
+ "Optional process identifier used to indicate a business process this dialog belongs to."
142
178
  process: String
179
+ "Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
143
180
  precedingProcess: String
181
+ "Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
144
182
  extendedStatus: String
183
+ "Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
145
184
  externalReference: String
185
+ "The date and time when the dialog becomes visible to the end user."
146
186
  visibleFrom: DateTime
187
+ "The due date for the dialog. Dialogs past due date might be marked as such in frontends but will still be available. Example: 2022-12-31T23:59:59Z"
147
188
  dueAt: DateTime
189
+ "The expiration date for the dialog. This is the last date when the dialog is available for the end user. After this date is passed, the dialog will be considered expired and no longer available for the end user in any API. If not supplied, the dialog will be considered to never expire. This field can be changed by the service owner after the dialog has been created. Example: 2022-12-31T23:59:59Z"
148
190
  expiresAt: DateTime
191
+ "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
149
192
  createdAt: DateTime!
193
+ "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
150
194
  updatedAt: DateTime!
195
+ "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
151
196
  contentUpdatedAt: DateTime!
197
+ "The dialog token. May be used (if supported) against external URLs referred to in this dialog's apiActions, transmissions or attachments. It should also be used for front-channel embeds."
152
198
  dialogToken: String
199
+ "The aggregated status of the dialog."
153
200
  status: DialogStatus!
201
+ "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
154
202
  hasUnopenedContent: Boolean!
155
203
  "The number of transmissions sent by the service owner"
156
204
  fromServiceOwnerTransmissionsCount: Int!
@@ -158,14 +206,23 @@ type Dialog {
158
206
  fromPartyTransmissionsCount: Int!
159
207
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
160
208
  isApiOnly: Boolean!
209
+ "The dialog unstructured text content."
161
210
  content: Content!
211
+ "The attachments associated with the dialog (on an aggregate level)."
162
212
  attachments: [Attachment!]!
213
+ "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
163
214
  guiActions: [GuiAction!]!
215
+ "The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
164
216
  apiActions: [ApiAction!]!
217
+ "An immutable list of activities associated with the dialog."
165
218
  activities: [Activity!]!
219
+ "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
166
220
  seenSinceLastUpdate: [SeenLog!]!
221
+ "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
167
222
  seenSinceLastContentUpdate: [SeenLog!]!
223
+ "The immutable list of transmissions associated with the dialog."
168
224
  transmissions: [Transmission!]!
225
+ "Metadata about the dialog owned by end-users."
169
226
  endUserContext: EndUserContext!
170
227
  }
171
228
 
@@ -201,15 +258,25 @@ type EndUserContext {
201
258
  }
202
259
 
203
260
  type GuiAction {
261
+ "The unique identifier for the action in UUIDv7 format."
204
262
  id: UUID!
263
+ "The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
205
264
  action: String!
265
+ "The fully qualified URL of the action, to which the user will be redirected when the action is triggered. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
206
266
  url: URL!
267
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
207
268
  authorizationAttribute: String
269
+ "Whether the user is authorized to perform the action."
208
270
  isAuthorized: Boolean!
271
+ "Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
209
272
  isDeleteDialogAction: Boolean!
273
+ "Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
210
274
  priority: GuiActionPriority!
275
+ "The HTTP method that the frontend should use when redirecting the user."
211
276
  httpMethod: HttpVerb!
277
+ "The title of the action, this should be short and in verb form."
212
278
  title: [Localization!]!
279
+ "If there should be a prompt asking the user for confirmation before the action is executed, this field should contain the prompt text."
213
280
  prompt: [Localization!]
214
281
  }
215
282
 
@@ -230,29 +297,50 @@ type Queries @authorize(policy: "enduser") {
230
297
  }
231
298
 
232
299
  type SearchContent {
300
+ "The title of the dialog."
233
301
  title: ContentValue!
302
+ "A short summary of the dialog and its current state."
234
303
  summary: ContentValue
304
+ "Overridden sender name. If not supplied, assume 'org' as the sender name."
235
305
  senderName: ContentValue
306
+ "Used as the human-readable label used to describe the 'ExtendedStatus' field."
236
307
  extendedStatus: ContentValue
237
308
  }
238
309
 
239
310
  type SearchDialog {
311
+ "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
240
312
  id: UUID!
313
+ "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
241
314
  org: String!
315
+ "The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
242
316
  serviceResource: String!
317
+ "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
243
318
  serviceResourceType: String!
319
+ "The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
244
320
  party: String!
321
+ "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
245
322
  progress: Int
323
+ "Optional process identifier used to indicate a business process this dialog belongs to."
246
324
  process: String
325
+ "Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
247
326
  precedingProcess: String
327
+ "The number of attachments in the dialog made available for browser-based frontends."
248
328
  guiAttachmentCount: Int
329
+ "Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
249
330
  extendedStatus: String
331
+ "Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
250
332
  externalReference: String
333
+ "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
251
334
  createdAt: DateTime!
335
+ "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
252
336
  updatedAt: DateTime!
337
+ "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
253
338
  contentUpdatedAt: DateTime!
339
+ "The due date for the dialog. This is the last date when the dialog is expected to be completed. Example: 2022-12-31T23:59:59Z"
254
340
  dueAt: DateTime
341
+ "The aggregated status of the dialog."
255
342
  status: DialogStatus!
343
+ "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
256
344
  hasUnopenedContent: Boolean!
257
345
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
258
346
  isApiOnly: Boolean!
@@ -260,10 +348,15 @@ type SearchDialog {
260
348
  fromServiceOwnerTransmissionsCount: Int!
261
349
  "The number of transmissions sent by a party representative"
262
350
  fromPartyTransmissionsCount: Int!
351
+ "The latest entry in the dialog's activity log."
263
352
  latestActivity: Activity
353
+ "The content of the dialog in search results."
264
354
  content: SearchContent!
355
+ "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
265
356
  seenSinceLastUpdate: [SeenLog!]!
357
+ "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
266
358
  seenSinceLastContentUpdate: [SeenLog!]!
359
+ "Metadata about the dialog owned by end-users."
267
360
  endUserContext: EndUserContext!
268
361
  }
269
362
 
@@ -322,21 +415,34 @@ type Subscriptions {
322
415
  }
323
416
 
324
417
  type Transmission {
418
+ "The unique identifier for the transmission in UUIDv7 format."
325
419
  id: UUID!
420
+ "The date and time when the transmission was created."
326
421
  createdAt: DateTime!
422
+ "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies. Example: mycustomresource, urn:altinn:subresource:mycustomresource, urn:altinn:task:Task_1, urn:altinn:resource:some-other-service-identifier"
327
423
  authorizationAttribute: String
424
+ "Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and the attachments will not be available."
328
425
  isAuthorized: Boolean!
426
+ "Arbitrary URI\/URN describing a service-specific transmission type. Refer to the service-specific documentation provided by the service owner for details (if in use)."
329
427
  extendedType: URL
428
+ "Reference to any other transmission that this transmission is related to."
330
429
  relatedTransmissionId: UUID
430
+ "The type of transmission."
331
431
  type: TransmissionType!
432
+ "The actor that sent the transmission."
332
433
  sender: Actor!
434
+ "The transmission unstructured text content."
333
435
  content: TransmissionContent!
436
+ "The transmission-level attachments."
334
437
  attachments: [Attachment!]!
335
438
  }
336
439
 
337
440
  type TransmissionContent {
441
+ "The transmission title."
338
442
  title: ContentValue!
443
+ "The transmission summary."
339
444
  summary: ContentValue
445
+ "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
340
446
  contentReference: ContentValue
341
447
  }
342
448
 
@@ -619,12 +619,12 @@
619
619
  "type": "string"
620
620
  },
621
621
  "fromPartyTransmissionsCount": {
622
- "description": "The number of transmissions sent by a party representative ",
622
+ "description": "The number of transmissions sent by a party representative",
623
623
  "format": "int32",
624
624
  "type": "integer"
625
625
  },
626
626
  "fromServiceOwnerTransmissionsCount": {
627
- "description": "The number of transmissions sent by a service owner ",
627
+ "description": "The number of transmissions sent by a service owner",
628
628
  "format": "int32",
629
629
  "type": "integer"
630
630
  },
@@ -1118,7 +1118,6 @@
1118
1118
  },
1119
1119
  "isOpened": {
1120
1120
  "description": "Indicates whether the dialog transmission has been opened.",
1121
- "nullable": true,
1122
1121
  "type": "boolean"
1123
1122
  },
1124
1123
  "relatedTransmissionId": {
@@ -4351,7 +4350,6 @@
4351
4350
  },
4352
4351
  "isOpened": {
4353
4352
  "description": "Indicates whether the dialog transmission has been opened.",
4354
- "nullable": true,
4355
4353
  "type": "boolean"
4356
4354
  },
4357
4355
  "relatedTransmissionId": {
@@ -8560,4 +8558,4 @@
8560
8558
  }
8561
8559
  }
8562
8560
  }
8563
- }
8561
+ }