@digdir/dialogporten-schema 1.72.1-a4eba28 → 1.72.1-fea0aee

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-a4eba28",
3
+ "version": "1.72.1-fea0aee",
4
4
  "description": "GraphQl schema and OpenAPI spec for Dialogporten",
5
5
  "engines": {
6
6
  "node": "22"
@@ -37,58 +37,36 @@ type Actor {
37
37
  }
38
38
 
39
39
  type ApiAction {
40
- "The unique identifier for the action in UUIDv7 format."
41
40
  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."
43
41
  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."
45
42
  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."
47
43
  isAuthorized: Boolean!
48
- "The logical name of the operation the API action refers to."
49
44
  name: String
50
- "The endpoints associated with the action."
51
45
  endpoints: [ApiActionEndpoint!]!
52
46
  }
53
47
 
54
48
  type ApiActionEndpoint {
55
- "The unique identifier for the endpoint in UUIDv7 format."
56
49
  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)."
58
50
  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."
60
51
  url: URL!
61
- "The HTTP method that the endpoint expects for this action."
62
52
  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."
64
53
  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."
66
54
  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."
68
55
  responseSchema: URL
69
- "Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
70
56
  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."
72
57
  sunsetAt: DateTime
73
58
  }
74
59
 
75
60
  type Attachment {
76
- "The unique identifier for the attachment in UUIDv7 format."
77
61
  id: UUID!
78
- "The display name of the attachment that should be used in GUIs."
79
62
  displayName: [Localization!]!
80
- "The URLs associated with the attachment, each referring to a different representation of the attachment."
81
63
  urls: [AttachmentUrl!]!
82
64
  }
83
65
 
84
66
  type AttachmentUrl {
85
- "The unique identifier for the attachment URL in UUIDv7 format."
86
67
  id: UUID!
87
- "The fully qualified URL of the attachment."
88
68
  url: URL!
89
- "The media type of the attachment."
90
69
  mediaType: String
91
- "What type of consumer the URL is intended for."
92
70
  consumerType: AttachmentUrlConsumer!
93
71
  }
94
72
 
@@ -140,17 +118,11 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
140
118
  }
141
119
 
142
120
  type Content {
143
- "The title of the dialog."
144
121
  title: ContentValue!
145
- "A short summary of the dialog and its current state."
146
122
  summary: ContentValue
147
- "Overridden sender name. If not supplied, assume 'org' as the sender name."
148
123
  senderName: ContentValue
149
- "Additional information about the dialog, this may contain Markdown."
150
124
  additionalInfo: ContentValue
151
- "Used as the human-readable label used to describe the 'ExtendedStatus' field."
152
125
  extendedStatus: ContentValue
153
- "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
154
126
  mainContentReference: ContentValue
155
127
  }
156
128
 
@@ -160,69 +132,36 @@ type ContentValue {
160
132
  }
161
133
 
162
134
  type Dialog {
163
- "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
164
135
  id: UUID!
165
- "The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
166
136
  revision: UUID!
167
- "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
168
137
  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"
170
138
  serviceResource: String!
171
- "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
172
139
  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"
174
140
  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)."
176
141
  progress: Int
177
- "Optional process identifier used to indicate a business process this dialog belongs to."
178
142
  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."
180
143
  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)."
182
144
  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)."
184
145
  externalReference: String
185
- "The date and time when the dialog becomes visible to the end user."
186
146
  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"
188
147
  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"
190
148
  expiresAt: DateTime
191
- "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
192
149
  createdAt: DateTime!
193
- "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
194
150
  updatedAt: DateTime!
195
- "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
196
151
  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."
198
152
  dialogToken: String
199
- "The aggregated status of the dialog."
200
153
  status: DialogStatus!
201
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
202
154
  hasUnopenedContent: Boolean!
203
- "The number of transmissions sent by the service owner"
204
- fromServiceOwnerTransmissionsCount: Int!
205
- "The number of transmissions sent by a party representative"
206
- fromPartyTransmissionsCount: Int!
207
155
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
208
156
  isApiOnly: Boolean!
209
- "The dialog unstructured text content."
210
157
  content: Content!
211
- "The attachments associated with the dialog (on an aggregate level)."
212
158
  attachments: [Attachment!]!
213
- "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
214
159
  guiActions: [GuiAction!]!
215
- "The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
216
160
  apiActions: [ApiAction!]!
217
- "An immutable list of activities associated with the dialog."
218
161
  activities: [Activity!]!
219
- "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
220
162
  seenSinceLastUpdate: [SeenLog!]!
221
- "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
222
163
  seenSinceLastContentUpdate: [SeenLog!]!
223
- "The immutable list of transmissions associated with the dialog."
224
164
  transmissions: [Transmission!]!
225
- "Metadata about the dialog owned by end-users."
226
165
  endUserContext: EndUserContext!
227
166
  }
228
167
 
@@ -258,25 +197,15 @@ type EndUserContext {
258
197
  }
259
198
 
260
199
  type GuiAction {
261
- "The unique identifier for the action in UUIDv7 format."
262
200
  id: UUID!
263
- "The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
264
201
  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."
266
202
  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."
268
203
  authorizationAttribute: String
269
- "Whether the user is authorized to perform the action."
270
204
  isAuthorized: Boolean!
271
- "Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
272
205
  isDeleteDialogAction: Boolean!
273
- "Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
274
206
  priority: GuiActionPriority!
275
- "The HTTP method that the frontend should use when redirecting the user."
276
207
  httpMethod: HttpVerb!
277
- "The title of the action, this should be short and in verb form."
278
208
  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."
280
209
  prompt: [Localization!]
281
210
  }
282
211
 
@@ -297,66 +226,35 @@ type Queries @authorize(policy: "enduser") {
297
226
  }
298
227
 
299
228
  type SearchContent {
300
- "The title of the dialog."
301
229
  title: ContentValue!
302
- "A short summary of the dialog and its current state."
303
230
  summary: ContentValue
304
- "Overridden sender name. If not supplied, assume 'org' as the sender name."
305
231
  senderName: ContentValue
306
- "Used as the human-readable label used to describe the 'ExtendedStatus' field."
307
232
  extendedStatus: ContentValue
308
233
  }
309
234
 
310
235
  type SearchDialog {
311
- "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
312
236
  id: UUID!
313
- "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
314
237
  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"
316
238
  serviceResource: String!
317
- "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
318
239
  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"
320
240
  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)."
322
241
  progress: Int
323
- "Optional process identifier used to indicate a business process this dialog belongs to."
324
242
  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."
326
243
  precedingProcess: String
327
- "The number of attachments in the dialog made available for browser-based frontends."
328
244
  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)."
330
245
  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)."
332
- externalReference: String
333
- "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
334
246
  createdAt: DateTime!
335
- "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
336
247
  updatedAt: DateTime!
337
- "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
338
248
  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"
340
249
  dueAt: DateTime
341
- "The aggregated status of the dialog."
342
250
  status: DialogStatus!
343
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
344
251
  hasUnopenedContent: Boolean!
345
252
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
346
253
  isApiOnly: Boolean!
347
- "The number of transmissions sent by the service owner"
348
- fromServiceOwnerTransmissionsCount: Int!
349
- "The number of transmissions sent by a party representative"
350
- fromPartyTransmissionsCount: Int!
351
- "The latest entry in the dialog's activity log."
352
254
  latestActivity: Activity
353
- "The content of the dialog in search results."
354
255
  content: SearchContent!
355
- "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
356
256
  seenSinceLastUpdate: [SeenLog!]!
357
- "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
358
257
  seenSinceLastContentUpdate: [SeenLog!]!
359
- "Metadata about the dialog owned by end-users."
360
258
  endUserContext: EndUserContext!
361
259
  }
362
260
 
@@ -415,34 +313,21 @@ type Subscriptions {
415
313
  }
416
314
 
417
315
  type Transmission {
418
- "The unique identifier for the transmission in UUIDv7 format."
419
316
  id: UUID!
420
- "The date and time when the transmission was created."
421
317
  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"
423
318
  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."
425
319
  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)."
427
320
  extendedType: URL
428
- "Reference to any other transmission that this transmission is related to."
429
321
  relatedTransmissionId: UUID
430
- "The type of transmission."
431
322
  type: TransmissionType!
432
- "The actor that sent the transmission."
433
323
  sender: Actor!
434
- "The transmission unstructured text content."
435
324
  content: TransmissionContent!
436
- "The transmission-level attachments."
437
325
  attachments: [Attachment!]!
438
326
  }
439
327
 
440
328
  type TransmissionContent {
441
- "The transmission title."
442
329
  title: ContentValue!
443
- "The transmission summary."
444
330
  summary: ContentValue
445
- "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
446
331
  contentReference: ContentValue
447
332
  }
448
333
 
@@ -646,4 +531,4 @@ scalar DateTime @specifiedBy(url: "https:\/\/www.graphql-scalars.com\/date-time"
646
531
 
647
532
  scalar URL @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc3986")
648
533
 
649
- scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
534
+ scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
package/src/index.js CHANGED
@@ -37,58 +37,36 @@ type Actor {
37
37
  }
38
38
 
39
39
  type ApiAction {
40
- "The unique identifier for the action in UUIDv7 format."
41
40
  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."
43
41
  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."
45
42
  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."
47
43
  isAuthorized: Boolean!
48
- "The logical name of the operation the API action refers to."
49
44
  name: String
50
- "The endpoints associated with the action."
51
45
  endpoints: [ApiActionEndpoint!]!
52
46
  }
53
47
 
54
48
  type ApiActionEndpoint {
55
- "The unique identifier for the endpoint in UUIDv7 format."
56
49
  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)."
58
50
  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."
60
51
  url: URL!
61
- "The HTTP method that the endpoint expects for this action."
62
52
  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."
64
53
  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."
66
54
  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."
68
55
  responseSchema: URL
69
- "Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
70
56
  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."
72
57
  sunsetAt: DateTime
73
58
  }
74
59
 
75
60
  type Attachment {
76
- "The unique identifier for the attachment in UUIDv7 format."
77
61
  id: UUID!
78
- "The display name of the attachment that should be used in GUIs."
79
62
  displayName: [Localization!]!
80
- "The URLs associated with the attachment, each referring to a different representation of the attachment."
81
63
  urls: [AttachmentUrl!]!
82
64
  }
83
65
 
84
66
  type AttachmentUrl {
85
- "The unique identifier for the attachment URL in UUIDv7 format."
86
67
  id: UUID!
87
- "The fully qualified URL of the attachment."
88
68
  url: URL!
89
- "The media type of the attachment."
90
69
  mediaType: String
91
- "What type of consumer the URL is intended for."
92
70
  consumerType: AttachmentUrlConsumer!
93
71
  }
94
72
 
@@ -140,17 +118,11 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
140
118
  }
141
119
 
142
120
  type Content {
143
- "The title of the dialog."
144
121
  title: ContentValue!
145
- "A short summary of the dialog and its current state."
146
122
  summary: ContentValue
147
- "Overridden sender name. If not supplied, assume 'org' as the sender name."
148
123
  senderName: ContentValue
149
- "Additional information about the dialog, this may contain Markdown."
150
124
  additionalInfo: ContentValue
151
- "Used as the human-readable label used to describe the 'ExtendedStatus' field."
152
125
  extendedStatus: ContentValue
153
- "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
154
126
  mainContentReference: ContentValue
155
127
  }
156
128
 
@@ -160,69 +132,36 @@ type ContentValue {
160
132
  }
161
133
 
162
134
  type Dialog {
163
- "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
164
135
  id: UUID!
165
- "The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
166
136
  revision: UUID!
167
- "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
168
137
  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"
170
138
  serviceResource: String!
171
- "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
172
139
  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"
174
140
  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)."
176
141
  progress: Int
177
- "Optional process identifier used to indicate a business process this dialog belongs to."
178
142
  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."
180
143
  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)."
182
144
  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)."
184
145
  externalReference: String
185
- "The date and time when the dialog becomes visible to the end user."
186
146
  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"
188
147
  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"
190
148
  expiresAt: DateTime
191
- "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
192
149
  createdAt: DateTime!
193
- "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
194
150
  updatedAt: DateTime!
195
- "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
196
151
  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."
198
152
  dialogToken: String
199
- "The aggregated status of the dialog."
200
153
  status: DialogStatus!
201
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
202
154
  hasUnopenedContent: Boolean!
203
- "The number of transmissions sent by the service owner"
204
- fromServiceOwnerTransmissionsCount: Int!
205
- "The number of transmissions sent by a party representative"
206
- fromPartyTransmissionsCount: Int!
207
155
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
208
156
  isApiOnly: Boolean!
209
- "The dialog unstructured text content."
210
157
  content: Content!
211
- "The attachments associated with the dialog (on an aggregate level)."
212
158
  attachments: [Attachment!]!
213
- "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
214
159
  guiActions: [GuiAction!]!
215
- "The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
216
160
  apiActions: [ApiAction!]!
217
- "An immutable list of activities associated with the dialog."
218
161
  activities: [Activity!]!
219
- "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
220
162
  seenSinceLastUpdate: [SeenLog!]!
221
- "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
222
163
  seenSinceLastContentUpdate: [SeenLog!]!
223
- "The immutable list of transmissions associated with the dialog."
224
164
  transmissions: [Transmission!]!
225
- "Metadata about the dialog owned by end-users."
226
165
  endUserContext: EndUserContext!
227
166
  }
228
167
 
@@ -258,25 +197,15 @@ type EndUserContext {
258
197
  }
259
198
 
260
199
  type GuiAction {
261
- "The unique identifier for the action in UUIDv7 format."
262
200
  id: UUID!
263
- "The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
264
201
  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."
266
202
  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."
268
203
  authorizationAttribute: String
269
- "Whether the user is authorized to perform the action."
270
204
  isAuthorized: Boolean!
271
- "Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
272
205
  isDeleteDialogAction: Boolean!
273
- "Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
274
206
  priority: GuiActionPriority!
275
- "The HTTP method that the frontend should use when redirecting the user."
276
207
  httpMethod: HttpVerb!
277
- "The title of the action, this should be short and in verb form."
278
208
  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."
280
209
  prompt: [Localization!]
281
210
  }
282
211
 
@@ -297,66 +226,35 @@ type Queries @authorize(policy: "enduser") {
297
226
  }
298
227
 
299
228
  type SearchContent {
300
- "The title of the dialog."
301
229
  title: ContentValue!
302
- "A short summary of the dialog and its current state."
303
230
  summary: ContentValue
304
- "Overridden sender name. If not supplied, assume 'org' as the sender name."
305
231
  senderName: ContentValue
306
- "Used as the human-readable label used to describe the 'ExtendedStatus' field."
307
232
  extendedStatus: ContentValue
308
233
  }
309
234
 
310
235
  type SearchDialog {
311
- "The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
312
236
  id: UUID!
313
- "The service owner code representing the organization (service owner) related to this dialog. Example: ske"
314
237
  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"
316
238
  serviceResource: String!
317
- "The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
318
239
  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"
320
240
  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)."
322
241
  progress: Int
323
- "Optional process identifier used to indicate a business process this dialog belongs to."
324
242
  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."
326
243
  precedingProcess: String
327
- "The number of attachments in the dialog made available for browser-based frontends."
328
244
  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)."
330
245
  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)."
332
- externalReference: String
333
- "The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
334
246
  createdAt: DateTime!
335
- "The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
336
247
  updatedAt: DateTime!
337
- "The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
338
248
  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"
340
249
  dueAt: DateTime
341
- "The aggregated status of the dialog."
342
250
  status: DialogStatus!
343
- "Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
344
251
  hasUnopenedContent: Boolean!
345
252
  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
346
253
  isApiOnly: Boolean!
347
- "The number of transmissions sent by the service owner"
348
- fromServiceOwnerTransmissionsCount: Int!
349
- "The number of transmissions sent by a party representative"
350
- fromPartyTransmissionsCount: Int!
351
- "The latest entry in the dialog's activity log."
352
254
  latestActivity: Activity
353
- "The content of the dialog in search results."
354
255
  content: SearchContent!
355
- "The list of seen log entries for the dialog newer than the dialog ChangedAt date."
356
256
  seenSinceLastUpdate: [SeenLog!]!
357
- "The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
358
257
  seenSinceLastContentUpdate: [SeenLog!]!
359
- "Metadata about the dialog owned by end-users."
360
258
  endUserContext: EndUserContext!
361
259
  }
362
260
 
@@ -415,34 +313,21 @@ type Subscriptions {
415
313
  }
416
314
 
417
315
  type Transmission {
418
- "The unique identifier for the transmission in UUIDv7 format."
419
316
  id: UUID!
420
- "The date and time when the transmission was created."
421
317
  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"
423
318
  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."
425
319
  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)."
427
320
  extendedType: URL
428
- "Reference to any other transmission that this transmission is related to."
429
321
  relatedTransmissionId: UUID
430
- "The type of transmission."
431
322
  type: TransmissionType!
432
- "The actor that sent the transmission."
433
323
  sender: Actor!
434
- "The transmission unstructured text content."
435
324
  content: TransmissionContent!
436
- "The transmission-level attachments."
437
325
  attachments: [Attachment!]!
438
326
  }
439
327
 
440
328
  type TransmissionContent {
441
- "The transmission title."
442
329
  title: ContentValue!
443
- "The transmission summary."
444
330
  summary: ContentValue
445
- "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
446
331
  contentReference: ContentValue
447
332
  }
448
333
 
@@ -618,16 +618,6 @@
618
618
  "nullable": true,
619
619
  "type": "string"
620
620
  },
621
- "fromPartyTransmissionsCount": {
622
- "description": "The number of transmissions sent by a party representative",
623
- "format": "int32",
624
- "type": "integer"
625
- },
626
- "fromServiceOwnerTransmissionsCount": {
627
- "description": "The number of transmissions sent by a service owner",
628
- "format": "int32",
629
- "type": "integer"
630
- },
631
621
  "guiActions": {
632
622
  "description": "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends.",
633
623
  "items": {
@@ -1118,6 +1108,7 @@
1118
1108
  },
1119
1109
  "isOpened": {
1120
1110
  "description": "Indicates whether the dialog transmission has been opened.",
1111
+ "nullable": true,
1121
1112
  "type": "boolean"
1122
1113
  },
1123
1114
  "relatedTransmissionId": {
@@ -1545,16 +1536,6 @@
1545
1536
  "nullable": true,
1546
1537
  "type": "string"
1547
1538
  },
1548
- "fromPartyTransmissionsCount": {
1549
- "description": "The number of transmissions sent by a party representative ",
1550
- "format": "int32",
1551
- "type": "integer"
1552
- },
1553
- "fromServiceOwnerTransmissionsCount": {
1554
- "description": "The number of transmissions sent by the service owner ",
1555
- "format": "int32",
1556
- "type": "integer"
1557
- },
1558
1539
  "guiAttachmentCount": {
1559
1540
  "description": "The number of attachments in the dialog made available for browser-based frontends.",
1560
1541
  "format": "int32",
@@ -3786,16 +3767,6 @@
3786
3767
  "nullable": true,
3787
3768
  "type": "string"
3788
3769
  },
3789
- "fromPartyTransmissionsCount": {
3790
- "description": "The number of transmissions sent by a party representative",
3791
- "format": "int32",
3792
- "type": "integer"
3793
- },
3794
- "fromServiceOwnerTransmissionsCount": {
3795
- "description": "The number of transmissions sent by the service owner",
3796
- "format": "int32",
3797
- "type": "integer"
3798
- },
3799
3770
  "guiActions": {
3800
3771
  "description": "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends.",
3801
3772
  "items": {
@@ -4350,6 +4321,7 @@
4350
4321
  },
4351
4322
  "isOpened": {
4352
4323
  "description": "Indicates whether the dialog transmission has been opened.",
4324
+ "nullable": true,
4353
4325
  "type": "boolean"
4354
4326
  },
4355
4327
  "relatedTransmissionId": {
@@ -4832,16 +4804,6 @@
4832
4804
  "nullable": true,
4833
4805
  "type": "string"
4834
4806
  },
4835
- "fromPartyTransmissionsCount": {
4836
- "description": "The number of transmissions sent by a party representative",
4837
- "format": "int32",
4838
- "type": "integer"
4839
- },
4840
- "fromServiceOwnerTransmissionsCount": {
4841
- "description": "The number of transmissions sent by a service owner",
4842
- "format": "int32",
4843
- "type": "integer"
4844
- },
4845
4807
  "guiAttachmentCount": {
4846
4808
  "description": "The number of attachments in the dialog made available for browser-based frontends.",
4847
4809
  "format": "int32",